Reference
CLI commands
Help from the same CLI shipped with this source.
Source reference · cd46e0e78d73Read Markdown
Usage: berry <command> [arguments]
auth login --email <email> [--code <code|->] Send an email code, then sign in or register
auth login [--no-browser] Sign in through your browser
auth status | auth logout Inspect or end this CLI account session
runtime list [--after <id>] List account runtimes
workspace list List your workspaces
workspace use <id-or-name> Select a workspace and clear runtime selection
runtime create <name> [--id <uuid>] Request a hosted runtime
runtime use <id-or-name> Save the runtime for subsequent commands
runtime view [id-or-name] Inspect requested and observed state
runtime start [id-or-name] | runtime stop [id-or-name]
runtime start --local [--foreground] Start locally (background by default)
runtime stop --local | runtime view --local | runtime list --local
runtime rename <id-or-name> <name> | runtime delete <id-or-name> --yes
key list [--after <id>]
key create <name> --out <file> [--id <uuid>] [--expires-at <ISO>]
key revoke <id> Revoke one integration key
api [method-id] [--params <JSON>] [--query <JSON>] [--input <JSON>]
init <new-directory> Create a runnable starter agent
guide <native|examples|models|applications|patterns>
build <plugin.json> <bundle> Compile native content locally
build-assembly <assembly.yaml> <bundle> Compile runtime configuration locally
pack <file-or-https-url> <bundle> Capture content into a portable package
restore <archive> <empty-state> Restore offline into empty storage
checkpoint <state> <workspace> <archive> Capture a stopped runtime and workspace
restore-checkpoint <archive> <directory> Restore into an absent directory
secrets Inspect runtime secrets and store revisions
secret-write Send a Secrets mutation privately from stdin
info | agents | targets | preparations | installations | unresolved
catalog [path] [--search <text>] [--id <id>] [--plugin <id>] [--details]
[--interface <name>] [--operation <name>] [--family <name>] [--kind <tool|step>] [--category <name>]
[--limit <n>] [--after <cursor>] Discover current runtime metadata
sessions [--agent <id>] [--preparation <root>] [--status <state>] [--search <text>] [--after <cursor>] [--limit <n>] [--reverse true]
deployment history <id> [--from <cursor>] [--limit <n>]
deployment restore <id> <revision> [--expected-version <n>] [--dry-run]
deployment remove <id> --yes [--expected-version <n>] [--dry-run]
admit <file-or-https-url> Retain content without execution
deploy [directory|plugin.json|bundle] [--id <id>] [--permissions <JSON>]
[--connections <JSON>] [--expected-version <n>] [--dry-run]
prepare <root> --permissions <JSON> Bind exact resources and grants
invoke <prepared-root> <export> --request-id <id> [--input <JSON>]
run <agent> [--request-id <id>] [--input <JSON>] [--wait] [--timeout <ms>]
thread <thread> | interrupt <thread> | close <thread>
message <thread> --request-id <id> --input <JSON>
inspect <execution> | calls <execution> | wait <execution> [--timeout <ms>]
read <port> [--after <cursor>] | send <port> --request-id <id> --input <JSON>
resource <name> [--input <JSON>] Observe or operate a host resource
value <address>
reconcile <call> <reason> Record an explicit owner decision
export <file> [root] [--max-bytes <n>] [--max-values <n>]
Use --local with deploy, run and other runtime commands to use your local runtime.
It starts automatically in the background. runtime stop --local stops it and
retains its agents and sessions. BERRY_RUNTIME_CONFIG selects its assembly file.
For Cloud, sign in, then select a runtime with runtime use. --runtime overrides that selection.
For CI or direct access, use BERRY_RUNTIME_URL and BERRY_SERVER_TOKEN (or --url).
Account commands accept --cloud-url (or BERRY_CLOUD_URL). BERRY_CONFIG_DIR isolates
CLI credentials and runtime selection. BERRY_RUNTIME_ID overrides the saved
runtime. Credentials use Berry's private vault.
Email sign-in creates an account when needed. Send the code with --code - on stdin
to keep it out of process arguments. No browser or integration key is required.
key create writes its one-time secret only to a new private file; default expiry
is 30 days. Retain printed creation IDs to reconcile an uncertain response.
api lists the Cloud control catalog or invokes a published method by ID.
build discovers Tool contracts from that runtime when connected, or from
--catalog @targets.json offline (the output of targets). No work is started.
pack/admit accept --format bundle|skill|agent-plugin, --package <JSON>,
and --integrity sha256:<hex>. Skill releases require package name and version.
JSON arguments may be @file or - for stdin. Successful output is JSON (except guide).
catalog without a path returns the runtime summary. Paths: operations, agents,
installations, packages and resources. Filter models with --operation generation
or their exact interface; --details includes model parameters and operation schemas. Lists return next
for --after with the same filters; --details includes exact Tool schemas.
Discovery grants no access and never invokes the listed tools.
deploy builds source, preserves existing grants unless explicitly replaced, and
selects through package review. --dry-run prepares and reviews without selection.
invoke and run return a durable session receipt
immediately. interrupt stops a thread's current turn; close ends the thread, and
closing a session's primary thread ends the session.
Reuse request IDs after lost acknowledgements; generated IDs are printed before
submission. Waiting never cancels runtime work. Exit 1 means error/failed execution;
exit 124 means the wait expired. A session waiting for input is a successful wait.