Skip to content

CLI: Agents

Generated from deedglass help --json (CLI 0.1.0-dev). Global flags and exit codes are on the CLI reference page.

Register an agent.

Terminal window
deedglass agent create <name> [--description …] [--label env=prod]... [--calls-per-minute n] [--calls-per-day n] [--spend-per-day minor --currency usd] [--owner usr_…] [--json]
Flag Type Default What it does
--calls-per-day int 0 budget: calls per day
--calls-per-minute int 0 budget: calls per minute (S11 enforces it)
--currency string usd the spend budget’s ISO 4217 currency, lowercase
--description string what the agent does, up to 500 characters
--label string a label key=value (repeatable): env=prod
--owner string the person responsible (usr_…)
--spend-per-day int 0 budget: spend per day in minor units (5000 = $50.00), with –currency

Add --json for machine-readable output.

List agents.

Terminal window
deedglass agent list [--status active|suspended|stopped] [--label env:prod] [--json]
Flag Type Default What it does
--label string only agents with this label, key:value (env:prod)
--status string active, suspended or stopped

Add --json for machine-readable output.

Show one agent.

Terminal window
deedglass agent show <name|agt_…> [--json]

Add --json for machine-readable output.

Suspend an agent.

Terminal window
deedglass agent suspend <name|agt_…> [--reason …] [--json]
Flag Type Default What it does
--reason string why; it goes into the record (required for start)

Add --json for machine-readable output.

Resume a suspended agent.

Terminal window
deedglass agent resume <name|agt_…> [--reason …] [--json]
Flag Type Default What it does
--reason string why; it goes into the record (required for start)

Add --json for machine-readable output.

Stop an agent now.

Terminal window
deedglass agent stop <name|agt_…> [--reason …] [--json]
Flag Type Default What it does
--reason string why; it goes into the record (required for start)

Add --json for machine-readable output.

Start a stopped agent.

Terminal window
deedglass agent start <name|agt_…> --reason "why it's safe now" [--json]
Flag Type Default What it does
--reason string why; it goes into the record (required for start)

Add --json for machine-readable output.

Create an API key for an agent.

Terminal window
deedglass agent keys create <name|agt_…> [--name "prod runner"] [--mode live|test] [--scope …]... [--json]
Flag Type Default What it does
--mode string live live or test (test keys are recorded as livemode false)
--name string a name for the key, like prod runner
--scope string a scope (repeatable); default actions:execute, actions:read, deeds:read

Add --json for machine-readable output.

List an agent’s API keys.

Terminal window
deedglass agent keys list <name|agt_…> [--json]

Add --json for machine-readable output.

Replace an API key, with an overlap.

Terminal window
deedglass agent keys roll <key_…> [--overlap 24h] [--json]
Flag Type Default What it does
--overlap duration 24h0m0s how long the old key keeps working: 0s to 168h

Add --json for machine-readable output.

Revoke an API key.

Terminal window
deedglass agent keys revoke <key_…> [--reason …] [--json]
Flag Type Default What it does
--reason string why; it goes into the record (required for start)

Add --json for machine-readable output.

Generate a signed-intent key pair.

Terminal window
deedglass agent intent keygen <name> [--dir .deedglass/intent] [--force] [--json]
Flag Type Default What it does
--dir string .deedglass/intent where to write .pem (created with mode 0700)
--force bool replace an existing key file

Add --json for machine-readable output.

Register an intent public key.

Terminal window
deedglass agent intent add <name|agt_…> --public-key ed25519:… [--json]
Flag Type Default What it does
--public-key string the public key keygen printed, “ed25519:…”

Add --json for machine-readable output.

List an agent’s intent keys.

Terminal window
deedglass agent intent list <name|agt_…> [--json]

Add --json for machine-readable output.

Remove an intent key.

Terminal window
deedglass agent intent remove <name|agt_…> <kid> [--json]

Add --json for machine-readable output.

Require, allow or ignore signed intents.

Terminal window
deedglass agent intent mode <name|agt_…> off|optional|required [--json]

Add --json for machine-readable output.

Create an org and its owner.

Terminal window
deedglass org create --name "Acme" --owner-email priya@acme.com [--slug acme] [--print-link] [--admin-key] [--json]
Flag Type Default What it does
--admin-key bool also create an org admin key and print it once (S08)
--name string the org’s name, as people see it (required)
--owner-email string the first owner’s email address (required)
--print-link bool prod: print the owner’s sign-in link instead of emailing it
--slug string the org’s short name in URLs (default: from the name)

Add --json for machine-readable output.

Print a one-time sign-in link.

Terminal window
deedglass org login-link --email sam@acme.com [--org acme] [--json]
Flag Type Default What it does
--email string the member’s email address (required); –org picks the org

Add --json for machine-readable output.

Create an org admin key.

Terminal window
deedglass org keys create [--org acme] [--name ci] [--mode live|test] [--json]
Flag Type Default What it does
--mode string live live or test
--name string a name for the key, like ci

Add --json for machine-readable output.

List org admin keys.

Terminal window
deedglass org keys list [--org acme] [--json]

Add --json for machine-readable output.

Revoke an org admin key.

Terminal window
deedglass org keys revoke <key_…> [--org acme] [--reason …] [--json]
Flag Type Default What it does
--reason string why; it goes into the record (required for start)

Add --json for machine-readable output.

Stop every agent in the org.

Terminal window
deedglass org stop-all [--reason …] [--yes] [--json]
Flag Type Default What it does
--reason string why; it goes into the record
--yes bool skip the typed confirmation (scripts)

Add --json for machine-readable output.

Start every agent not stopped one by one.

Terminal window
deedglass org start-all [--org acme] --reason "why it's safe now" [--json]
Flag Type Default What it does
--reason string why; it goes into the record (required for start)

Add --json for machine-readable output.