CLI Reference

All commands, flags, and expected output for traverse-cli.

v0.7.0 traverse-cli

Installation

Build the CLI from the workspace. No separate install step needed.

build
$ cargo build -p traverse-cli
Compiling traverse-cli v0.7.0
Finished dev [unoptimized + debuginfo] target(s)

The binary is at target/debug/traverse-cli after building. Use cargo run -p traverse-cli -- during development to build and run in one step.

Global flags

These flags work with any command.

FlagDescription
--help Print help text for any command. Works at the top level and on each subcommand.
--version Print the CLI version and exit.
examples
$ traverse-cli --version
traverse-cli 0.7.0
$ traverse-cli --help
Traverse CLI — contract-driven WASM runtime
Usage: traverse-cli [COMMAND]
Commands:
bundle Inspect and manage capability bundles
browser-adapter Run the local browser adapter server

bundle inspect <path>

Inspect a registry bundle. Prints the bundle name, version, and all capabilities found in the manifest. Validates the manifest format without executing anything.

traverse-cli bundle inspect <PATH>
Argument / FlagTypeDescription
<PATH> path Path to the bundle directory. Must contain a manifest.json.
--verbose flag Print full contract details for each capability.
example
$ cargo run -p traverse-cli -- bundle inspect ./bundles/expedition
Bundle: expedition
Version: 1.0.0
Capabilities: 1
plan-expedition
version: 1.0.0
target: local
binary: plan_expedition.wasm
inputs: goal (string), team_size (integer), duration_days (integer)
outputs: plan (string), equipment_list (array)
emits: expedition.planned

browser-adapter serve

Start the local browser adapter. This is an HTTP server that sits between your React app and the Traverse runtime. It exposes a /execute endpoint and a /health endpoint. The adapter loads the specified bundle at startup.

traverse-cli browser-adapter serve --bind <ADDR> [--bundle <PATH>]
FlagTypeDefaultDescription
--bind string 127.0.0.1:4174 Address and port to listen on.
--bundle path default bundle Path to the bundle directory to load at startup.
example
$ cargo run -p traverse-cli -- browser-adapter serve \
--bind 127.0.0.1:4174 \
--bundle ./bundles/expedition
Loading bundle: ./bundles/expedition
plan-expedition v1.0.0 ... ok
Registry ready. 1 capability loaded.
Adapter listening on 127.0.0.1:4174

The adapter runs until you stop it with Ctrl-C. It does not hot-reload bundles. Restart after any bundle changes.

register <bundle> not yet available

Register a bundle with a remote registry. This command will push the bundle manifest and WASM binaries to a registry endpoint and index all capabilities for remote discovery.

traverse-cli register <BUNDLE_PATH> --registry <URL>

Planned for a future release. Track progress on GitHub.

list not yet available

List all capabilities registered with a remote registry. Will output capability IDs, versions, and available targets in a table.

traverse-cli list [--registry <URL>] [--json]

Planned for a future release.

validate <contract> not yet available

Validate a single contract file against the Traverse contract schema. Will report any missing required fields, type mismatches, or invalid constraint declarations.

traverse-cli validate <CONTRACT_PATH>

Planned for a future release.

run <capability-id> not yet available

Execute a capability directly from the CLI. Will load the bundle, run the capability with the provided inputs, and print the trace artifact to stdout.

traverse-cli run <CAPABILITY_ID> --bundle <PATH> --input <JSON>

Planned for a future release.