Command Overview
Koupper CLI commands are organized around one flow: scaffold, run, evolve, operate, and deploy.
Core command groups
| Group | Command | Purpose |
|---|---|---|
| Scaffold | koupper new | Create scripts or module templates. |
| Execute | koupper run | Run Kotlin scripts through Octopus runtime. |
| Module evolution | koupper module | Add scripts and inspect module metadata. |
| Background jobs | koupper job | List, run, and inspect queued worker jobs. |
| Deployment | koupper deploy | Package and deploy script/module artifacts. |
| Infrastructure | koupper infra | Run Terraform lifecycle commands with stable JSON output. |
| Reconcile | koupper reconcile | Orchestrate infra, preflight, deploy, smoke, and rollback stages. |
| Capability discovery | koupper provider | List providers and inspect contracts + env requirements. |
| Hot Reloading | koupper reload | Vacía y recarga los plugins/providers en vivo sin apagar el demonio. |
| Build | koupper build | Run the module's init.kts build script. |
| Project watcher | koupper watch | Auto-detect providers and sync Gradle dependencies. |
Agent runtime commands
| Command | Purpose |
|---|---|
koupper agent | Manage installed agents: list, info, install, remove. |
koupper worker | Background job worker daemon — polls queues, executes agent scripts. |
koupper worker --status | Print queue snapshot (pending/processing/failed/dead) and exit. |
koupper schedule | Manage recurring agent schedules (cron, rate, once). |
koupper doctor | Diagnose the runtime: env vars, ports, queues, agents, schedules. |
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 --jsonTips
- Run commands from module root when using module/job/deploy flows.
- Use
--json-filewithkoupper runfor stable payload handling in CI shells. - Use
koupper provider info <provider>before wiring integrations to confirm required env vars.