Skip to content

CLI.md

Latest commit

 

History

History
1247 lines (942 loc) · 35.6 KB

CLI.md

File metadata and controls

1247 lines (942 loc) · 35.6 KB
Raw

CLI reference

Generated from the Rust CLI by cargo xtask generate. Do not edit by hand.

agentctl

Deterministic, declarative control plane for policy-constrained agentic automation

Usage: agentctl [OPTIONS] <COMMAND>

Commands:
  check       Validate syntax, schema, references, capabilities, policy, and templates
  plan        Print the deterministic compiled plan
  run         Execute a workflow, or predict it with --check
  resume      Continue an interrupted or approval-paused run
  replay      Reconstruct a terminal run only from recorded state and results
  fork        Create a new run from a prior workflow with fresh effects
  repair      Create a new run that reuses compatible upstream results and executes a repaired suffix
  retry       Retry failed or selected boundaries of an identical terminal workflow
  compensate  Execute explicitly declared best-effort compensation for a terminal run
  runs        Analyze or upgrade retained legacy run records for selective reuse
  cancel      Durably request cancellation
  inspect     Inspect durable run, task, and audit state
  effects     Inspect or narrowly reconcile uncertain effects
  approvals   List or resolve durable approval requests
  providers   Inspect provider capabilities or run the opt-in OpenAI smoke
  auth        Check configured secret references without revealing values
  schema      Print or write the generated workflow JSON Schema
  migrate     Translate an unversioned TypeScript-era workflow into workflow API v1
  packs       Inspect and verify a local reusable pack
  artifacts   Inspect, verify, export, or collect durable artifacts
  db          Inspect the runtime database
  memory      Read or write namespaced long-term memory
  gc          Garbage-collect expired memory and old terminal runs
  completion  Generate completion for a supported shell
  version     Print the exact build version
  update      Explain safe update options without modifying the installation

Options:
      --output <OUTPUT>  [default: human] [possible values: human, json, jsonl]
      --color <COLOR>    [default: auto] [possible values: auto, always, never]
      --verbose
      --offline          Forbid pack network access and require cached Git/archive sources
      --locked           Require agentctl.pack.lock and reject all source or graph drift
  -h, --help             Print help
  -V, --version          Print version

agentctl check

Validate syntax, schema, references, capabilities, policy, and templates

Usage: agentctl check [OPTIONS] <FILE>

Arguments:
  <FILE>

Options:
      --output <OUTPUT>  [default: human] [possible values: human, json, jsonl]
      --color <COLOR>    [default: auto] [possible values: auto, always, never]
      --verbose
      --offline          Forbid pack network access and require cached Git/archive sources
      --locked           Require agentctl.pack.lock and reject all source or graph drift
  -h, --help             Print help

agentctl plan

Print the deterministic compiled plan

Usage: agentctl plan [OPTIONS] <FILE>

Arguments:
  <FILE>

Options:
      --output <OUTPUT>  [default: human] [possible values: human, json, jsonl]
      --color <COLOR>    [default: auto] [possible values: auto, always, never]
      --verbose
      --offline          Forbid pack network access and require cached Git/archive sources
      --locked           Require agentctl.pack.lock and reject all source or graph drift
  -h, --help             Print help

agentctl run

Execute a workflow, or predict it with --check

Usage: agentctl run [OPTIONS] <FILE>

Arguments:
  <FILE>

Options:
      --db <DB>
          [default: .agentctl/runtime.db]
      --output <OUTPUT>
          [default: human] [possible values: human, json, jsonl]
      --color <COLOR>
          [default: auto] [possible values: auto, always, never]
      --inputs <INPUTS>

      --inputs-file <INPUTS_FILE>

      --verbose

      --input <KEY=VALUE>

      --offline
          Forbid pack network access and require cached Git/archive sources
      --locked
          Require agentctl.pack.lock and reject all source or graph drift
      --workspace <WORKSPACE>

      --timeout-seconds <TIMEOUT_SECONDS>

      --check

      --diff

      --interactive

  -h, --help
          Print help

agentctl resume

Continue an interrupted or approval-paused run

Usage: agentctl resume [OPTIONS] <RUN_ID>

Arguments:
  <RUN_ID>

Options:
      --db <DB>
          [default: .agentctl/runtime.db]
      --output <OUTPUT>
          [default: human] [possible values: human, json, jsonl]
      --color <COLOR>
          [default: auto] [possible values: auto, always, never]
      --diff

      --interactive

      --verbose

      --offline
          Forbid pack network access and require cached Git/archive sources
      --workspace <WORKSPACE>

      --locked
          Require agentctl.pack.lock and reject all source or graph drift
      --timeout-seconds <TIMEOUT_SECONDS>

  -h, --help
          Print help

agentctl replay

Reconstruct a terminal run only from recorded state and results

Usage: agentctl replay [OPTIONS] <RUN_ID>

Arguments:
  <RUN_ID>

Options:
      --db <DB>          [default: .agentctl/runtime.db]
      --output <OUTPUT>  [default: human] [possible values: human, json, jsonl]
      --color <COLOR>    [default: auto] [possible values: auto, always, never]
      --verbose
      --offline          Forbid pack network access and require cached Git/archive sources
      --locked           Require agentctl.pack.lock and reject all source or graph drift
  -h, --help             Print help

agentctl fork

Create a new run from a prior workflow with fresh effects

Usage: agentctl fork [OPTIONS] <RUN_ID>

Arguments:
  <RUN_ID>

Options:
      --db <DB>
          [default: .agentctl/runtime.db]
      --output <OUTPUT>
          [default: human] [possible values: human, json, jsonl]
      --color <COLOR>
          [default: auto] [possible values: auto, always, never]
      --interactive

      --diff

      --verbose

      --offline
          Forbid pack network access and require cached Git/archive sources
      --workspace <WORKSPACE>

      --locked
          Require agentctl.pack.lock and reject all source or graph drift
      --timeout-seconds <TIMEOUT_SECONDS>

  -h, --help
          Print help

agentctl repair

Create a new run that reuses compatible upstream results and executes a repaired suffix

Usage: agentctl repair [OPTIONS] --from <FROM> <FILE> <SOURCE_RUN_ID>

Arguments:
  <FILE>
  <SOURCE_RUN_ID>

Options:
      --from <FROM>

      --output <OUTPUT>
          [default: human] [possible values: human, json, jsonl]
      --color <COLOR>
          [default: auto] [possible values: auto, always, never]
      --plan

      --restart-successful

      --verbose

      --offline
          Forbid pack network access and require cached Git/archive sources
      --reason <REASON>

      --db <DB>
          [default: .agentctl/runtime.db]
      --locked
          Require agentctl.pack.lock and reject all source or graph drift
      --interactive

      --diff

      --workspace <WORKSPACE>

      --timeout-seconds <TIMEOUT_SECONDS>

  -h, --help
          Print help

agentctl retry

Retry failed or selected boundaries of an identical terminal workflow

Usage: agentctl retry [OPTIONS] <FILE> <SOURCE_RUN_ID>

Arguments:
  <FILE>
  <SOURCE_RUN_ID>

Options:
      --failed

      --output <OUTPUT>
          [default: human] [possible values: human, json, jsonl]
      --color <COLOR>
          [default: auto] [possible values: auto, always, never]
      --from <FROM>

      --plan

      --verbose

      --offline
          Forbid pack network access and require cached Git/archive sources
      --restart-successful

      --locked
          Require agentctl.pack.lock and reject all source or graph drift
      --reason <REASON>

      --db <DB>
          [default: .agentctl/runtime.db]
      --interactive

      --diff

      --workspace <WORKSPACE>

      --timeout-seconds <TIMEOUT_SECONDS>

  -h, --help
          Print help

agentctl compensate

Execute explicitly declared best-effort compensation for a terminal run

Usage: agentctl compensate [OPTIONS] <SOURCE_RUN_ID>

Arguments:
  <SOURCE_RUN_ID>

Options:
      --output <OUTPUT>
          [default: human] [possible values: human, json, jsonl]
      --task <TASK>

      --color <COLOR>
          [default: auto] [possible values: auto, always, never]
      --plan

      --db <DB>
          [default: .agentctl/runtime.db]
      --verbose

      --interactive

      --offline
          Forbid pack network access and require cached Git/archive sources
      --diff

      --locked
          Require agentctl.pack.lock and reject all source or graph drift
      --workspace <WORKSPACE>

      --timeout-seconds <TIMEOUT_SECONDS>

  -h, --help
          Print help

agentctl runs

Analyze or upgrade retained legacy run records for selective reuse

Usage: agentctl runs [OPTIONS] <COMMAND>

Commands:
  analyze  Prove reusable legacy metadata without changing the source run
  upgrade  Transactionally persist every legacy field that can be proven

Options:
      --db <DB>          [default: .agentctl/runtime.db]
      --output <OUTPUT>  [default: human] [possible values: human, json, jsonl]
      --color <COLOR>    [default: auto] [possible values: auto, always, never]
      --verbose
      --offline          Forbid pack network access and require cached Git/archive sources
      --locked           Require agentctl.pack.lock and reject all source or graph drift
  -h, --help             Print help

agentctl runs analyze

Prove reusable legacy metadata without changing the source run

Usage: agentctl runs analyze [OPTIONS] <RUN_ID>

Arguments:
  <RUN_ID>

Options:
      --output <OUTPUT>  [default: human] [possible values: human, json, jsonl]
      --color <COLOR>    [default: auto] [possible values: auto, always, never]
      --verbose
      --offline          Forbid pack network access and require cached Git/archive sources
      --locked           Require agentctl.pack.lock and reject all source or graph drift
  -h, --help             Print help

agentctl runs upgrade

Transactionally persist every legacy field that can be proven

Usage: agentctl runs upgrade [OPTIONS] <RUN_ID>

Arguments:
  <RUN_ID>

Options:
      --dry-run
      --output <OUTPUT>  [default: human] [possible values: human, json, jsonl]
      --color <COLOR>    [default: auto] [possible values: auto, always, never]
      --verbose
      --offline          Forbid pack network access and require cached Git/archive sources
      --locked           Require agentctl.pack.lock and reject all source or graph drift
  -h, --help             Print help

agentctl cancel

Durably request cancellation

Usage: agentctl cancel [OPTIONS] <RUN_ID>

Arguments:
  <RUN_ID>

Options:
      --db <DB>          [default: .agentctl/runtime.db]
      --output <OUTPUT>  [default: human] [possible values: human, json, jsonl]
      --color <COLOR>    [default: auto] [possible values: auto, always, never]
      --verbose
      --offline          Forbid pack network access and require cached Git/archive sources
      --locked           Require agentctl.pack.lock and reject all source or graph drift
  -h, --help             Print help

agentctl inspect

Inspect durable run, task, and audit state

Usage: agentctl inspect [OPTIONS] <RUN_ID>

Arguments:
  <RUN_ID>

Options:
      --db <DB>          [default: .agentctl/runtime.db]
      --output <OUTPUT>  [default: human] [possible values: human, json, jsonl]
      --color <COLOR>    [default: auto] [possible values: auto, always, never]
      --verbose
      --offline          Forbid pack network access and require cached Git/archive sources
      --locked           Require agentctl.pack.lock and reject all source or graph drift
  -h, --help             Print help

agentctl effects

Inspect or narrowly reconcile uncertain effects

Usage: agentctl effects [OPTIONS] <COMMAND>

Commands:
  list
  inspect
  continue-remote  Resume observation of a persisted remote task without resubmitting it
  reconcile

Options:
      --db <DB>          [default: .agentctl/runtime.db]
      --output <OUTPUT>  [default: human] [possible values: human, json, jsonl]
      --color <COLOR>    [default: auto] [possible values: auto, always, never]
      --verbose
      --offline          Forbid pack network access and require cached Git/archive sources
      --locked           Require agentctl.pack.lock and reject all source or graph drift
  -h, --help             Print help

agentctl effects list

Usage: agentctl effects list [OPTIONS] <RUN_ID>

Arguments:
  <RUN_ID>

Options:
      --output <OUTPUT>  [default: human] [possible values: human, json, jsonl]
      --task <TASK>
      --color <COLOR>    [default: auto] [possible values: auto, always, never]
      --verbose
      --offline          Forbid pack network access and require cached Git/archive sources
      --locked           Require agentctl.pack.lock and reject all source or graph drift
  -h, --help             Print help

agentctl effects inspect

Usage: agentctl effects inspect [OPTIONS] <EFFECT_ID>

Arguments:
  <EFFECT_ID>

Options:
      --output <OUTPUT>  [default: human] [possible values: human, json, jsonl]
      --color <COLOR>    [default: auto] [possible values: auto, always, never]
      --verbose
      --offline          Forbid pack network access and require cached Git/archive sources
      --locked           Require agentctl.pack.lock and reject all source or graph drift
  -h, --help             Print help

agentctl effects reconcile

Usage: agentctl effects reconcile [OPTIONS] --status <STATUS> --reason <REASON> <EFFECT_ID>

Arguments:
  <EFFECT_ID>

Options:
      --output <OUTPUT>
          [default: human] [possible values: human, json, jsonl]
      --status <STATUS>
          [possible values: applied, not-applied, compensated]
      --actor <ACTOR>
          [default: cli-user]
      --color <COLOR>
          [default: auto] [possible values: auto, always, never]
      --reason <REASON>

      --verbose

      --evidence-file <EVIDENCE_FILE>

      --offline
          Forbid pack network access and require cached Git/archive sources
      --locked
          Require agentctl.pack.lock and reject all source or graph drift
      --result-file <RESULT_FILE>

      --result-schema-file <RESULT_SCHEMA_FILE>

      --compensation-effect <COMPENSATION_EFFECT>

      --approved

  -h, --help
          Print help

agentctl approvals

List or resolve durable approval requests

Usage: agentctl approvals [OPTIONS] <COMMAND>

Commands:
  list
  approve
  reject

Options:
      --db <DB>          [default: .agentctl/runtime.db]
      --output <OUTPUT>  [default: human] [possible values: human, json, jsonl]
      --color <COLOR>    [default: auto] [possible values: auto, always, never]
      --verbose
      --offline          Forbid pack network access and require cached Git/archive sources
      --locked           Require agentctl.pack.lock and reject all source or graph drift
  -h, --help             Print help

agentctl approvals list

Usage: agentctl approvals list [OPTIONS] <RUN_ID>

Arguments:
  <RUN_ID>

Options:
      --output <OUTPUT>  [default: human] [possible values: human, json, jsonl]
      --color <COLOR>    [default: auto] [possible values: auto, always, never]
      --verbose
      --offline          Forbid pack network access and require cached Git/archive sources
      --locked           Require agentctl.pack.lock and reject all source or graph drift
  -h, --help             Print help

agentctl approvals approve

Usage: agentctl approvals approve [OPTIONS] --reason <REASON> <APPROVAL_ID>

Arguments:
  <APPROVAL_ID>

Options:
      --actor <ACTOR>    [default: cli-user]
      --output <OUTPUT>  [default: human] [possible values: human, json, jsonl]
      --color <COLOR>    [default: auto] [possible values: auto, always, never]
      --reason <REASON>
      --verbose
      --offline          Forbid pack network access and require cached Git/archive sources
      --locked           Require agentctl.pack.lock and reject all source or graph drift
  -h, --help             Print help

agentctl approvals reject

Usage: agentctl approvals reject [OPTIONS] --reason <REASON> <APPROVAL_ID>

Arguments:
  <APPROVAL_ID>

Options:
      --actor <ACTOR>    [default: cli-user]
      --output <OUTPUT>  [default: human] [possible values: human, json, jsonl]
      --color <COLOR>    [default: auto] [possible values: auto, always, never]
      --reason <REASON>
      --verbose
      --offline          Forbid pack network access and require cached Git/archive sources
      --locked           Require agentctl.pack.lock and reject all source or graph drift
  -h, --help             Print help

agentctl providers

Inspect provider capabilities or run the opt-in OpenAI smoke

Usage: agentctl providers [OPTIONS] <COMMAND>

Commands:
  inspect
  smoke-openai

Options:
      --output <OUTPUT>  [default: human] [possible values: human, json, jsonl]
      --color <COLOR>    [default: auto] [possible values: auto, always, never]
      --verbose
      --offline          Forbid pack network access and require cached Git/archive sources
      --locked           Require agentctl.pack.lock and reject all source or graph drift
  -h, --help             Print help

agentctl providers inspect

Usage: agentctl providers inspect [OPTIONS] <FILE>

Arguments:
  <FILE>

Options:
      --output <OUTPUT>  [default: human] [possible values: human, json, jsonl]
      --color <COLOR>    [default: auto] [possible values: auto, always, never]
      --verbose
      --offline          Forbid pack network access and require cached Git/archive sources
      --locked           Require agentctl.pack.lock and reject all source or graph drift
  -h, --help             Print help

agentctl providers smoke-openai

Usage: agentctl providers smoke-openai [OPTIONS] --live

Options:
      --live             Required acknowledgement that this performs one bounded live request
      --output <OUTPUT>  [default: human] [possible values: human, json, jsonl]
      --color <COLOR>    [default: auto] [possible values: auto, always, never]
      --model <MODEL>    [default: gpt-5.6]
      --verbose
      --offline          Forbid pack network access and require cached Git/archive sources
      --locked           Require agentctl.pack.lock and reject all source or graph drift
  -h, --help             Print help

agentctl auth

Check configured secret references without revealing values

Usage: agentctl auth [OPTIONS] <COMMAND>

Commands:
  check

Options:
      --output <OUTPUT>  [default: human] [possible values: human, json, jsonl]
      --color <COLOR>    [default: auto] [possible values: auto, always, never]
      --verbose
      --offline          Forbid pack network access and require cached Git/archive sources
      --locked           Require agentctl.pack.lock and reject all source or graph drift
  -h, --help             Print help

agentctl schema

Print or write the generated workflow JSON Schema

Usage: agentctl schema [OPTIONS]

Options:
      --output <OUTPUT>  [default: human] [possible values: human, json, jsonl]
      --write <WRITE>
      --color <COLOR>    [default: auto] [possible values: auto, always, never]
      --verbose
      --offline          Forbid pack network access and require cached Git/archive sources
      --locked           Require agentctl.pack.lock and reject all source or graph drift
  -h, --help             Print help

agentctl migrate

Translate an unversioned TypeScript-era workflow into workflow API v1

Usage: agentctl migrate [OPTIONS] <FILE>

Arguments:
  <FILE>

Options:
      --output <OUTPUT>  [default: human] [possible values: human, json, jsonl]
      --write <WRITE>
      --color <COLOR>    [default: auto] [possible values: auto, always, never]
      --verbose
      --offline          Forbid pack network access and require cached Git/archive sources
      --locked           Require agentctl.pack.lock and reject all source or graph drift
  -h, --help             Print help

agentctl packs

Inspect and verify a local reusable pack

Usage: agentctl packs [OPTIONS] <COMMAND>

Commands:
  inspect
  verify
  lock         Resolve the complete graph and write agentctl.pack.lock
  update       Refresh the locked graph from immutable sources
  verify-lock  Verify a lockfile, source digests, signatures, and trust policy

Options:
      --output <OUTPUT>  [default: human] [possible values: human, json, jsonl]
      --color <COLOR>    [default: auto] [possible values: auto, always, never]
      --verbose
      --offline          Forbid pack network access and require cached Git/archive sources
      --locked           Require agentctl.pack.lock and reject all source or graph drift
  -h, --help             Print help

agentctl packs inspect

Usage: agentctl packs inspect [OPTIONS] <MANIFEST>

Arguments:
  <MANIFEST>

Options:
      --output <OUTPUT>  [default: human] [possible values: human, json, jsonl]
      --color <COLOR>    [default: auto] [possible values: auto, always, never]
      --verbose
      --offline          Forbid pack network access and require cached Git/archive sources
      --locked           Require agentctl.pack.lock and reject all source or graph drift
  -h, --help             Print help

agentctl packs verify

Usage: agentctl packs verify [OPTIONS] --integrity <INTEGRITY> <MANIFEST>

Arguments:
  <MANIFEST>

Options:
      --integrity <INTEGRITY>
      --output <OUTPUT>        [default: human] [possible values: human, json, jsonl]
      --color <COLOR>          [default: auto] [possible values: auto, always, never]
      --verbose
      --offline                Forbid pack network access and require cached Git/archive sources
      --locked                 Require agentctl.pack.lock and reject all source or graph drift
  -h, --help                   Print help

agentctl packs lock

Resolve the complete graph and write agentctl.pack.lock

Usage: agentctl packs lock [OPTIONS] <WORKFLOW>

Arguments:
  <WORKFLOW>

Options:
      --output <OUTPUT>  [default: human] [possible values: human, json, jsonl]
      --color <COLOR>    [default: auto] [possible values: auto, always, never]
      --verbose
      --offline          Forbid pack network access and require cached Git/archive sources
      --locked           Require agentctl.pack.lock and reject all source or graph drift
  -h, --help             Print help

agentctl packs update

Refresh the locked graph from immutable sources

Usage: agentctl packs update [OPTIONS] <WORKFLOW>

Arguments:
  <WORKFLOW>

Options:
      --output <OUTPUT>  [default: human] [possible values: human, json, jsonl]
      --pack <PACK>
      --color <COLOR>    [default: auto] [possible values: auto, always, never]
      --verbose
      --offline          Forbid pack network access and require cached Git/archive sources
      --locked           Require agentctl.pack.lock and reject all source or graph drift
  -h, --help             Print help

agentctl packs verify-lock

Verify a lockfile, source digests, signatures, and trust policy

Usage: agentctl packs verify-lock [OPTIONS] <WORKFLOW>

Arguments:
  <WORKFLOW>

Options:
      --output <OUTPUT>  [default: human] [possible values: human, json, jsonl]
      --color <COLOR>    [default: auto] [possible values: auto, always, never]
      --verbose
      --offline          Forbid pack network access and require cached Git/archive sources
      --locked           Require agentctl.pack.lock and reject all source or graph drift
  -h, --help             Print help

agentctl artifacts

Inspect, verify, export, or collect durable artifacts

Usage: agentctl artifacts [OPTIONS] <COMMAND>

Commands:
  list
  inspect
  verify
  export
  gc

Options:
      --db <DB>          [default: .agentctl/runtime.db]
      --output <OUTPUT>  [default: human] [possible values: human, json, jsonl]
      --color <COLOR>    [default: auto] [possible values: auto, always, never]
      --verbose
      --offline          Forbid pack network access and require cached Git/archive sources
      --locked           Require agentctl.pack.lock and reject all source or graph drift
  -h, --help             Print help

agentctl artifacts list

Usage: agentctl artifacts list [OPTIONS]

Options:
      --output <OUTPUT>  [default: human] [possible values: human, json, jsonl]
      --run <RUN>
      --color <COLOR>    [default: auto] [possible values: auto, always, never]
      --task <TASK>
      --verbose
      --offline          Forbid pack network access and require cached Git/archive sources
      --locked           Require agentctl.pack.lock and reject all source or graph drift
  -h, --help             Print help

agentctl artifacts inspect

Usage: agentctl artifacts inspect [OPTIONS] <DIGEST>

Arguments:
  <DIGEST>

Options:
      --output <OUTPUT>  [default: human] [possible values: human, json, jsonl]
      --color <COLOR>    [default: auto] [possible values: auto, always, never]
      --verbose
      --offline          Forbid pack network access and require cached Git/archive sources
      --locked           Require agentctl.pack.lock and reject all source or graph drift
  -h, --help             Print help

agentctl artifacts verify

Usage: agentctl artifacts verify [OPTIONS] [DIGEST]

Arguments:
  [DIGEST]

Options:
      --all
      --output <OUTPUT>  [default: human] [possible values: human, json, jsonl]
      --color <COLOR>    [default: auto] [possible values: auto, always, never]
      --verbose
      --offline          Forbid pack network access and require cached Git/archive sources
      --locked           Require agentctl.pack.lock and reject all source or graph drift
  -h, --help             Print help

agentctl artifacts export

Usage: agentctl artifacts export [OPTIONS] <DIGEST> <DESTINATION>

Arguments:
  <DIGEST>
  <DESTINATION>

Options:
      --output <OUTPUT>  [default: human] [possible values: human, json, jsonl]
      --overwrite
      --color <COLOR>    [default: auto] [possible values: auto, always, never]
      --verbose
      --offline          Forbid pack network access and require cached Git/archive sources
      --locked           Require agentctl.pack.lock and reject all source or graph drift
  -h, --help             Print help

agentctl artifacts gc

Usage: agentctl artifacts gc [OPTIONS]

Options:
      --older-than-days <OLDER_THAN_DAYS>
          [default: 30]
      --output <OUTPUT>
          [default: human] [possible values: human, json, jsonl]
      --color <COLOR>
          [default: auto] [possible values: auto, always, never]
      --dry-run

      --verbose

      --offline
          Forbid pack network access and require cached Git/archive sources
      --locked
          Require agentctl.pack.lock and reject all source or graph drift
  -h, --help
          Print help

agentctl db

Inspect the runtime database

Usage: agentctl db [OPTIONS] <COMMAND>

Commands:
  stats
  migrate
  encryption

Options:
      --db <DB>          [default: .agentctl/runtime.db]
      --output <OUTPUT>  [default: human] [possible values: human, json, jsonl]
      --color <COLOR>    [default: auto] [possible values: auto, always, never]
      --verbose
      --offline          Forbid pack network access and require cached Git/archive sources
      --locked           Require agentctl.pack.lock and reject all source or graph drift
  -h, --help             Print help

agentctl db encryption

Usage: agentctl db encryption [OPTIONS] <COMMAND>

Commands:
  inventory  Inventory protected fields without exposing their values
  enable     Transactionally encrypt every identified sensitive field
  rotate     Transactionally decrypt and re-encrypt every protected field with a new key

Options:
      --output <OUTPUT>  [default: human] [possible values: human, json, jsonl]
      --color <COLOR>    [default: auto] [possible values: auto, always, never]
      --verbose
      --offline          Forbid pack network access and require cached Git/archive sources
      --locked           Require agentctl.pack.lock and reject all source or graph drift
  -h, --help             Print help

agentctl db encryption inventory

Inventory protected fields without exposing their values

Usage: agentctl db encryption inventory [OPTIONS]

Options:
      --output <OUTPUT>  [default: human] [possible values: human, json, jsonl]
      --color <COLOR>    [default: auto] [possible values: auto, always, never]
      --verbose
      --offline          Forbid pack network access and require cached Git/archive sources
      --locked           Require agentctl.pack.lock and reject all source or graph drift
  -h, --help             Print help

agentctl db encryption enable

Transactionally encrypt every identified sensitive field

Usage: agentctl db encryption enable [OPTIONS] --key-id <KEY_ID> --key-env <KEY_ENV>

Options:
      --key-id <KEY_ID>
      --output <OUTPUT>    [default: human] [possible values: human, json, jsonl]
      --color <COLOR>      [default: auto] [possible values: auto, always, never]
      --key-env <KEY_ENV>  Environment variable containing a base64-encoded 32-byte key
      --dry-run
      --verbose
      --offline            Forbid pack network access and require cached Git/archive sources
      --locked             Require agentctl.pack.lock and reject all source or graph drift
  -h, --help               Print help

agentctl db encryption rotate

Transactionally decrypt and re-encrypt every protected field with a new key

Usage: agentctl db encryption rotate [OPTIONS] --key-id <KEY_ID> --key-env <KEY_ENV>

Options:
      --key-id <KEY_ID>
      --output <OUTPUT>    [default: human] [possible values: human, json, jsonl]
      --color <COLOR>      [default: auto] [possible values: auto, always, never]
      --key-env <KEY_ENV>  Environment variable containing a base64-encoded 32-byte key
      --dry-run
      --verbose
      --offline            Forbid pack network access and require cached Git/archive sources
      --locked             Require agentctl.pack.lock and reject all source or graph drift
  -h, --help               Print help

agentctl memory

Read or write namespaced long-term memory

Usage: agentctl memory [OPTIONS] <COMMAND>

Commands:
  get
  put
  search
  reindex

Options:
      --db <DB>          [default: .agentctl/runtime.db]
      --output <OUTPUT>  [default: human] [possible values: human, json, jsonl]
      --color <COLOR>    [default: auto] [possible values: auto, always, never]
      --verbose
      --offline          Forbid pack network access and require cached Git/archive sources
      --locked           Require agentctl.pack.lock and reject all source or graph drift
  -h, --help             Print help

agentctl memory get

Usage: agentctl memory get [OPTIONS] <NAMESPACE> <KEY>

Arguments:
  <NAMESPACE>
  <KEY>

Options:
      --output <OUTPUT>  [default: human] [possible values: human, json, jsonl]
      --color <COLOR>    [default: auto] [possible values: auto, always, never]
      --verbose
      --offline          Forbid pack network access and require cached Git/archive sources
      --locked           Require agentctl.pack.lock and reject all source or graph drift
  -h, --help             Print help

agentctl memory put

Usage: agentctl memory put [OPTIONS] <NAMESPACE> <KEY> <VALUE>

Arguments:
  <NAMESPACE>
  <KEY>
  <VALUE>

Options:
      --output <OUTPUT>
          [default: human] [possible values: human, json, jsonl]
      --text <TEXT>

      --color <COLOR>
          [default: auto] [possible values: auto, always, never]
      --metadata <METADATA>

      --retention-days <RETENTION_DAYS>

      --verbose

      --offline
          Forbid pack network access and require cached Git/archive sources
      --locked
          Require agentctl.pack.lock and reject all source or graph drift
  -h, --help
          Print help

agentctl memory search

Usage: agentctl memory search [OPTIONS] <NAMESPACE> <QUERY>

Arguments:
  <NAMESPACE>
  <QUERY>

Options:
      --mode <MODE>        [default: text] [possible values: text, vector, hybrid]
      --output <OUTPUT>    [default: human] [possible values: human, json, jsonl]
      --color <COLOR>      [default: auto] [possible values: auto, always, never]
      --limit <LIMIT>      [default: 10]
      --filter <KEY=JSON>
      --verbose
      --offline            Forbid pack network access and require cached Git/archive sources
      --locked             Require agentctl.pack.lock and reject all source or graph drift
  -h, --help               Print help

agentctl memory reindex

Usage: agentctl memory reindex [OPTIONS] <NAMESPACE>

Arguments:
  <NAMESPACE>

Options:
      --output <OUTPUT>  [default: human] [possible values: human, json, jsonl]
      --color <COLOR>    [default: auto] [possible values: auto, always, never]
      --verbose
      --offline          Forbid pack network access and require cached Git/archive sources
      --locked           Require agentctl.pack.lock and reject all source or graph drift
  -h, --help             Print help

agentctl gc

Garbage-collect expired memory and old terminal runs

Usage: agentctl gc [OPTIONS]

Options:
      --db <DB>
          [default: .agentctl/runtime.db]
      --output <OUTPUT>
          [default: human] [possible values: human, json, jsonl]
      --color <COLOR>
          [default: auto] [possible values: auto, always, never]
      --older-than-days <OLDER_THAN_DAYS>
          [default: 30]
      --verbose

      --offline
          Forbid pack network access and require cached Git/archive sources
      --locked
          Require agentctl.pack.lock and reject all source or graph drift
  -h, --help
          Print help

agentctl completion

Generate completion for a supported shell

Usage: agentctl completion [OPTIONS] <SHELL>

Arguments:
  <SHELL>  [possible values: bash, elvish, fish, powershell, zsh]

Options:
      --output <OUTPUT>  [default: human] [possible values: human, json, jsonl]
      --color <COLOR>    [default: auto] [possible values: auto, always, never]
      --verbose
      --offline          Forbid pack network access and require cached Git/archive sources
      --locked           Require agentctl.pack.lock and reject all source or graph drift
  -h, --help             Print help

agentctl version

Print the exact build version

Usage: agentctl version [OPTIONS]

Options:
      --output <OUTPUT>  [default: human] [possible values: human, json, jsonl]
      --color <COLOR>    [default: auto] [possible values: auto, always, never]
      --verbose
      --offline          Forbid pack network access and require cached Git/archive sources
      --locked           Require agentctl.pack.lock and reject all source or graph drift
  -h, --help             Print help

agentctl update

Explain safe update options without modifying the installation

Usage: agentctl update [OPTIONS]

Options:
      --output <OUTPUT>  [default: human] [possible values: human, json, jsonl]
      --color <COLOR>    [default: auto] [possible values: auto, always, never]
      --verbose
      --offline          Forbid pack network access and require cached Git/archive sources
      --locked           Require agentctl.pack.lock and reject all source or graph drift
  -h, --help             Print help