Enum Commands

Source

pub enum Commands {
Show 25 variants    New {
        topic: String,
        preset: Option<String>,
        slug: Option<String>,
        force: bool,
        from: Option<String>,
        tag: Vec<String>,
    },
    List {
        tag: Option<String>,
        tree: bool,
    },
    Show {
        slug: String,
    },
    Status {
        slug: Option<String>,
    },
    Audit {
        slug: Option<String>,
    },
    GithubAudit {
        repo: String,
        depth: String,
        sample: usize,
        out: Option<String>,
        html: Option<String>,
    },
    Resume {
        slug: String,
    },
    Add {
        url: String,
        slug: Option<String>,
        timeout: Option<u64>,
        readable: bool,
        no_readable: bool,
        min_bytes: Option<u64>,
        on_short_body: Option<String>,
        frame_id: Option<u32>,
        run_code_args: Option<String>,
        reseed: bool,
    },
    AddLocal {
        path: String,
        slug: Option<String>,
        glob: Vec<String>,
        max_file_bytes: Option<u64>,
        max_total_bytes: Option<u64>,
        original_url: Option<String>,
        origin_tool: Option<String>,
        origin_note: Option<String>,
    },
    Sources {
        slug: Option<String>,
        rejected: bool,
    },
    Batch {
        urls: Vec<String>,
        slug: Option<String>,
        concurrency: Option<usize>,
        timeout: Option<u64>,
        readable: bool,
        no_readable: bool,
        min_bytes: Option<u64>,
        on_short_body: Option<String>,
        frame_id: Option<u32>,
        run_code_args: Option<String>,
        reseed: bool,
    },
    Synthesize {
        slug: Option<String>,
        no_render: bool,
        open: bool,
        bilingual: bool,
        pdf: bool,
        pdf_output: Option<String>,
    },
    Finish {
        slug: String,
        open: bool,
        bilingual: bool,
    },
    Report {
        slug: Option<String>,
        format: String,
        open: bool,
        no_open: bool,
        stdout: bool,
        output: Option<String>,
    },
    Close {
        slug: Option<String>,
    },
    Rm {
        slug: String,
        force: bool,
    },
    Route {
        url: String,
        prefer: Option<String>,
        rules: Option<String>,
        preset: Option<String>,
    },
    Series {
        tag: String,
        open: bool,
    },
    Diff {
        slug: Option<String>,
        unused_only: bool,
    },
    Coverage {
        slug: Option<String>,
    },
    Doctor {
        provider_smoke: bool,
        tool_smoke: bool,
        provider: String,
    },
    Loop {
        slug: Option<String>,
        provider: String,
        iterations: Option<u32>,
        max_actions: Option<u32>,
        dry_run: bool,
        fake_responses: Option<String>,
    },
    Wiki {
        sub: WikiCmd,
    },
    Schema {
        sub: SchemaCmd,
    },
    Help,
}

Variants§

§

New

Create a new research session and set it active.

Fields

§topic: String

§preset: Option<String>

§slug: Option<String>

§force: bool

§from: Option<String>

Fork from a parent session — copies its ## Overview as ## Context.

§tag: Vec<String>

Tag this session (repeatable). Inherited from –from if provided.

§

List

List all research sessions.

Fields

§tag: Option<String>

Filter by tag.

§tree: bool

Show parent→child hierarchy as an ASCII tree.

§

Show

Print a session.md to stdout so an agent can resume context.

Fields

§slug: String

§

Status

Show counts + timings for the current or given session.

Fields

§slug: Option<String>

§

Audit

Inspect session.jsonl as a compact audit trail for hand calls, facts, and synthesis.

Fields

§slug: Option<String>

§

GithubAudit

Audit GitHub repository trust signals.

Fields

§repo: String

§depth: String

§sample: usize

§out: Option<String>

§html: Option<String>

§

Resume

Set a session active again and print its session.md + recent events.

Fields

§slug: String

§

Add

Route + fetch + smell-test a URL and attach to the active session.

Fields

§url: String

§slug: Option<String>

§timeout: Option<u64>

§readable: bool

§no_readable: bool

§min_bytes: Option<u64>

Override smell-test min body bytes (browser path only).

§on_short_body: Option<String>

Short-body behavior: “reject” (default) or “warn”.

§frame_id: Option<u32>

V2-only: run the inline JS inside the given iframe (OOPIF support). Default = top frame. Requires ACTIONBOOK_BACKEND=v2-mcp (default). Must be >= 0.

§run_code_args: Option<String>

V2-only: JSON array forwarded to the inline JS as $args. Requires ACTIONBOOK_BACKEND=v2-mcp (default). Must be a JSON array (empty [] is allowed; non-array JSON is rejected).

§reseed: bool

Force re-fetch of any catalog-seeded wiki manuals (overwrite existing pages with fresh fetched_at). Default is skip-if- exists; see specs/actionbook-catalog-seed.spec.md.

§

AddLocal

Bulk-ingest a local file or directory tree as sources.

Walks the path, applies optional –glob include/exclude patterns (prefix with ! to exclude), enforces per-file and per-walk size caps, and attaches each accepted file as its own source via the same pipeline as research add file:///....

Fields

§path: String

File or directory to ingest. Accepts file://, absolute, relative (./x), home-relative (~/x), or bare path.

§slug: Option<String>

§glob: Vec<String>

Glob pattern (repeatable). Prefix with ! to exclude. Examples: --glob '**/*.rs' --glob '!**/test/**'. If omitted, matches all files.

§max_file_bytes: Option<u64>

Per-file cap in bytes. Files over this are skipped with a too_large reason. Default 256 KiB.

§max_total_bytes: Option<u64>

Total cap for the whole walk. Walk stops (not truncates) when this would be exceeded. Default 2 MiB.

§original_url: Option<String>

Original online URL represented by the local cache/source note. Used for fallback provenance in session.jsonl.

§origin_tool: Option<String>

Tool that produced the local fallback artifact, e.g. curl, browser-cache, web, manual.

§origin_note: Option<String>

Human-readable reason for the fallback ingest.

§

Sources

List sources attached to the current or given session.

Fields

§slug: Option<String>

§rejected: bool

§

Batch

Route + fetch + smell-test multiple URLs in parallel.

Fields

§urls: Vec<String>

One or more URLs to fetch concurrently.

§slug: Option<String>

§concurrency: Option<usize>

Worker threads (1–16, default 4).

§timeout: Option<u64>

§readable: bool

§no_readable: bool

§min_bytes: Option<u64>

Override smell-test min body bytes (browser path only).

§on_short_body: Option<String>

Short-body behavior: “reject” (default) or “warn”.

§frame_id: Option<u32>

V2-only: run the inline JS inside the given iframe for every URL in the batch. Default = top frame. Requires ACTIONBOOK_BACKEND=v2-mcp (default). Must be >= 0.

§run_code_args: Option<String>

V2-only: JSON array forwarded to the inline JS as $args for every URL in the batch (shared, not per-url). Requires ACTIONBOOK_BACKEND=v2-mcp (default). Must be a JSON array.

§reseed: bool

Force re-fetch of any catalog-seeded wiki manuals (overwrite existing pages). Applies to every URL in the batch. See specs/actionbook-catalog-seed.spec.md.

§

Synthesize

Synthesize session.md + raw/ into report.json + report.html.

Fields

§slug: Option<String>

§no_render: bool

§open: bool

§bilingual: bool

Also render Chinese translations next to each English paragraph in report.html. Requires a working LLM provider; choose one with ASR_BILINGUAL_PROVIDER=claude|codex. Costs tokens proportional to report length.

§pdf: bool

Also convert the rendered report.html to report.pdf using isolated local Chromium.

§pdf_output: Option<String>

Explicit PDF output path. Implies –pdf.

§