Skip to content

CLI reference

103 commands (schema v1). Agents: run gigai agent-context --json for the machine-readable form.

  • effect: read never changes state; write may change GigAI state or files (for some commands only with certain options).
  • external: the strongest thing the command can reach. none is offline, model may call a model provider (cost, and text leaves this machine), network may make other network requests.

Print the machine-readable command manual (this file merged with the live Click tree).

gigai agent-context [OPTIONS]

effect: read · external: none · output: One summary line; –json emits the full manual (schemaVersion, commandCount, commands).

Example:

Terminal window
gigai agent-context
gigai agent-context --json

Offline; reads only the packaged manifest and the command tree.

Print a recommended Claude Code permissions snippet (deny reading ~/.gigai, allow the GigAI CLI) for you to apply.

gigai agent-permissions [OPTIONS]

effect: read · external: none · output: A JSON snippet and a short plain explanation on stdout.

Example:

Terminal window
gigai agent-permissions
gigai agent-permissions --agent claude-code
gigai agent-permissions --port 8766

Offline. Prints only; GigAI never edits your agent’s settings. The curl rules name Scout’s port: pass –port if you started Scout with gigai scout run --port.

Print the instructions that teach your AI agent the daily Scout loop (a Claude Code SKILL.md, or an AGENTS.md section).

gigai agent-skill [OPTIONS]

effect: read · external: none · output: The instructions text on stdout; with –out, one line naming the file written.

Example:

Terminal window
gigai agent-skill
gigai agent-skill --format agents-md
gigai agent-skill --format skill --out SKILL.md

Offline. Prints by default; –out writes only the file you name and refuses to replace an existing one without –force. Never writes into an agent’s own folders by itself.

List the recorded application history for one Gig, optionally for one opportunity.

gigai application history [OPTIONS]

effect: read · external: none · output: Human-readable text; –json emits one JSON object.

Example:

Terminal window
gigai application history --gig scout --opportunity opp-1

Record an application outcome from an explicit input file (needs –confirm).

gigai application record [OPTIONS]

effect: write · external: none · output: Human-readable text; –json emits one JSON object.

Example:

Terminal window
gigai application record --gig scout --input outcome.json --confirm

Write requires direct operator –confirm.

Show the current application state for one Gig, optionally for one opportunity.

gigai application status [OPTIONS]

effect: read · external: none · output: Human-readable text; –json emits one JSON object.

Example:

Terminal window
gigai application status --gig scout

Seal one pending proposal as an offline approved Gig version.

gigai approve [OPTIONS] PROPOSAL_ID

effect: write · external: none · output: Human-readable text; –json emits one JSON object.

Example:

Terminal window
gigai approve prop-1

Approval is offline; no model is called.

Prepare a pending successor proposal from one committed passed capability review. Never approves, activates or invokes.

gigai capability prepare-successor [OPTIONS]

effect: write · external: none · output: Human-readable text; –json emits one JSON object.

Example:

Terminal window
gigai capability prepare-successor --gig scout --base-version 1 --base-proposal-id prop-1 --capability-id write_workpad --reviewed-manifest-id man-1 --operation-key op-1

Record reviewer judgment for the write_workpad capability from an input file (needs –confirm).

gigai capability review [OPTIONS]

effect: write · external: none · output: Human-readable text; –json emits one JSON object.

Example:

Terminal window
gigai capability review --gig scout --base-version 1 --base-proposal-id prop-1 --manifest-id man-1 --capability-id write_workpad --operation-key op-1 --input review.json --confirm

Show one bundled catalog entry.

gigai catalog inspect [OPTIONS] CATALOG_ID

effect: read · external: none · output: Human-readable text; –json emits one JSON object.

Example:

Terminal window
gigai catalog inspect scout

Install a bundled catalog entry into the target project.

gigai catalog install [OPTIONS] CATALOG_ID

effect: write · external: none · output: Human-readable text; –json emits one JSON object.

Example:

Terminal window
gigai catalog install scout --target .

List the bundled catalog entries.

gigai catalog list [OPTIONS]

effect: read · external: none · output: Human-readable text; –json emits one JSON object.

Example:

Terminal window
gigai catalog list

Validate one bundled catalog entry.

gigai catalog validate [OPTIONS] CATALOG_ID

effect: read · external: none · output: Human-readable text; –json emits one JSON object.

Example:

Terminal window
gigai catalog validate scout

Validate one existing proposal workpad without creating or changing it.

gigai check [OPTIONS] [GIG_ID]

effect: read · external: none · output: Human-readable text; –json emits one JSON object.

Example:

Terminal window
gigai check scout

Resume an interrupted comparison without rerunning terminal cases.

gigai comparison resume [OPTIONS] COMPARISON_ID

effect: write · external: model · output: Human-readable text; –json emits one JSON object.

Example:

Terminal window
gigai comparison resume cmp-1 --gig scout --local-target ollama-local --luna-target codex --confirm

Calls the two named model targets; needs –confirm.

Run the same frozen synthetic cases through two named model setups (local and Luna).

gigai comparison run [OPTIONS]

effect: write · external: model · output: Human-readable text; –json emits one JSON object.

Also registered as: gigai comparison start

Example:

Terminal window
gigai comparison run --gig scout --local-target ollama-local --luna-target codex --confirm

Calls the two named model targets; needs –confirm. comparison start is the same command.

Read one journal-authenticated comparison without rerunning it.

gigai comparison show [OPTIONS] COMPARISON_ID

effect: read · external: none · output: Human-readable text; –json emits one JSON object.

Example:

Terminal window
gigai comparison show cmp-1 --gig scout

Alias of comparison run.

gigai comparison start [OPTIONS]

effect: write · external: model · output: Human-readable text; –json emits one JSON object.

Also registered as: gigai comparison run

Example:

Terminal window
gigai comparison start --gig scout --local-target ollama-local --luna-target codex --confirm

Calls the two named model targets; needs –confirm. comparison start is the same command.

Read authenticated attempt and per-case checkpoint status of a comparison.

gigai comparison status [OPTIONS] COMPARISON_ID

effect: read · external: none · output: Human-readable text; –json emits one JSON object.

Example:

Terminal window
gigai comparison status cmp-1 --gig scout

Create a proposal from an explicit agent invocation envelope (command=create).

gigai create [OPTIONS] NAME

effect: write · external: none · output: Human-readable text; –json emits one JSON object.

Example:

Terminal window
gigai create scout --invocation create.json

Requires –invocation; ordinary conversation is not imported. Refreshes the local runtime discovery snapshot; no model call.

Run offline, zero-token installation and configured-mount checks.

gigai doctor [OPTIONS]

effect: write · external: model · output: Human-readable text; –json emits one JSON object.

Example:

Terminal window
gigai doctor --json
gigai doctor --repair-journal

Default is offline, zero-token and read only. –live with –model-target makes one budget-bounded provider call (external=model). –repair-journal is the only option that writes (effect=write), and it runs instead of the checks. When a process died in the middle of a save (a crash, a power loss), later saves are refused until this has run (and, when the process died after the save’s files were written, reads too): with journal_reconciliation_required, which names this command (next_action in –json and in the API error); in that second case plain doctor also fails journal.index and its remediation names it. It finishes that interrupted write in every managed workpad of the home and reports what it finished: the journal.repair check lists finished_gig= sequence= commit= per finished write and failed_gig= code= reason= per journal it could not reconcile (overall FAIL, exit code 1); a workpad whose Git ownership markers do not name the folder it is in is refused that way, and nothing is written to it. The interrupted save is completed, not dropped; retry the refused save afterwards. On a healthy home it reports nothing to repair and changes no file. Safe to run again, and beside a running Scout server. Never run automatically. Pass the same –home the refused command used.

Record cancellation of an externally performed invocation under an approved Gig.

gigai external cancel [OPTIONS]

effect: write · external: none · output: Human-readable text; –json emits one JSON object.

Example:

Terminal window
gigai external cancel --gig scout --stdin

No provider runs; protocol for agents that perform the work themselves.

Record an external checkpoint under an approved Gig.

gigai external checkpoint [OPTIONS]

effect: write · external: none · output: Human-readable text; –json emits one JSON object.

Example:

Terminal window
gigai external checkpoint --gig scout --stdin

No provider runs.

List the approved Graphs an external agent may work under.

gigai external graphs [OPTIONS]

effect: read · external: none · output: Human-readable text; –json emits one JSON object.

Example:

Terminal window
gigai external graphs --gig scout

Inspect the state of an external run (or the Gig).

gigai external inspect [OPTIONS]

effect: read · external: none · output: Human-readable text; –json emits one JSON object.

Example:

Terminal window
gigai external inspect --gig scout

Record an external plan under an approved Gig.

gigai external plan [OPTIONS]

effect: write · external: none · output: Human-readable text; –json emits one JSON object.

Example:

Terminal window
gigai external plan --gig scout --stdin

No provider runs.

Show the requirements of one approved Graph for external work.

gigai external requirements [OPTIONS]

effect: read · external: none · output: Human-readable text; –json emits one JSON object.

Example:

Terminal window
gigai external requirements --gig scout --graph tailor-application

Start recording an externally performed run under an approved Gig.

gigai external start [OPTIONS]

effect: write · external: none · output: Human-readable text; –json emits one JSON object.

Example:

Terminal window
gigai external start --gig scout --stdin

No provider runs.

Submit the result of an externally performed run under an approved Gig.

gigai external submit [OPTIONS]

effect: write · external: none · output: Human-readable text; –json emits one JSON object.

Example:

Terminal window
gigai external submit --gig scout --stdin

No provider runs.

Record verbatim operator feedback for one pending proposal.

gigai feedback [OPTIONS] PROPOSAL_ID

effect: write · external: none · output: Human-readable text.

Example:

Terminal window
gigai feedback prop-1 --text "Make the summary shorter"

Make one already-installed, approved Gig the active Gig for this project.

gigai gig use [OPTIONS] GIG_ID

effect: write · external: none · output: Human-readable text; –json emits one JSON object.

Example:

Terminal window
gigai gig use scout

List registered Gigs for the bound project without writing workpad state.

gigai gigs [OPTIONS]

effect: read · external: none · output: Human-readable text; –json emits one JSON object.

Example:

Terminal window
gigai gigs --json

Atomically stage a v2 Graph Set from a definition file; never approves or runs it.

gigai graph-set propose [OPTIONS]

effect: write · external: none · output: Human-readable text; –json emits one JSON object.

Example:

Terminal window
gigai graph-set propose --definition graphs.json

List committed journal transitions for one Gig in sequence order.

gigai history [OPTIONS] [GIG_ID]

effect: read · external: none · output: Human-readable text; –json emits one JSON object.

Example:

Terminal window
gigai history scout

Initialize the package boundary and recoverable default instances.

gigai init [OPTIONS]

effect: write · external: none · output: Human-readable text; –json emits one JSON object.

Example:

Terminal window
gigai init --confirm

Validate one explicit agent invocation envelope without creating GigAI authority.

gigai invoke [OPTIONS]

effect: read · external: none · output: Human-readable text; –json emits one JSON object.

Example:

Terminal window
gigai invoke --input envelope.json

Migrate one existing clean workpad to the authenticated v2 layout.

gigai layout migrate [OPTIONS]

effect: write · external: none · output: Human-readable text; –json emits one JSON object.

Example:

Terminal window
gigai layout migrate --gig scout

Show model discovery; optionally run one explicit readiness probe.

gigai models [OPTIONS]

effect: write · external: model · output: Human-readable text; –json emits one JSON object.

Example:

Terminal window
gigai models --json

–refresh re-captures the local runtime discovery snapshot (writes). –probe TARGET makes one bounded readiness call to that target (external=model).

Close a terminal occurrence without creating another Run.

gigai occurrence close [OPTIONS] OCCURRENCE_ID

effect: write · external: none · output: Human-readable text; –json emits one JSON object.

Example:

Terminal window
gigai occurrence close occ-1

Compare one completed occurrence with its explicitly named prior occurrence.

gigai occurrence compare [OPTIONS] CURRENT_OCCURRENCE_ID

effect: read · external: none · output: Human-readable text; –json emits one JSON object.

Example:

Terminal window
gigai occurrence compare occ-2 --prior-occurrence occ-1

Declare one explicit recurrence slot without starting a Run.

gigai occurrence declare [OPTIONS] {daily|weekly|monthly} OCCURRENCE_KEY

effect: write · external: none · output: Human-readable text; –json emits one JSON object.

Example:

Terminal window
gigai occurrence declare weekly 2026-W40 --snapshot snap-1

Record an explicit occurrence outcome without starting a Run.

gigai occurrence mark [OPTIONS] OCCURRENCE_ID {missed|skipped|unavailable|cancelled|blocked|failed}

effect: write · external: none · output: Human-readable text; –json emits one JSON object.

Example:

Terminal window
gigai occurrence mark occ-1 skipped --reason "on holiday" --actor-id me

Reconcile a prepared occurrence without relaunching its Run.

gigai occurrence reconcile [OPTIONS] OCCURRENCE_ID

effect: write · external: none · output: Human-readable text; –json emits one JSON object.

Example:

Terminal window
gigai occurrence reconcile occ-1

Trigger one declared occurrence through the existing Run path (needs –confirm).

gigai occurrence trigger [OPTIONS] OCCURRENCE_ID

effect: write · external: model · output: Human-readable text; –json emits one JSON object.

Example:

Terminal window
gigai occurrence trigger occ-1 --confirm

Uses the same Run path as gigai run, so a provider-backed Graph may call a model.

Launch the structured editor for the declared, existing locations of a Gig.

gigai open [OPTIONS] [GIG_ID]

effect: read · external: none · output: Human-readable text.

Example:

Terminal window
gigai open scout

Starts the configured editor process; changes no GigAI state itself.

Export validated portable package bytes without project or Gig authority.

gigai package export [OPTIONS] PACKAGE_PATH DESTINATION

effect: write · external: none · output: Human-readable text; –json emits one JSON object.

Example:

Terminal window
gigai package export pkg.gigai out.gigai

Validate one package and report its portable identity.

gigai package inspect [OPTIONS] PACKAGE_PATH

effect: read · external: none · output: Human-readable text; –json emits one JSON object.

Example:

Terminal window
gigai package inspect pkg.gigai

Install portable package bytes without importing project or Gig authority.

gigai package install [OPTIONS] PACKAGE_PATH

effect: write · external: none · output: Human-readable text; –json emits one JSON object.

Example:

Terminal window
gigai package install pkg.gigai --target .

Render the proposed or approved Goal Graph without starting work.

gigai plan [OPTIONS] [GIG_ID]

effect: read · external: none · output: Human-readable text; –json emits one JSON object.

Example:

Terminal window
gigai plan scout

Assess one authenticated posting with explicitly selected private revisions.

gigai proposal [OPTIONS] [GIG_ID]

effect: write · external: model · output: Human-readable text; –json emits one JSON object.

Example:

Terminal window
gigai proposal scout --model-target ollama-local --posting-selector post-1 --private-selector rev-1 --confirm

Calls the named local Ollama target; needs –confirm.

Show the proposal envelope currently committed for one Gig.

gigai proposals [OPTIONS] [GIG_ID]

effect: read · external: none · output: Human-readable text; –json emits one JSON object.

Example:

Terminal window
gigai proposals scout

Record a direct operator decision on a provider review; never approval or Run authority.

gigai provider-review closeout [OPTIONS]

effect: write · external: none · output: Human-readable text; –json emits one JSON object.

Example:

Terminal window
gigai provider-review closeout --run run-1 --plan plan-1 --confirm

Create a private record revision from a kind, content family and id.

gigai record create [OPTIONS]

effect: write · external: none · output: Human-readable text; –json emits one JSON object.

Example:

Terminal window
gigai record create --kind profile_preferences --content-family g45_reference --content-id ref-1 --operation-key op-1

Archive one native record.

gigai record native archive [OPTIONS]

effect: write · external: none · output: Human-readable text; –json emits one JSON object.

Example:

Terminal window
gigai record native archive --id rec-1 --parent-revision rev-1 --operation-key op-1

Show the native record context for this Gig.

gigai record native context [OPTIONS]

effect: read · external: none · output: Human-readable text; –json emits one JSON object.

Example:

Terminal window
gigai record native context

Create a native record from a content file.

gigai record native create [OPTIONS]

effect: write · external: none · output: Human-readable text; –json emits one JSON object.

Example:

Terminal window
gigai record native create --content-file content.json --operation-key op-1

In the JSON, projection_pending: true needs no action: the record is stored, and the internal index of records follows when Scout next starts. rebuild_action is always null; there is no command to run.

List native records (metadata only).

gigai record native list [OPTIONS]

effect: read · external: none · output: Human-readable text; –json emits one JSON object.

Example:

Terminal window
gigai record native list

Create a task-context override of a native record from a content file.

gigai record native override [OPTIONS]

effect: write · external: none · output: Human-readable text; –json emits one JSON object.

Example:

Terminal window
gigai record native override --content-file content.json --base-record rec-1 --base-revision rev-1 --operation-key op-1

In the JSON, projection_pending: true needs no action: the record is stored, and the internal index of records follows when Scout next starts.

Read one native record revision.

gigai record native read [OPTIONS]

effect: read · external: none · output: Human-readable text; –json emits one JSON object.

Example:

Terminal window
gigai record native read --id rec-1

Append a new revision to a native record from a content file.

gigai record native update [OPTIONS]

effect: write · external: none · output: Human-readable text; –json emits one JSON object.

Example:

Terminal window
gigai record native update --id rec-1 --parent-revision rev-1 --content-file content.json --operation-key op-1

Read one private record revision.

gigai record read [OPTIONS]

effect: read · external: none · output: Human-readable text; –json emits one JSON object.

Example:

Terminal window
gigai record read --id rec-1

Import a file as a private reference (resume, project evidence, role history, cover letter).

gigai reference add [OPTIONS]

effect: write · external: none · output: Human-readable text; –json emits one JSON object.

Example:

Terminal window
gigai reference add --kind resume --file resume.md

List imported private references (metadata only).

gigai reference list [OPTIONS]

effect: read · external: none · output: Human-readable text; –json emits one JSON object.

Example:

Terminal window
gigai reference list

Show one imported private reference.

gigai reference show [OPTIONS] REFERENCE_ID

effect: read · external: none · output: Human-readable text; –json emits one JSON object.

Example:

Terminal window
gigai reference show ref-1

Reject one pending proposal without creating an executable Gig version.

gigai reject [OPTIONS] PROPOSAL_ID

effect: write · external: none · output: Human-readable text.

Example:

Terminal window
gigai reject prop-1 --reason "not needed"

Produce a new validated proposal linked to a prior pending proposal.

gigai revise [OPTIONS] PROPOSAL_ID

effect: write · external: none · output: Human-readable text; –json emits one JSON object.

Example:

Terminal window
gigai revise prop-1 --change "shorter summary"

Run one approved Gig through its deterministic local capability.

gigai run [OPTIONS] [GIG_ID]

effect: write · external: model · output: Human-readable text; –json emits one JSON object.

Example:

Terminal window
gigai run scout --confirm

Local and deterministic by default. –execute-review runs the sealed provider-backed review participants (external=model). Needs –confirm.

Read durable state for one Run without starting work.

gigai run-details [OPTIONS] RUN_ID

effect: read · external: none · output: Human-readable text; –json emits one JSON object.

Example:

Terminal window
gigai run-details run-1

Store a run input (for example a pasted job description) as a private record.

gigai run-input add [OPTIONS]

effect: write · external: none · output: Human-readable text; –json emits one JSON object.

Example:

Terminal window
gigai run-input add --file job.txt

Show one stored run input.

gigai run-input show [OPTIONS] RUN_INPUT_ID

effect: read · external: none · output: Human-readable text; –json emits one JSON object.

Example:

Terminal window
gigai run-input show ri-1

Directly approve one frozen requirements baseline; never seals a Run Plan.

gigai run-plan approve-baseline [OPTIONS]

effect: write · external: none · output: Human-readable text; –json emits one JSON object.

Example:

Terminal window
gigai run-plan approve-baseline --input baseline.json --confirm

Seal one immutable Run Plan; never allocates a Run.

gigai run-plan create [OPTIONS]

effect: write · external: none · output: Human-readable text; –json emits one JSON object.

Example:

Terminal window
gigai run-plan create --version 1

List sealed Run Plans.

gigai run-plan list [OPTIONS]

effect: read · external: none · output: Human-readable text; –json emits one JSON object.

Example:

Terminal window
gigai run-plan list

Show one sealed Run Plan.

gigai run-plan show [OPTIONS] RUN_PLAN_ID

effect: read · external: none · output: Human-readable text; –json emits one JSON object.

Example:

Terminal window
gigai run-plan show plan-1

Persist one bounded batch of caller-supplied public rows.

gigai scout-acquisition import [OPTIONS]

effect: write · external: none · output: Human-readable text; –json emits one JSON object.

Also registered as: gigai scout-import import

Example:

Terminal window
gigai scout-acquisition import --batch-id b1 --rows-file rows.json --gig scout

Resume the exact committed input snapshot for a partial batch.

gigai scout-acquisition resume [OPTIONS]

effect: write · external: none · output: Human-readable text; –json emits one JSON object.

Also registered as: gigai scout-import resume

Example:

Terminal window
gigai scout-acquisition resume --batch-id b1 --gig scout

Read one journal-authenticated batch and its cumulative outcome ledger.

gigai scout-acquisition status [OPTIONS]

effect: read · external: none · output: Human-readable text; –json emits one JSON object.

Also registered as: gigai scout-import status

Example:

Terminal window
gigai scout-acquisition status --batch-id b1 --gig scout

Append one answered question to an existing native experience record (needs –confirm).

gigai scout-answer save [OPTIONS]

effect: write · external: none · output: Human-readable text; –json emits one JSON object.

Example:

Terminal window
gigai scout-answer save --record-id rec-1 --parent-revision rev-1 --question-id q-1 --answer-file a.json --operation-key op-1 --confirm --gig scout

Persist a final document selection after authenticating its completed Tailor Run (needs –confirm).

gigai scout-documents final-select [OPTIONS]

effect: write · external: none · output: Human-readable text; –json emits one JSON object.

Example:

Terminal window
gigai scout-documents final-select --document doc-1 --run-id run-1 --goal-id g-1 --invocation-id inv-1 --output-sha256 abc123 --operation-key op-1 --confirm --gig scout

Read one authenticated immutable final selection.

gigai scout-documents read-selection [OPTIONS]

effect: read · external: none · output: Human-readable text; –json emits one JSON object.

Example:

Terminal window
gigai scout-documents read-selection --opportunity opp-1 --snapshot snap-1 --gig scout

Alias of scout-acquisition import.

gigai scout-import import [OPTIONS]

effect: write · external: none · output: Human-readable text; –json emits one JSON object.

Also registered as: gigai scout-acquisition import

Example:

Terminal window
gigai scout-import import --batch-id b1 --gig scout

Alias of scout-acquisition resume.

gigai scout-import resume [OPTIONS]

effect: write · external: none · output: Human-readable text; –json emits one JSON object.

Also registered as: gigai scout-acquisition resume

Example:

Terminal window
gigai scout-import resume --batch-id b1 --gig scout

Alias of scout-acquisition status.

gigai scout-import status [OPTIONS]

effect: read · external: none · output: Human-readable text; –json emits one JSON object.

Also registered as: gigai scout-acquisition status

Example:

Terminal window
gigai scout-import status --batch-id b1 --gig scout

Save user practice feedback as a new immutable revision.

gigai scout-interview feedback [OPTIONS]

effect: write · external: none · output: Human-readable text; –json emits one JSON object.

Example:

Terminal window
gigai scout-interview feedback --record-id rec-1 --parent-revision rev-1 --feedback-file f.json --operation-key op-1 --home ~/.gigai --gig scout

List interview preparation metadata without private content.

gigai scout-interview list [OPTIONS]

effect: read · external: none · output: Human-readable text; –json emits one JSON object.

Example:

Terminal window
gigai scout-interview list --home ~/.gigai --gig scout

Create interview preparation, or execute it through the approved prepare-interview Graph.

gigai scout-interview prepare [OPTIONS]

effect: write · external: model · output: Human-readable text; –json emits one JSON object.

Example:

Terminal window
gigai scout-interview prepare --selection-file sel.json --content-file c.json --operation-key op-1 --home ~/.gigai --gig scout

Without –run it only stores the supplied content. –run –confirm executes the Graph (external=model).

Read one committed interview preparation revision.

gigai scout-interview read [OPTIONS]

effect: read · external: none · output: Human-readable text; –json emits one JSON object.

Example:

Terminal window
gigai scout-interview read --record-id rec-1 --home ~/.gigai --gig scout

Append revised interview preparation content after a fresh session.

gigai scout-interview revise [OPTIONS]

effect: write · external: none · output: Human-readable text; –json emits one JSON object.

Example:

Terminal window
gigai scout-interview revise --record-id rec-1 --parent-revision rev-1 --content-file c.json --operation-key op-1 --home ~/.gigai --gig scout

Generate a complete atomic report bundle from committed history.

gigai scout-report generate [OPTIONS]

effect: write · external: none · output: Human-readable text; –json emits one JSON object.

Example:

Terminal window
gigai scout-report generate --gig scout

Inspect the selected report and whether its journal cursor is stale.

gigai scout-report status [OPTIONS]

effect: read · external: none · output: Human-readable text; –json emits one JSON object.

Example:

Terminal window
gigai scout-report status --gig scout

Back up a workpad’s private records into an archive (needs –confirm).

gigai scout-transfer backup-private [OPTIONS]

effect: write · external: none · output: Human-readable text; –json emits one JSON object.

Example:

Terminal window
gigai scout-transfer backup-private --workpad wp --archive backup.tar --confirm

Writes private content; keep the archive private.

Export a workpad’s shareable definition (no private records) to an archive.

gigai scout-transfer export-definition [OPTIONS]

effect: write · external: none · output: Human-readable text; –json emits one JSON object.

Example:

Terminal window
gigai scout-transfer export-definition --workpad wp --archive def.tar

Import a definition archive into a destination.

gigai scout-transfer import-definition [OPTIONS]

effect: write · external: none · output: Human-readable text; –json emits one JSON object.

Example:

Terminal window
gigai scout-transfer import-definition --archive def.tar --destination dest

Restore private records from a backup archive (needs –confirm).

gigai scout-transfer restore-private [OPTIONS]

effect: write · external: none · output: Human-readable text; –json emits one JSON object.

Example:

Terminal window
gigai scout-transfer restore-private --archive backup.tar --destination dest --confirm

Store a credential for a service (read from –stdin, never echoed).

gigai secrets add [OPTIONS] SERVICE

effect: write · external: none · output: Human-readable text; –json emits one JSON object.

Example:

Terminal window
gigai secrets add openai --stdin

Stores a secret in the local secret store.

List stored credential service names (never values).

gigai secrets list [OPTIONS]

effect: read · external: none · output: Human-readable text; –json emits one JSON object.

Example:

Terminal window
gigai secrets list

Remove the stored credential for a service.

gigai secrets rm [OPTIONS] SERVICE

effect: write · external: none · output: Human-readable text; –json emits one JSON object.

Example:

Terminal window
gigai secrets rm openai

Run terminal setup, or update configuration non-interactively.

gigai setup [OPTIONS]

effect: write · external: none · output: Human-readable text; –json emits one JSON object.

Example:

Terminal window
gigai setup --non-interactive --model-target ollama-local

Writes GigAI settings under the home directory.

Show the canonical projection for one explicit or active Gig.

gigai show [OPTIONS] [GIG_ID]

effect: read · external: none · output: Human-readable text; –json emits one JSON object.

Example:

Terminal window
gigai show scout

Report the explicit proposal and active-version state for one Gig.

gigai status [OPTIONS] [GIG_ID]

effect: read · external: none · output: Human-readable text; –json emits one JSON object.

Example:

Terminal window
gigai status scout

Generate explicitly requested private documents; never applies or submits.

gigai tailor [OPTIONS] [GIG_ID]

effect: write · external: model · output: Human-readable text; –json emits one JSON object.

Example:

Terminal window
gigai tailor scout --model-target ollama-local --posting-selector post-1 --private-selector rev-1 --confirm

Calls the named local Ollama target; needs –confirm.

Migrate a supported v0.1.6 installation and project boundary.

gigai upgrade [OPTIONS]

effect: write · external: none · output: Human-readable text; –json emits one JSON object.

Example:

Terminal window
gigai upgrade --confirm

Print the canonical path of one already-registered Gig workpad.

gigai workpad path [OPTIONS] [GIG_ID]

effect: read · external: none · output: Human-readable text.

Example:

Terminal window
gigai workpad path scout