Skip to content

Command Overview

Koupper CLI commands are organized around one flow: scaffold, run, evolve, operate, and deploy.

Core command groups

GroupCommandPurpose
Scaffoldkoupper newCreate scripts or module templates.
Executekoupper runRun Kotlin scripts through Octopus runtime.
Module evolutionkoupper moduleAdd scripts and inspect module metadata.
Background jobskoupper jobList, run, and inspect queued worker jobs.
Deploymentkoupper deployPackage and deploy script/module artifacts.
Infrastructurekoupper infraRun Terraform lifecycle commands with stable JSON output.
Reconcilekoupper reconcileOrchestrate infra, preflight, deploy, smoke, and rollback stages.
Capability discoverykoupper providerList providers and inspect contracts + env requirements.

Typical lifecycle

bash
koupper new module name="demo",version="1.0.0",package="demo.app",template="jobs"
cd demo
koupper run extensions/hello-world.kts
koupper job list
koupper deploy
koupper infra plan --dir=infra --var-file=env/dev.tfvars --json
koupper reconcile run --dir=infra --auto-approve --stages=infra,preflight,deploy,smoke --json

Tips

  • Run commands from module root when using module/job/deploy flows.
  • Use --json-file with koupper run for stable payload handling in CI shells.
  • Use koupper provider info <provider> before wiring integrations to confirm required env vars.