Skip to Content
CLICommand reference

Command reference KDV v26.3+

Use this page to choose a command and understand its result. Run ./kdv <group> <command> --help for the exact options supported by the project-pinned CLI version.

Common behavior

Commands that operate on a project manifest use kubling.yaml in the current directory by default. Pass -f or --file to select another manifest. Paths in the manifest are resolved relative to that file. requirements and list do not require a manifest.

When omitted:

  • --environment uses runtime.defaultEnvironment
  • --instance uses dev

The standard --help and --version options are available at every command level.

--quiet suppresses result documents as well as progress output. Do not use it to obtain machine-readable output. Use --format json where supported.

Project commands

CommandCommon formResult
initproject init [target]Creates a complete project from a starter
requirementsproject requirements [--format human|json]Checks Docker, Compose, daemon access and optional Make
validateproject validate [-f file] [--environment name]Validates the manifest and referenced inputs
buildproject build [-f file] [--environment name] [--release]Builds validated application configuration and bundles
testproject test [path ...] [--timeout seconds] [--format human|json]Runs isolated JavaScript tests
upproject up [--environment name] [--instance name] [--format human|json]Starts or updates a persistent instance
runproject run [--profile ci|dev] [--instance name] <service>...Runs labelled Compose test services
statusproject status [--instance name]Returns one running instance as JSON
logsproject logs [--instance name]Prints recent logs from owned containers
downproject down [--instance name]Removes an instance and its managed volumes
listproject listLists KDV-owned instances visible to the Docker daemon

Project initialization

project init [target] [--template quickstart|functions|javascript] [--name name] [--advanced] [--deployment helm] [--from source]
SelectionGenerated project
quickstart (default)Federation, providers, authentication, endpoints, scheduling and transactions
quickstart --advancedA larger Kubernetes and Redis federation environment
--template functionsSQL and template function development
--template javascriptJavaScript data-source Module development

quickstart is the default template. --advanced and --deployment helm apply to the quickstart template and may be combined. --from copies a project that already uses the current manifest and cannot be combined with template options.

Test profiles

project run defaults to the ci profile. It creates a fresh instance and attempts cleanup after the run. The dev profile uses a persistent named instance and leaves it running.

See Testing for service labels, test discovery and evidence.

Module command

bundle genmod <directory> [--output path] [--parse]

Builds a deterministic Module from a source directory. --parse validates JavaScript and static imports before publishing the output.

See Build Modules for the project and publication workflow.

Certificate commands

CommandResult
cert createCreates server and client material for transport TLS or mutual TLS
cert create-httpCreates server and client trust material for HTTP TLS

Both commands support certificate validity, output paths, generated or explicit passwords, repeatable SAN values, a SAN file and explicit overwrite.

See Certificates for output roles and examples.

Output and automation

CommandMachine-oriented result
requirements --format jsonRequirement status and overall readiness
validateCompact validation result
buildInput and bundle hashes, fingerprint and output directory
test --format jsonAggregate and per-test results
up --format jsonRuntime identity, URLs and transport endpoints
runEvidence under .kdv/reports/
statusCompact runtime description

build --release writes the deployable subset to .kdv/release/<environment>/. build writes progress before its result and does not currently provide a JSON-only mode. logs, down and list are intended for direct command or exit-status handling.

Exit status

CodeMeaning
0Command completed successfully, including empty discovery or an idempotent teardown
1Validation, requirement, execution or test failure
2Invalid command-line syntax or option
Last updated on