modulectl

Overview

modulectl is a command line tool that supports developers of Kyma modules. It provides a set of commands and flags to:

• Create an empty scaffold for a new module
• Build a module and push it to a remote repository

Installation

1. Download the binary for your operating system and architecture from the GitHub releases page.
2. Move the binary to a directory in your PATH or navigate to the directory where the binary is located.
3. Make the binary executable by running chmod +x modulectl.

Alternative

You can build the binary from the source code.

Clone the repository and run make build from the root directory of the repository.

The binary is created in the bin directory.

Note

You can use Makefile targets for MacOS (darwin) or Linux, with the option to compile for x86 or ARM architectures, to build the binary for your specific operating system and architecture.

Usage

modulectl <command> [flags]

Available Commands

• create - Creates a module bundled as an OCI artifact. See modulectl create.
• scaffold - Generates necessary files required for module creation. See modulectl scaffold
• help - Provides help with any command.
• version - Prints the current version of the modulectl tool. See modulectl version.
• completion - Generates the autocompletion script for the specified shell.

For detailed information about the commands, you can use the -h or --help flag with the command. For example: modulectl create -h.

Development

Before you start developing, create a local test setup. For more information, see Configure and Run a Local Test Setup.

Contributing

See the Contributing Rules.

Code of Conduct

See the Code of Conduct document.

Licensing

See the license file.