Skip to main content
Version: Next

Run

This command runs the kcl code and displays the output. 'kcl run' takes multiple input for arguments.

Args

This command runs the kcl code and displays the output. 'kcl run' takes multiple input for arguments.

For example, 'kcl run path/to/kcl.k' will run the file named path/to/kcl.k

Usage:
kcl run [flags]

Aliases:
run, r

Examples:
# Run a single file and output YAML
kcl run path/to/kcl.k

# Run a single file and output JSON
kcl run path/to/kcl.k --format json

# Run a single file and output TOML
kcl run path/to/kcl.k --format toml

# Run multiple files
kcl run path/to/kcl1.k path/to/kcl2.k

# Run OCI packages
kcl run oci://ghcr.io/kcl-lang/helloworld

# Run remote Git repo
kcl run https://github.com/kcl-lang/flask-demo-kcl-manifests

# Run the current package
kcl run

Flags:
-D, --argument stringArray Specify the top-level argument
-d, --debug Run in debug mode
-n, --disable_none Disable dumping None values
-E, --external strings Specify the mapping of package name and path where the package is located
--format string Specify the output format (default "yaml")
-h, --help help for run
--no_style Set to prohibit output of command line waiting styles, including colors, etc.
-o, --output string Specify the YAML/JSON output file path
-O, --overrides strings Specify the configuration override path and value
-S, --path_selector strings Specify the path selectors
-q, --quiet Set the quiet mode (no output)
-Y, --setting strings Specify the command line setting files
-H, --show_hidden Display hidden attributes
-k, --sort_keys Sort output result keys
-r, --strict_range_check Do perform strict numeric range checks
-t, --tag string Specify the tag for the OCI or Git artifact
-V, --vendor Run in vendor mode