Kneo Serv CLI Reference¶
Generated by python docs/script/generate_reference_docs.py.
kneo¶
Usage: kneo [OPTIONS] COMMAND [ARGS]...
Kneo Agent Platform CLI
Options
--install-completion Install completion for the current shell.
--show-completion Show completion for the current shell, to copy
it or customize the installation.
--help Show this message and exit.
Commands
config Manage project config
spec Validate and compile specs
run Run agent/workflow specs
runs Inspect runs
human Manage human-in-the-loop tasks
service Run or manage the Kneo service
kneo config¶
Usage: kneo config [OPTIONS] COMMAND [ARGS]...
Manage project config
Options
--help Show this message and exit.
Commands
show Show project config.
init Create a .kneo/config.yaml project config.
resolve Resolve project context, including environment and overlays.
secrets Show configured secret references without exposing values.
render-spec Render default spec plus environment overlays into one YAML
file.
profile Manage service connection profiles
kneo config show¶
Usage: kneo config show [OPTIONS]
Show project config.
Options
--json
--help Show this message and exit.
kneo config init¶
Usage: kneo config init [OPTIONS]
Create a .kneo/config.yaml project config.
Options
--name TEXT [default: kneo-serv-project]
--force
--help Show this message and exit.
kneo config resolve¶
Usage: kneo config resolve [OPTIONS]
Resolve project context, including environment and overlays.
Options
--env TEXT
--spec PATH
--json
--help Show this message and exit.
kneo config secrets¶
Usage: kneo config secrets [OPTIONS]
Show configured secret references without exposing values.
Options
--env TEXT
--json
--help Show this message and exit.
kneo config render-spec¶
Usage: kneo config render-spec [OPTIONS]
Render default spec plus environment overlays into one YAML file.
Options
* --output -o PATH [required]
--env TEXT
--spec PATH
--help Show this message and exit.
kneo config profile¶
Usage: kneo config profile [OPTIONS] COMMAND [ARGS]...
Manage service connection profiles
Options
--help Show this message and exit.
Commands
set Create or update a named service profile.
use Set the active service profile.
list List configured service profiles without exposing API keys.
show Show one service profile without exposing its API key.
delete Delete a service profile.
kneo config profile set¶
Usage: kneo config profile set [OPTIONS] NAME
Create or update a named service profile.
Arguments
* name TEXT [required]
Options
* --service-url TEXT [required]
--api-key TEXT
--activate --no-activate [default: activate]
--json
--help Show this message and exit.
kneo config profile use¶
Usage: kneo config profile use [OPTIONS] NAME
Set the active service profile.
Arguments
* name TEXT [required]
Options
--json
--help Show this message and exit.
kneo config profile list¶
Usage: kneo config profile list [OPTIONS]
List configured service profiles without exposing API keys.
Options
--json
--help Show this message and exit.
kneo config profile show¶
Usage: kneo config profile show [OPTIONS]
Show one service profile without exposing its API key.
Options
--name TEXT
--json
--help Show this message and exit.
kneo config profile delete¶
Usage: kneo config profile delete [OPTIONS] NAME
Delete a service profile.
Arguments
* name TEXT [required]
Options
--help Show this message and exit.
kneo spec¶
Usage: kneo spec [OPTIONS] COMMAND [ARGS]...
Validate and compile specs
Options
--help Show this message and exit.
Commands
validate
lint Surface validator warnings and errors. Exits 1 if any are
found.
compile
resolve
migrate Migrate an older YAML spec to the current v1 shape.
policy-report Generate a policy evaluation report for a spec.
bundle Sign and verify approved spec bundles
kneo spec validate¶
Usage: kneo spec validate [OPTIONS] [SPEC_PATH]
Arguments
spec_path [SPEC_PATH]
Options
--env TEXT
--json
--service-url TEXT
--profile TEXT Service profile name
--help Show this message and exit.
kneo spec compile¶
Usage: kneo spec compile [OPTIONS] [SPEC_PATH]
Arguments
spec_path [SPEC_PATH]
Options
--env TEXT
--json
--service-url TEXT
--profile TEXT Service profile name
--help Show this message and exit.
kneo spec resolve¶
Usage: kneo spec resolve [OPTIONS] [SPEC_PATH]
Arguments
spec_path [SPEC_PATH]
Options
* --output -o PATH [required]
--env TEXT
--help Show this message and exit.
kneo spec migrate¶
Usage: kneo spec migrate [OPTIONS] SPEC_PATH
Migrate an older YAML spec to the current v1 shape.
Arguments
* spec_path PATH [required]
Options
--output -o PATH
--check
--json
--help Show this message and exit.
kneo spec policy-report¶
Usage: kneo spec policy-report [OPTIONS] [SPEC_PATH]
Generate a policy evaluation report for a spec.
Arguments
spec_path [SPEC_PATH]
Options
--env TEXT
--json
--service-url TEXT
--profile TEXT Service profile name
--help Show this message and exit.
kneo spec bundle¶
Usage: kneo spec bundle [OPTIONS] COMMAND [ARGS]...
Sign and verify approved spec bundles
Options
--help Show this message and exit.
Commands
sign Create an approved, signed spec bundle.
verify Verify an approved spec bundle digest and signature.
kneo spec bundle sign¶
Usage: kneo spec bundle sign [OPTIONS] SPEC_PATH
Create an approved, signed spec bundle.
Arguments
* spec_path PATH [required]
Options
* --output -o PATH [required]
* --approved-by TEXT [required]
--env TEXT
--key-env TEXT [default: KNEO_SERV_SPEC_SIGNING_KEY]
--json
--help Show this message and exit.
kneo spec bundle verify¶
Usage: kneo spec bundle verify [OPTIONS] BUNDLE_PATH
Verify an approved spec bundle digest and signature.
Arguments
* bundle_path PATH [required]
Options
--key-env TEXT [default: KNEO_SERV_SPEC_SIGNING_KEY]
--json
--help Show this message and exit.
kneo run¶
Usage: kneo run [OPTIONS] [SPEC_PATH] COMMAND [ARGS]...
Run agent/workflow specs
Arguments
spec_path [SPEC_PATH] Path to Kneo YAML spec
Options
* --input -i TEXT Input text [required]
--target TEXT agent or workflow [default: workflow]
--env TEXT
--json
--service-url TEXT
--profile TEXT Service profile name
--help Show this message and exit.
kneo runs¶
Usage: kneo runs [OPTIONS] COMMAND [ARGS]...
Inspect runs
Options
--help Show this message and exit.
Commands
get
trace
checkpoints
replay
checkpoint-diff
cancel
kneo runs get¶
Usage: kneo runs get [OPTIONS] RUN_ID
Arguments
* run_id TEXT [required]
Options
--json
--service-url TEXT
--profile TEXT Service profile name
--help Show this message and exit.
kneo runs trace¶
Usage: kneo runs trace [OPTIONS] RUN_ID
Arguments
* run_id TEXT [required]
Options
--json
--service-url TEXT
--profile TEXT Service profile name
--help Show this message and exit.
kneo runs checkpoints¶
Usage: kneo runs checkpoints [OPTIONS] RUN_ID
Arguments
* run_id TEXT [required]
Options
--json
--service-url TEXT
--profile TEXT Service profile name
--help Show this message and exit.
kneo runs replay¶
Usage: kneo runs replay [OPTIONS] RUN_ID
Arguments
* run_id TEXT [required]
Options
--json
--service-url TEXT
--profile TEXT Service profile name
--help Show this message and exit.
kneo runs checkpoint-diff¶
Usage: kneo runs checkpoint-diff [OPTIONS] RUN_ID
Arguments
* run_id TEXT [required]
Options
--from-sequence INTEGER
--to-sequence INTEGER
--json
--service-url TEXT
--profile TEXT Service profile name
--help Show this message and exit.
kneo runs cancel¶
Usage: kneo runs cancel [OPTIONS] RUN_ID
Arguments
* run_id TEXT [required]
Options
--json
--service-url TEXT
--profile TEXT Service profile name
--help Show this message and exit.
kneo human¶
Usage: kneo human [OPTIONS] COMMAND [ARGS]...
Manage human-in-the-loop tasks
Options
--help Show this message and exit.
Commands
get
list
resume
kneo human get¶
Usage: kneo human get [OPTIONS] CONTINUATION_ID
Arguments
* continuation_id TEXT [required]
Options
--json
--service-url TEXT
--profile TEXT Service profile name
--help Show this message and exit.
kneo human list¶
Usage: kneo human list [OPTIONS]
Options
--json
--service-url TEXT
--profile TEXT Service profile name
--help Show this message and exit.
kneo human resume¶
Usage: kneo human resume [OPTIONS] CONTINUATION_ID
Arguments
* continuation_id TEXT [required]
Options
* --request-id TEXT [required]
--approve
--reject
--edit TEXT
--provide TEXT
--select TEXT
--json
--service-url TEXT
--profile TEXT Service profile name
--help Show this message and exit.
kneo service¶
Usage: kneo service [OPTIONS] COMMAND [ARGS]...
Run or manage the Kneo service
Options
--help Show this message and exit.
Commands
serve Run the Kneo FastAPI service.