Browse RC.8 documentation
RC.8 Documentation revision 1

ait plan — Complete Reference

Record Markdown Plan lineage, inspect revisions, and synchronize exact authored Markdown in the selected scope.

Audience: Coding agents and maintainers

Operating boundary#

Purpose: Record Markdown Plan lineage, inspect revisions, and synchronize exact authored Markdown in the selected scope.

Effect class: Mixed read and Plan mutation surface; sync scope is explicit in the emitted options.

Coverage: 8 public help surfaces under ait plan.

The blocks below preserve the RC.8 binary output in full, including every emitted argument, option, default, possible value, conflict, and requirement.

Complete command tree#

Code · text
ait plan
ait plan list
ait plan show
ait plan revisions
ait plan items
ait plan candidates
ait plan inspect
ait plan sync

Exact emitted help#

ait plan#

Binary description: Inspect, select, and reconcile Plan revision lineage. With no scope flag, solo_local uses local authority and solo_remote uses the configured default remote. --local and --remote are explicit cross-mode compatibility overrides. Remote sync always reconciles local Plan lineage before publishing; no Plan command creates a Snapshot or advances a Line.

Code · text
Inspect, select, and reconcile Plan revision lineage. With no scope flag, solo_local uses local authority and solo_remote uses the configured default remote. --local and --remote are explicit cross-mode compatibility overrides. Remote sync always reconciles local Plan lineage before publishing; no Plan command creates a Snapshot or advances a Line.

Usage: ait plan <COMMAND>

Commands:
  list        List Plans in the effective local or remote scope.
  show        Show one Plan and its selected revision.
  revisions   List revision history for one Plan.
  items       List checklist items from one Plan revision.
  candidates  Find active Plans that can supply Task candidates.
  inspect     Inspect Task-readiness details for one Plan revision.
  sync        Reconcile file-backed Markdown into Plan revision lineage using workflow-mode scope defaults. solo_local writes local Plan state; solo_remote reconciles local Plan lineage and publishes the touched heads to the configured default remote. --local or --remote overrides the configured scope. Plan sync never creates a Snapshot or advances a Line.
  help        Print this message or the help of the given subcommand(s)

Options:
  -h, --help
          Print help (see a summary with '-h')

ait plan list#

Binary description: List Plans from the scope selected by --local, --remote, or the workflow-mode default. Human output is bounded to active Plans unless --all is supplied; JSON always returns the complete command payload and therefore rejects --all. This command is read-only.

Code · text
List Plans from the scope selected by --local, --remote, or the workflow-mode default. Human output is bounded to active Plans unless --all is supplied; JSON always returns the complete command payload and therefore rejects --all. This command is read-only.

Usage: ait plan list [OPTIONS]

Options:
      --local
          Use local Plan authority, overriding a remote workflow default

      --remote <NAME>
          Use the named remote Plan authority, overriding a local workflow default

      --json
          Emit the complete stable machine-readable payload

      --all
          Expand human output to include archived Plans; unavailable with --json

  -h, --help
          Print help (see a summary with '-h')

ait plan show#

Binary description: Show one Plan from the effective local or remote scope. Without --revision, show the current head revision. Local canonical selectors include PR-<ordinal>, artifact:<path>, title:<title>, and published-plan:<index>; remote selectors are the identifiers returned by remote plan list. This command is read-only.

Code · text
Show one Plan from the effective local or remote scope. Without --revision, show the current head revision. Local canonical selectors include PR-<ordinal>, artifact:<path>, title:<title>, and published-plan:<index>; remote selectors are the identifiers returned by remote plan list. This command is read-only.

Usage: ait plan show [OPTIONS] <PLAN>

Arguments:
  <PLAN>
          Plan selector; local canonical forms are PR-<ordinal>, artifact:<path>, title:<title>, or published-plan:<index>

Options:
      --revision <REVISION>
          Select a non-head revision; local canonical forms are plan-revision:<index>, revision-number:<number>, or published-revision:<index>

      --local
          Use local Plan authority, overriding a remote workflow default

      --remote <NAME>
          Use the named remote Plan authority, overriding a local workflow default

      --json
          Emit the complete stable machine-readable payload

  -h, --help
          Print help (see a summary with '-h')

ait plan revisions#

Binary description: List one Plan's revisions newest first from the effective local or remote scope. Human output is bounded unless --all is supplied; JSON already returns the complete command payload and therefore rejects --all. This command is read-only.

Code · text
List one Plan's revisions newest first from the effective local or remote scope. Human output is bounded unless --all is supplied; JSON already returns the complete command payload and therefore rejects --all. This command is read-only.

Usage: ait plan revisions [OPTIONS] <PLAN>

Arguments:
  <PLAN>
          Plan selector; local canonical forms are PR-<ordinal>, artifact:<path>, title:<title>, or published-plan:<index>

Options:
      --local
          Use local Plan authority, overriding a remote workflow default

      --remote <NAME>
          Use the named remote Plan authority, overriding a local workflow default

      --json
          Emit the complete stable machine-readable payload

      --all
          Expand human output to the complete revision history; unavailable with --json

  -h, --help
          Print help (see a summary with '-h')

ait plan items#

Binary description: List parsed checklist items from one Plan in the effective local or remote scope. Without --revision, inspect the current head. This command is read-only and does not change item or Task state.

Code · text
List parsed checklist items from one Plan in the effective local or remote scope. Without --revision, inspect the current head. This command is read-only and does not change item or Task state.

Usage: ait plan items [OPTIONS] <PLAN>

Arguments:
  <PLAN>
          Plan selector; local canonical forms are PR-<ordinal>, artifact:<path>, title:<title>, or published-plan:<index>

Options:
      --revision <REVISION>
          Select a non-head revision; local canonical forms are plan-revision:<index>, revision-number:<number>, or published-revision:<index>

      --local
          Use local Plan authority, overriding a remote workflow default

      --remote <NAME>
          Use the named remote Plan authority, overriding a local workflow default

      --json
          Emit the complete stable machine-readable payload

  -h, --help
          Print help (see a summary with '-h')

ait plan candidates#

Binary description: Find active Plans in the effective local or remote scope, ordered for Task selection. By default only Plans with at least one taskable item are returned; --all also includes active Plans with zero taskable items. --contains applies case-insensitive OR matching across Plan titles, artifact paths and selectors, headings, and item text or refs. This command is read-only.

Code · text
Find active Plans in the effective local or remote scope, ordered for Task selection. By default only Plans with at least one taskable item are returned; --all also includes active Plans with zero taskable items. --contains applies case-insensitive OR matching across Plan titles, artifact paths and selectors, headings, and item text or refs. This command is read-only.

Usage: ait plan candidates [OPTIONS]

Options:
      --local
          Use local Plan authority, overriding a remote workflow default

      --remote <NAME>
          Use the named remote Plan authority, overriding a local workflow default

      --all
          Also include active Plans with zero taskable items; archived Plans remain excluded

      --contains <TERMS>
          Case-insensitive comma-delimited OR search across titles, paths, selectors, headings, item text, and item refs

      --json
          Emit the complete stable machine-readable payload

  -h, --help
          Print help (see a summary with '-h')

ait plan inspect#

Binary description: Inspect summary counts and per-item Task-readiness blockers for one Plan in the effective local or remote scope. Without --revision, inspect the current head. This command is read-only.

Code · text
Inspect summary counts and per-item Task-readiness blockers for one Plan in the effective local or remote scope. Without --revision, inspect the current head. This command is read-only.

Usage: ait plan inspect [OPTIONS] <PLAN>

Arguments:
  <PLAN>
          Plan selector; local canonical forms are PR-<ordinal>, artifact:<path>, title:<title>, or published-plan:<index>

Options:
      --revision <REVISION>
          Select a non-head revision; local canonical forms are plan-revision:<index>, revision-number:<number>, or published-revision:<index>

      --local
          Use local Plan authority, overriding a remote workflow default

      --remote <NAME>
          Use the named remote Plan authority, overriding a local workflow default

      --json
          Emit the complete stable machine-readable payload

  -h, --help
          Print help (see a summary with '-h')

ait plan sync#

Binary description: Reconcile file-backed Markdown into Plan revision lineage using workflow-mode scope defaults. solo_local writes local Plan state; solo_remote reconciles local Plan lineage and publishes the touched heads to the configured default remote. --local or --remote overrides the configured scope. Plan sync never creates a Snapshot or advances a Line.

Code · text
Reconcile file-backed Markdown into Plan revision lineage using workflow-mode scope defaults. solo_local writes local Plan state; solo_remote reconciles local Plan lineage and publishes the touched heads to the configured default remote. --local or --remote overrides the configured scope. Plan sync never creates a Snapshot or advances a Line.

Usage: ait plan sync [OPTIONS] <TARGET>

Arguments:
  <TARGET>
          Repository-relative Markdown file or directory to reconcile into local Plan revision lineage

Options:
      --plan-ref <PLAN_REF>
          Select one exact [plan-ref: ...] root when one Markdown target contains multiple Plan roots

      --prune
          Archive tracked Plan artifacts missing from the complete selected target inventory

      --local
          Reconcile local Plan lineage only, overriding a remote workflow default; never create a Snapshot or advance a Line

      --remote <NAME>
          Reconcile local Plan lineage, then publish the touched heads to the named remote, overriding a local workflow default

      --rebase
          In effective remote scope, replay the current local Plan head after a divergent remote-head rejection

      --reconcile
          Safely adopt verified divergent or mixed Plan identity before effective local reconciliation or remote publication

      --json
          Emit the complete stable machine-readable result; failed and partial-success results still exit nonzero

  -h, --help
          Print help (see a summary with '-h')

Version authority

Checked against the exact RC.8 source

This page is public documentation, not a second product contract. Use the exact source and distribution contract for release authority.

Owning component Snapshots
  • ait-coreSNP-F136DB9A342B
  • ait-serverSNP-FBF302ADABC5
  • ait-runnerSNP-DF67532B0360
  • ait-pythonSNP-39225802847F
  • ait-nodeSNP-3D474B60B26F