ait plan — 完整参考
记录 Markdown Plan 沿革,查看修订版本,并在选定范围内同步确切的原始 Markdown。
适用人群: coding agent 与维护者
作用边界#
用途: 记录 Markdown Plan 沿革,查看修订版本,并在选定范围内同步确切的原始 Markdown。
影响类别: 读取与 Plan 写入混合的入口;sync 的范围在给出的选项里是明确的。
覆盖: ait plan 下共 8 个公开 help surface。
下面的代码块原样保留 1.1.1 二进制的输出,包含它给出的每一个参数、选项、 默认值、可选值、冲突关系和必填要求。
完整命令树#
ait plan
ait plan list
ait plan show
ait plan revisions
ait plan items
ait plan candidates
ait plan inspect
ait plan sync原样输出的 help#
ait plan#
二进制描述: Inspect, select, and sync Plan revision history. Without --local or --remote, solo_local uses local Plans and solo_remote uses the configured default remote. Either flag explicitly overrides that default. Remote sync updates local Plan history before publishing; no Plan command creates a Snapshot or advances a Line.
Inspect, select, and sync Plan revision history. Without --local or --remote, solo_local uses local Plans and solo_remote uses the configured default remote. Either flag explicitly overrides that default. Remote sync updates local Plan history before publishing; no Plan command creates a Snapshot or advances a Line.
Usage: ait plan <COMMAND>
Commands:
list List local Plans or Plans from a remote.
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 Sync file-backed Markdown into Plan revision history using the workflow mode's local or remote default. solo_local saves local Plan changes; solo_remote updates local Plan history and publishes the changed heads to the configured default remote. --local or --remote overrides that default. 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')说明
查看、选择并同步 Plan 修订历史。未给 --local 或 --remote 时,solo_local 使用本地 Plan,solo_remote 使用配置的默认远程;任一 flag 都会显式覆盖默认值。远程同步先更新本地 Plan 历史再发布;任何 Plan 命令都不会创建 Snapshot 或推进 Line。
| 参数 / 选项 | 说明 |
|---|---|
list | 列出本地 Plan 或远程 Plan。 |
show | 显示一个 Plan 及其选定修订版。 |
revisions | 列出一个 Plan 的修订历史。 |
items | 列出一个 Plan 修订版中的清单条目。 |
candidates | 查找能提供 Task 候选的活动 Plan。 |
inspect | 查看一个 Plan 修订版的 Task 就绪详情。 |
sync | 按工作流模式的本地或远程默认值,把文件承载的 Markdown 同步到 Plan 修订历史。solo_local 保存本地 Plan 改动;solo_remote 更新本地 Plan 历史,并把改动的 head 发布到配置的默认远程。--local 或 --remote 覆盖该默认值。Plan sync 绝不创建 Snapshot 或推进 Line。 |
help | 打印本消息或给定子命令的帮助 |
ait plan list#
二进制描述: List Plans locally, from --remote, or from the location selected by the workflow mode. Human output is bounded to active Plans unless --all is supplied; JSON always returns the complete command result and therefore rejects --all. This command is read-only.
List Plans locally, from --remote, or from the location selected by the workflow mode. Human output is bounded to active Plans unless --all is supplied; JSON always returns the complete command result and therefore rejects --all. This command is read-only.
Usage: ait plan list [OPTIONS]
Options:
--local
Use local Plans even when the workflow mode defaults to a remote
--remote <NAME>
Use Plans from the named remote even when the workflow mode defaults to local
--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')说明
列出本地、--remote 指定远程或工作流模式所选位置的 Plan。除非提供 --all,人类可读输出只包含活动 Plan;JSON 始终返回完整命令结果,因此拒绝 --all。此命令为只读。
ait plan show#
二进制描述: Show one Plan locally, from --remote, or from the location selected by the workflow mode. Without --revision, show the current head revision. Local 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.
Show one Plan locally, from --remote, or from the location selected by the workflow mode. Without --revision, show the current head revision. Local 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 Plans even when the workflow mode defaults to a remote
--remote <NAME>
Use Plans from the named remote even when the workflow mode defaults to local
--json
Emit the complete stable machine-readable payload
-h, --help
Print help (see a summary with '-h')说明
显示本地、--remote 指定远程或工作流模式所选位置的一个 Plan。未给 --revision 时显示当前 head 修订。本地选择器包括 PR-<ordinal>、artifact:<path>、title:<title> 和 published-plan:<index>;远程选择器是 remote plan list 返回的标识符。此命令为只读。
ait plan revisions#
二进制描述: List one Plan's revisions newest first, using local data, --remote, or the location selected by the workflow mode. Human output is bounded unless --all is supplied; JSON already returns the complete command result and therefore rejects --all. This command is read-only.
List one Plan's revisions newest first, using local data, --remote, or the location selected by the workflow mode. Human output is bounded unless --all is supplied; JSON already returns the complete command result 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 Plans even when the workflow mode defaults to a remote
--remote <NAME>
Use Plans from the named remote even when the workflow mode defaults to local
--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')说明
按从新到旧列出一个 Plan 的修订,数据来自本地、--remote 或工作流模式选择的位置。除非提供 --all,人类可读输出有界;JSON 已返回完整命令结果,因此拒绝 --all。此命令为只读。
ait plan items#
二进制描述: List parsed checklist items from one local or remote Plan. Without --revision, inspect the current head. This command is read-only and does not change item or Task state.
List parsed checklist items from one local or remote Plan. 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 Plans even when the workflow mode defaults to a remote
--remote <NAME>
Use Plans from the named remote even when the workflow mode defaults to local
--json
Emit the complete stable machine-readable payload
-h, --help
Print help (see a summary with '-h')说明
列出一个本地或远程 Plan 中解析出的 checklist 条目。未给 --revision 时查看当前 head。此命令为只读,不改变条目或 Task 状态。
ait plan candidates#
二进制描述: Find active local or remote Plans, 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, file paths and selectors, headings, and item text or refs. This command is read-only.
Find active local or remote Plans, 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, file paths and selectors, headings, and item text or refs. This command is read-only.
Usage: ait plan candidates [OPTIONS]
Options:
--local
Use local Plans even when the workflow mode defaults to a remote
--remote <NAME>
Use Plans from the named remote even when the workflow mode defaults to local
--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')说明
查找活动的本地或远程 Plan,并按 Task 选择顺序排列。默认只返回至少有一个可开 Task 条目的 Plan;--all 也包含没有可开 Task 条目的活动 Plan。--contains 对 Plan 标题、文件路径与选择器、标题以及条目文本或 ref 做不区分大小写的 OR 匹配。此命令为只读。
ait plan inspect#
二进制描述: Inspect summary counts and per-item Task-readiness blockers for one local or remote Plan. Without --revision, inspect the current head. This command is read-only.
Inspect summary counts and per-item Task-readiness blockers for one local or remote Plan. 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 Plans even when the workflow mode defaults to a remote
--remote <NAME>
Use Plans from the named remote even when the workflow mode defaults to local
--json
Emit the complete stable machine-readable payload
-h, --help
Print help (see a summary with '-h')说明
查看一个本地或远程 Plan 的摘要计数和逐条 Task 就绪阻塞项。未给 --revision 时查看当前 head。此命令为只读。
ait plan sync#
二进制描述: Sync file-backed Markdown into Plan revision history using the workflow mode's local or remote default. solo_local saves local Plan changes; solo_remote updates local Plan history and publishes the changed heads to the configured default remote. --local or --remote overrides that default. Plan sync never creates a Snapshot or advances a Line.
Sync file-backed Markdown into Plan revision history using the workflow mode's local or remote default. solo_local saves local Plan changes; solo_remote updates local Plan history and publishes the changed heads to the configured default remote. --local or --remote overrides that default. 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 sync into local Plan revision history
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
Sync local Plan history only, even when the workflow mode defaults to a remote; never create a Snapshot or advance a Line
--remote <NAME>
Sync local Plan history, then publish the updated heads to the named remote even when the workflow mode defaults to local
--rebase
When using a remote, replay the current local Plan head after the remote rejects divergent history
--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')说明
按工作流模式的本地或远程默认值,把文件承载的 Markdown 同步到 Plan 修订历史。solo_local 保存本地 Plan 改动;solo_remote 更新本地 Plan 历史,并把改动的 head 发布到配置的默认远程。--local 或 --remote 覆盖该默认值。Plan sync 绝不创建 Snapshot 或推进 Line。