@open-agent-toolkit/cli 0.1.22 → 0.1.23
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/assets/docs/cli-utilities/index.md +26 -4
- package/assets/docs/contributing/documentation.md +3 -1
- package/assets/docs/contributing/markdown-features.md +2 -0
- package/assets/docs/docs-tooling/commands.md +12 -1
- package/assets/docs/docs-tooling/index.md +9 -3
- package/assets/docs/guide/index.md +8 -0
- package/assets/docs/index.md +2 -0
- package/assets/docs/provider-sync/index.md +26 -2
- package/assets/docs/reference/cli-reference.md +27 -12
- package/assets/docs/reference/docs-index-contract.md +23 -11
- package/assets/docs/workflows/index.md +30 -3
- package/assets/docs/workflows/projects/index.md +14 -0
- package/assets/public-package-versions.json +4 -4
- package/package.json +2 -2
- package/assets/docs/cli-utilities/overview.md +0 -33
- package/assets/docs/docs-tooling/overview.md +0 -31
- package/assets/docs/provider-sync/overview.md +0 -38
- package/assets/docs/workflows/overview.md +0 -38
|
@@ -7,23 +7,46 @@ description: Standalone adoption lane for general OAT CLI surfaces outside provi
|
|
|
7
7
|
|
|
8
8
|
CLI Utilities is the OAT lane for the useful command surface that does not primarily belong to Provider Sync, Docs Tooling, or tracked workflow lifecycle execution.
|
|
9
9
|
|
|
10
|
-
Use this section when you want bootstrap guidance, tool-pack lifecycle details, configuration help, and general-purpose command references.
|
|
10
|
+
Use this section when you want bootstrap guidance, tool-pack lifecycle details, configuration help, and general-purpose command references. It covers general-purpose setup, configuration, pack-management, and diagnostic utilities that support the rest of the toolkit without being specific to provider sync, docs tooling, or tracked workflow execution.
|
|
11
11
|
|
|
12
|
-
##
|
|
12
|
+
## Contents
|
|
13
|
+
|
|
14
|
+
- [CLI Bootstrap](bootstrap.md) - Foundational `oat init` guidance outside provider-sync-specific onboarding.
|
|
15
|
+
- [Tool Packs and Installed Assets](tool-packs.md) - Bundled packs and `oat tools` lifecycle commands.
|
|
16
|
+
- [Configuration](configuration.md) - OAT configuration guidance across shared, local, user, and provider-sync surfaces.
|
|
17
|
+
- [Config and Local State](config-and-local-state.md) - Utility command groups for config, local state, diagnostics, and related inspection flows.
|
|
18
|
+
|
|
19
|
+
## What Lives Here
|
|
13
20
|
|
|
14
21
|
This section collects the command groups that help you initialize OAT, manage installed packs, inspect local or config state, and use the wider CLI without implying that you are adopting provider sync or tracked workflows.
|
|
15
22
|
|
|
23
|
+
Examples include:
|
|
24
|
+
|
|
25
|
+
- bootstrap and setup flows such as `oat init`
|
|
26
|
+
- bundled pack management through `oat tools`
|
|
27
|
+
- general configuration guidance
|
|
28
|
+
- utility command groups for config, local state, diagnostics, and related inspection flows
|
|
29
|
+
|
|
16
30
|
## Who It's For
|
|
17
31
|
|
|
18
32
|
- Users getting OAT set up in a repo
|
|
19
33
|
- Teams managing installed tool packs and local config
|
|
20
34
|
- People who need a general command map without diving into workflow lifecycle docs
|
|
21
35
|
|
|
36
|
+
## When To Use This Section
|
|
37
|
+
|
|
38
|
+
Use CLI Utilities when:
|
|
39
|
+
|
|
40
|
+
- you are first setting up OAT in a repo
|
|
41
|
+
- you need to install or update OAT packs
|
|
42
|
+
- you are looking for configuration or local-state inspection help
|
|
43
|
+
- you need the general CLI surface without committing to one of the deeper lanes yet
|
|
44
|
+
|
|
22
45
|
## Start Here
|
|
23
46
|
|
|
24
|
-
- Read [Overview](overview.md) to see what command groups live here and how this section relates to the other adoption lanes.
|
|
25
47
|
- Use [CLI Bootstrap](bootstrap.md) when you are starting with `oat init`.
|
|
26
48
|
- Go to [Tool Packs](tool-packs.md) when you are managing bundled OAT packs and installed assets.
|
|
49
|
+
- Read [Configuration](configuration.md) for config semantics, or [Config and Local State](config-and-local-state.md) for inspection and diagnostic command groups.
|
|
27
50
|
|
|
28
51
|
## Common Tasks
|
|
29
52
|
|
|
@@ -34,7 +57,6 @@ This section collects the command groups that help you initialize OAT, manage in
|
|
|
34
57
|
|
|
35
58
|
## Go Deeper
|
|
36
59
|
|
|
37
|
-
- [Overview](overview.md) - What belongs in CLI Utilities and when to use this section.
|
|
38
60
|
- [CLI Bootstrap](bootstrap.md) - Foundational `oat init` guidance outside provider-sync-specific onboarding.
|
|
39
61
|
- [Tool Packs](tool-packs.md) - Bundled packs and `oat tools` lifecycle commands.
|
|
40
62
|
- [Configuration](configuration.md) - OAT configuration guidance.
|
|
@@ -13,6 +13,7 @@ Documentation should ship with the code it explains. This page covers the core d
|
|
|
13
13
|
- Each `index.md` must include a `## Contents` section.
|
|
14
14
|
- The `## Contents` section is the machine-readable local map for sibling pages and child directories.
|
|
15
15
|
- Use `.md`-suffixed relative links in `## Contents`: `[Page](page.md)` for leaf pages and `[Section](subdir/index.md)` for child directories.
|
|
16
|
+
- Fumadocs and MkDocs share this authored contract, but they regenerate different artifacts.
|
|
16
17
|
|
|
17
18
|
## Local workflow
|
|
18
19
|
|
|
@@ -55,12 +56,13 @@ Documentation should ship with the code it explains. This page covers the core d
|
|
|
55
56
|
- Use `oat-docs-authoring` for targeted OAT/Fumadocs docs edits; it delegates
|
|
56
57
|
universal page-quality guidance to `authoring-docs` and keeps local
|
|
57
58
|
navigation, generated-index, and validation expectations in scope.
|
|
58
|
-
- When you add, remove, or rename docs pages, refresh the generated Fumadocs root index. It is a generated file-tree manifest that should be checked against authored `docs/**/index.md` maps, not hand-edited:
|
|
59
|
+
- When you add, remove, or rename docs pages in this Fumadocs app, refresh the generated Fumadocs root index. It is a generated file-tree manifest that should be checked against authored `docs/**/index.md` maps, not hand-edited:
|
|
59
60
|
|
|
60
61
|
```bash
|
|
61
62
|
pnpm -w run cli -- docs generate-index --docs-dir apps/oat-docs/docs --output apps/oat-docs/index.md
|
|
62
63
|
```
|
|
63
64
|
|
|
65
|
+
- In MkDocs apps, use `oat docs nav sync` to refresh `mkdocs.yml` instead. Do not use MkDocs nav sync as the Fumadocs regeneration step.
|
|
64
66
|
- Use [Markdown Features](markdown-features.md) for supported syntax and examples.
|
|
65
67
|
|
|
66
68
|
## Agent guidance
|
|
@@ -92,6 +92,8 @@ Tab groups use the existing tab transform syntax:
|
|
|
92
92
|
|
|
93
93
|
Standard fenced code blocks support syntax highlighting and optional file-title metadata.
|
|
94
94
|
|
|
95
|
+
Use a language identifier on every opening fence. In this docs app, use `bash` for shell commands because the existing examples and repo scripts are Bash-oriented; use `sh` only when the command is intentionally POSIX-shell-specific.
|
|
96
|
+
|
|
95
97
|
=== "Syntax"
|
|
96
98
|
|
|
97
99
|
````text
|
|
@@ -26,6 +26,15 @@ and **MkDocs Material**.
|
|
|
26
26
|
| `oat docs analyze` | CLI entrypoint that points users to the `oat-docs-analyze` skill. |
|
|
27
27
|
| `oat docs apply` | CLI entrypoint that points users to the `oat-docs-apply` skill. |
|
|
28
28
|
|
|
29
|
+
## Which Generation Command To Run
|
|
30
|
+
|
|
31
|
+
Use the framework-specific generated-artifact command:
|
|
32
|
+
|
|
33
|
+
- Fumadocs apps run `fumadocs-mdx` and `oat docs generate-index`. In this repo, `predev` and `prebuild` regenerate `apps/oat-docs/index.md` from `apps/oat-docs/docs`.
|
|
34
|
+
- MkDocs apps use `oat docs nav sync` to regenerate the `nav:` block in `mkdocs.yml` from authored directory `index.md` `## Contents` sections.
|
|
35
|
+
|
|
36
|
+
Both frameworks keep authored `## Contents` sections as the source of local discovery. The generated artifact differs by framework.
|
|
37
|
+
|
|
29
38
|
## `oat docs init`
|
|
30
39
|
|
|
31
40
|
Use `oat docs init` to scaffold a docs app that follows the OAT docs contract.
|
|
@@ -141,11 +150,13 @@ script hooks.
|
|
|
141
150
|
|
|
142
151
|
## `oat docs nav sync`
|
|
143
152
|
|
|
144
|
-
Use nav sync
|
|
153
|
+
Use nav sync in MkDocs apps after adding, removing, or renaming docs pages.
|
|
145
154
|
|
|
146
155
|
The command reads only the reserved `## Contents` section from each directory
|
|
147
156
|
`index.md` and regenerates the `nav:` block in `mkdocs.yml`.
|
|
148
157
|
|
|
158
|
+
For Fumadocs apps, regenerate the root markdown manifest with `oat docs generate-index` instead.
|
|
159
|
+
|
|
149
160
|
Example:
|
|
150
161
|
|
|
151
162
|
```bash
|
|
@@ -7,7 +7,13 @@ description: Standalone adoption lane for docs app setup, docs commands, and doc
|
|
|
7
7
|
|
|
8
8
|
Docs Tooling is the OAT lane for setting up, maintaining, and restructuring a documentation surface with OAT.
|
|
9
9
|
|
|
10
|
-
Use this section when you are adopting the docs app workflow in a repo, maintaining generated navigation, or using the analyze/apply docs workflows.
|
|
10
|
+
Use this section when you are adopting the docs app workflow in a repo, maintaining generated navigation, or using the analyze/apply docs workflows. OAT supports both Fumadocs and MkDocs: the site framework changes the surrounding app setup and generated artifacts, but the underlying documentation contract stays centered on `index.md` and `## Contents`.
|
|
11
|
+
|
|
12
|
+
## Contents
|
|
13
|
+
|
|
14
|
+
- [Add Docs to a New Repo](add-docs-to-a-repo.md) - Bootstrap a docs app and adopt the docs workflow in a repo.
|
|
15
|
+
- [Docs App Commands](commands.md) - Docs CLI surface for init, migration, index generation, and nav sync.
|
|
16
|
+
- [Docs Workflows](workflows.md) - How the docs CLI helpers pair with analyze/apply workflows.
|
|
11
17
|
|
|
12
18
|
## What This Section Is
|
|
13
19
|
|
|
@@ -21,9 +27,9 @@ This section explains how OAT supports docs surfaces, how the index contract wor
|
|
|
21
27
|
|
|
22
28
|
## Start Here
|
|
23
29
|
|
|
24
|
-
- Read [Overview](overview.md) for the docs-tooling model and where Fumadocs versus MkDocs matters.
|
|
25
30
|
- Use [Add Docs to a Repo](add-docs-to-a-repo.md) when you are bootstrapping a docs surface.
|
|
26
31
|
- Go to [Commands](commands.md) when you already have a docs app and need the CLI surface.
|
|
32
|
+
- Use [Workflows](workflows.md) when you want analysis-backed restructuring rather than ad hoc manual edits.
|
|
27
33
|
|
|
28
34
|
## Common Tasks
|
|
29
35
|
|
|
@@ -34,7 +40,7 @@ This section explains how OAT supports docs surfaces, how the index contract wor
|
|
|
34
40
|
|
|
35
41
|
## Go Deeper
|
|
36
42
|
|
|
37
|
-
- [Overview](overview.md) - What docs tooling is for and how the docs contract fits together.
|
|
38
43
|
- [Add Docs to a Repo](add-docs-to-a-repo.md) - Bootstrap a docs app and adopt the docs workflow in a repo.
|
|
39
44
|
- [Commands](commands.md) - Docs CLI surface for init, migration, index generation, and nav sync.
|
|
40
45
|
- [Workflows](workflows.md) - How the docs CLI helpers pair with analyze/apply workflows.
|
|
46
|
+
- [Docs Index Contract](../reference/docs-index-contract.md) - Framework-neutral `index.md` rules plus Fumadocs and MkDocs generation notes.
|
|
@@ -9,6 +9,14 @@ This page is now a compatibility router.
|
|
|
9
9
|
|
|
10
10
|
The old catch-all User Guide is being split into clearer adoption lanes so new users can choose the part of OAT that matches what they actually need.
|
|
11
11
|
|
|
12
|
+
## Contents
|
|
13
|
+
|
|
14
|
+
- [Core Concepts](concepts.md) - High-level mental model while concept material is being redistributed.
|
|
15
|
+
|
|
16
|
+
## Status
|
|
17
|
+
|
|
18
|
+
This guide bucket remains visible so older links have a stable landing page. New docs should go into the canonical top-level sections below instead of adding more pages under `guide/`.
|
|
19
|
+
|
|
12
20
|
## Canonical Sections
|
|
13
21
|
|
|
14
22
|
- [Provider Sync](../provider-sync/index.md) - Provider interoperability, drift, sync, and config behavior.
|
package/assets/docs/index.md
CHANGED
|
@@ -16,6 +16,7 @@ OAT is organized as three distinct capabilities that can be used together or ind
|
|
|
16
16
|
## Contents
|
|
17
17
|
|
|
18
18
|
- [Quickstart](quickstart.md) - Canonical Start Here page for choosing the right OAT adoption path.
|
|
19
|
+
- [User Guide](guide/index.md) - Legacy compatibility router for old guide links while content continues moving into the canonical sections below.
|
|
19
20
|
- [Provider Sync](provider-sync/index.md) - Canonical section for provider interoperability, drift management, and canonical-to-provider sync.
|
|
20
21
|
- [Agentic Workflows](workflows/index.md) - Canonical section for tracked project workflows, ideas, lifecycle execution, and workflow-oriented skills.
|
|
21
22
|
- [Docs Tooling](docs-tooling/index.md) - Canonical section for docs app setup, docs commands, and docs maintenance workflows.
|
|
@@ -54,6 +55,7 @@ That page is the canonical path-selection guide. Use it to choose whether you ne
|
|
|
54
55
|
## Where To Go Next
|
|
55
56
|
|
|
56
57
|
- New to OAT: [Quickstart](quickstart.md)
|
|
58
|
+
- Following an older guide link: [User Guide](guide/index.md)
|
|
57
59
|
- Need canonical-to-provider sync: [Provider Sync](provider-sync/index.md)
|
|
58
60
|
- Need tracked project execution: [Agentic Workflows](workflows/index.md)
|
|
59
61
|
- Need docs app or docs maintenance tooling: [Docs Tooling](docs-tooling/index.md)
|
|
@@ -9,21 +9,46 @@ Provider Sync is the OAT lane for keeping a canonical rules-and-skills layout in
|
|
|
9
9
|
|
|
10
10
|
You can adopt this layer on its own. It does not require tracked OAT projects, and it is the right starting point when you mainly want interoperability and drift control.
|
|
11
11
|
|
|
12
|
+
In practice, you edit the canonical layout in `.agents/` and `.oat/`, then let OAT generate or reconcile provider-specific views for Claude Code, Cursor, Copilot, Gemini, Codex, and other supported providers.
|
|
13
|
+
|
|
14
|
+
## Contents
|
|
15
|
+
|
|
16
|
+
- [Provider Interop Commands](commands.md) - `oat status`, `oat sync`, and `oat providers ...` behavior.
|
|
17
|
+
- [Sync Config](config.md) - Provider config model, enablement, and scope semantics.
|
|
18
|
+
- [Instruction Sync](instruction-sync.md) - Project-scoped `AGENTS.md` / `CLAUDE.md` validation, repair, and Claude-only adoption.
|
|
19
|
+
- [Manifest and Drift](manifest-and-drift.md) - How OAT tracks synced state, stray files, and adoption decisions.
|
|
20
|
+
- [Providers](providers.md) - Provider-specific mappings, capabilities, and path conventions.
|
|
21
|
+
- [Provider Interop CLI Scope and Surface](scope-and-surface.md) - Canonical assets, provider views, scopes, and the sync surface area.
|
|
22
|
+
|
|
12
23
|
## What This Section Is
|
|
13
24
|
|
|
14
25
|
This section explains how OAT treats `.agents/` and `.oat/` as the source of truth, how provider views are derived from those canonical assets, and how sync/adoption workflows keep everything aligned.
|
|
15
26
|
|
|
27
|
+
## What OAT Treats As Canonical
|
|
28
|
+
|
|
29
|
+
- canonical skills, agents, and rules under `.agents/`
|
|
30
|
+
- sync state and related metadata under `.oat/`
|
|
31
|
+
- provider-specific files as derived views unless they are explicitly adopted back into canonical form
|
|
32
|
+
|
|
16
33
|
## Who It's For
|
|
17
34
|
|
|
18
35
|
- Teams adopting OAT primarily for provider interoperability
|
|
19
36
|
- Users who want one canonical asset layout instead of hand-maintaining provider copies
|
|
20
37
|
- Repos that need drift detection, adoption flows, and explicit sync control
|
|
21
38
|
|
|
39
|
+
## Typical Flow
|
|
40
|
+
|
|
41
|
+
1. Run `oat init` to create the base OAT layout and setup state.
|
|
42
|
+
2. Inspect current sync state with `oat status`.
|
|
43
|
+
3. Adjust provider enablement with `oat providers ...` if needed.
|
|
44
|
+
4. Run `oat sync` to materialize provider views from canonical assets.
|
|
45
|
+
5. Re-run `oat status` after edits to confirm whether anything drifted or needs adoption.
|
|
46
|
+
|
|
22
47
|
## Start Here
|
|
23
48
|
|
|
24
|
-
- Read [Overview](overview.md) for the plain-language model and the first-sync flow.
|
|
25
49
|
- Use [CLI Bootstrap](../cli-utilities/bootstrap.md) when you are bootstrapping OAT and want the sync-relevant setup path.
|
|
26
50
|
- Go to [Commands](commands.md) once you are actively using `oat status`, `oat sync`, and `oat providers`.
|
|
51
|
+
- Read [Scope and Surface](scope-and-surface.md) when you need the canonical/provider-view mental model.
|
|
27
52
|
|
|
28
53
|
## Common Tasks
|
|
29
54
|
|
|
@@ -35,7 +60,6 @@ This section explains how OAT treats `.agents/` and `.oat/` as the source of tru
|
|
|
35
60
|
|
|
36
61
|
## Go Deeper
|
|
37
62
|
|
|
38
|
-
- [Overview](overview.md) - What provider sync is, when to use it, and what a typical sync loop looks like.
|
|
39
63
|
- [CLI Bootstrap](../cli-utilities/bootstrap.md) - Foundational setup before first sync.
|
|
40
64
|
- [Scope and Surface](scope-and-surface.md) - Canonical assets, provider views, scopes, and the sync surface area.
|
|
41
65
|
- [Commands](commands.md) - `oat status`, `oat sync`, and `oat providers ...` behavior.
|
|
@@ -20,21 +20,36 @@ The CLI is also a standalone value path. You can use `oat init`, `oat sync`, `oa
|
|
|
20
20
|
- [Workflow & Projects](../workflows/projects/index.md) - Project lifecycle, artifacts, reviews, PR flow, and state-machine docs.
|
|
21
21
|
- [Repository PR Comment Analysis](../workflows/projects/repo-analysis.md) - Detailed `oat repo pr-comments ...` behavior.
|
|
22
22
|
|
|
23
|
+
## Full CLI Reference Expansion Path
|
|
24
|
+
|
|
25
|
+
Keep this page as the command-family map. Fuller command coverage should live either in the owning section for a command family or in generated/semi-generated reference pages that link back here.
|
|
26
|
+
|
|
27
|
+
Each full command reference should include:
|
|
28
|
+
|
|
29
|
+
- exact arguments, flags, defaults, aliases, and mutually exclusive options
|
|
30
|
+
- output examples, including `--json` shapes where the CLI supports JSON
|
|
31
|
+
- exit behavior for success, validation errors, missing state, and non-interactive blockers
|
|
32
|
+
- side effects such as file writes, generated artifacts, config mutations, branch/commit behavior, and network calls
|
|
33
|
+
- non-interactive usage guidance, including required flags and scripting-safe forms
|
|
34
|
+
- source or test references for behavior that is easy to drift, marking unknown exit-code behavior as unknown instead of inventing a contract
|
|
35
|
+
|
|
36
|
+
The first practical expansion path is to keep improving the existing owners: [Docs App Commands](../docs-tooling/commands.md), [Provider Interop Commands](../provider-sync/commands.md), [Config and Local State](../cli-utilities/config-and-local-state.md), [Tool Packs](../cli-utilities/tool-packs.md), [Workflow & Projects](../workflows/projects/index.md), and [Repository PR Comment Analysis](../workflows/projects/repo-analysis.md).
|
|
37
|
+
|
|
23
38
|
## Command Groups
|
|
24
39
|
|
|
25
|
-
| Command group | What it covers
|
|
26
|
-
| ----------------------------------------------- |
|
|
27
|
-
| `oat init` | Bootstrap canonical OAT directories, sync config, optional hooks, and guided setup.
|
|
28
|
-
| `oat tools ...` | Install, inspect, update, and remove bundled OAT tool packs and assets.
|
|
29
|
-
| `oat pjm ...` | Initialize the project-management repo-reference surface after installing the project-management pack.
|
|
30
|
-
| `oat backlog ...` / `oat local ...` | File-backed backlog helpers, local path sync, and local-only operational support.
|
|
31
|
-
| `oat config ...` / `oat instructions ...` | Config discovery, source-aware config dumps, supported mutations, and instruction-integrity helpers.
|
|
32
|
-
| `oat state ...` / `oat index ...` / `internal` | Repo dashboard refresh, repo indexing, validation helpers, and diagnostics.
|
|
33
|
-
| `oat docs ...` | Docs app bootstrap, migration, index generation, nav sync, and docs workflow entrypoints.
|
|
34
|
-
| `oat status` / `oat sync` / `oat providers ...` | Provider sync, drift inspection, provider configuration, and adoption behavior.
|
|
40
|
+
| Command group | What it covers | Go deeper |
|
|
41
|
+
| ----------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------ |
|
|
42
|
+
| `oat init` | Bootstrap canonical OAT directories, sync config, optional hooks, and guided setup. | [CLI Bootstrap](../cli-utilities/bootstrap.md) |
|
|
43
|
+
| `oat tools ...` | Install, inspect, update, and remove bundled OAT tool packs and assets. | [Tool Packs](../cli-utilities/tool-packs.md) |
|
|
44
|
+
| `oat pjm ...` | Initialize the project-management repo-reference surface after installing the project-management pack. | [Install vs. initialize](../cli-utilities/tool-packs.md#install-vs-initialize) |
|
|
45
|
+
| `oat backlog ...` / `oat local ...` | File-backed backlog helpers, local path sync, and local-only operational support. | [Config and Local State](../cli-utilities/config-and-local-state.md) |
|
|
46
|
+
| `oat config ...` / `oat instructions ...` | Config discovery, source-aware config dumps, supported mutations, and instruction-integrity helpers. | [Config and Local State](../cli-utilities/config-and-local-state.md) |
|
|
47
|
+
| `oat state ...` / `oat index ...` / `internal` | Repo dashboard refresh, repo indexing, validation helpers, and diagnostics. | [Config and Local State](../cli-utilities/config-and-local-state.md) |
|
|
48
|
+
| `oat docs ...` | Docs app bootstrap, migration, index generation, nav sync, and docs workflow entrypoints. | [Docs Tooling Commands](../docs-tooling/commands.md) |
|
|
49
|
+
| `oat status` / `oat sync` / `oat providers ...` | Provider sync, drift inspection, provider configuration, and adoption behavior. | [Provider Sync](../provider-sync/index.md) |
|
|
35
50
|
| `oat project ...` / `oat cleanup ...` | Project scaffolding, active-project status inspection, tracked-project listing, plan validation, archive creation, and project/artifact cleanup commands. | [Workflow & Projects](../workflows/projects/index.md) |
|
|
36
|
-
| `oat review ...` | Review artifact discovery helpers, including latest-review resolution for project and ad-hoc review flows.
|
|
37
|
-
| `oat repo ...` | Repository-level workflows such as archive sync and PR-comment analysis.
|
|
51
|
+
| `oat review ...` | Review artifact discovery helpers, including latest-review resolution for project and ad-hoc review flows. | [Reviews](../workflows/projects/reviews.md) |
|
|
52
|
+
| `oat repo ...` | Repository-level workflows such as archive sync and PR-comment analysis. | [Repository Analysis](../workflows/projects/repo-analysis.md) |
|
|
38
53
|
|
|
39
54
|
Notable commands introduced in the current CLI surface:
|
|
40
55
|
|
|
@@ -5,13 +5,15 @@ description: 'Docs source contract: authored index.md maps, generated Fumadocs m
|
|
|
5
5
|
|
|
6
6
|
# Docs Index Contract
|
|
7
7
|
|
|
8
|
-
OAT docs navigation starts from authored `docs/**/index.md` files. Each `## Contents` section is the local source of truth for sibling pages and child directories. Generated artifacts are derived from docs source and should not be edited directly.
|
|
8
|
+
OAT docs navigation starts from authored `docs/**/index.md` files. Each `## Contents` section is the local source of truth for sibling pages and child directories. Generated artifacts are derived from docs source and should not be edited directly. The framework determines which generated artifact is produced, but the authored `## Contents` contract is the same for humans and agents.
|
|
9
9
|
|
|
10
10
|
## Rules
|
|
11
11
|
|
|
12
12
|
- Every documentation directory must contain an `index.md`.
|
|
13
13
|
- Every `index.md` must include a `## Contents` section.
|
|
14
|
+
- The `## Contents` section is the machine-readable local map for sibling pages and child directories.
|
|
14
15
|
- Every `## Contents` link should use a `.md`-suffixed relative target, including child directory links such as `subdir/index.md`.
|
|
16
|
+
- Do not hand-edit generated navigation or generated root-index artifacts.
|
|
15
17
|
- For Fumadocs, refresh or freshness-check the generated app-root manifest after adding, removing, or renaming Markdown files. Compare that manifest against authored `## Contents` maps for drift; reordering `## Contents` does not reorder the generated manifest's file-tree sort.
|
|
16
18
|
- For MkDocs, run `oat docs nav sync` after adding, removing, renaming, or reordering pages. It regenerates `mkdocs.yml` from authored `## Contents` maps and preserves the order declared in each local map.
|
|
17
19
|
|
|
@@ -31,28 +33,37 @@ Notes:
|
|
|
31
33
|
- Links after `## Contents` can include short human-readable descriptions.
|
|
32
34
|
- Child directories should link to their `index.md`.
|
|
33
35
|
- Leaf pages should link to their `.md` filename.
|
|
34
|
-
- Prose outside `## Contents` is ignored by nav generation and remains freeform.
|
|
36
|
+
- Prose outside `## Contents` is ignored by nav generation and remains freeform; it can explain scope, reader paths, or migration status.
|
|
35
37
|
|
|
36
|
-
##
|
|
38
|
+
## Fumadocs Generation
|
|
37
39
|
|
|
38
|
-
Fumadocs and
|
|
40
|
+
For this Fumadocs app, rendered page routing and sidebar data come from the Fumadocs file/source pipeline over `apps/oat-docs/docs`. The generated root manifest, `apps/oat-docs/index.md`, is an inventory for agents and tooling; it is not the rendered sidebar/page-tree source.
|
|
39
41
|
|
|
40
|
-
|
|
42
|
+
`oat docs generate-index` walks the Markdown file tree under `docs/` and writes the app-root generated manifest. The app scripts run:
|
|
41
43
|
|
|
42
44
|
```bash
|
|
45
|
+
fumadocs-mdx
|
|
43
46
|
pnpm -w run cli -- docs generate-index --docs-dir apps/oat-docs/docs --output apps/oat-docs/index.md
|
|
44
47
|
```
|
|
45
48
|
|
|
46
|
-
|
|
49
|
+
`oat docs generate-index` rewrites the generated root manifest from the docs source tree. It is the command to use after adding, removing, or retiring pages in this Fumadocs app. Do not use `oat docs nav sync` as the Fumadocs regeneration step.
|
|
47
50
|
|
|
48
|
-
|
|
51
|
+
Fumadocs generated behavior:
|
|
52
|
+
|
|
53
|
+
- Generated entries are ordered by the file-tree generator: `index.md` first, directories before files, then lexical order.
|
|
54
|
+
- Reordering a `## Contents` block does not reorder the generated manifest's file-tree sort.
|
|
55
|
+
- Generated manifests should carry an autogen warning and are rewritten by `predev` / `prebuild`.
|
|
56
|
+
|
|
57
|
+
## MkDocs Nav Sync
|
|
58
|
+
|
|
59
|
+
MkDocs apps use `oat docs nav sync --target-dir <docs-app-dir>` to walk the docs tree from `docs/index.md` downward and regenerate the `nav:` block in `mkdocs.yml` from discovered directory `index.md` files.
|
|
60
|
+
|
|
61
|
+
MkDocs generated behavior:
|
|
49
62
|
|
|
50
63
|
- Root `docs/index.md` becomes `Home`.
|
|
51
64
|
- Child directory `index.md` files become section landing pages.
|
|
52
|
-
-
|
|
53
|
-
-
|
|
54
|
-
- Fumadocs generated manifests should carry an autogen warning and are rewritten by `predev` / `prebuild`.
|
|
55
|
-
- MkDocs `mkdocs.yml` may contain other configuration, but its `nav:` block is derived from authored `## Contents`.
|
|
65
|
+
- Nested entries are emitted in the order they appear under each local `## Contents` block.
|
|
66
|
+
- `mkdocs.yml` may contain other configuration, but its `nav:` block is derived from authored `## Contents`.
|
|
56
67
|
|
|
57
68
|
## Generated-file boundaries
|
|
58
69
|
|
|
@@ -66,6 +77,7 @@ Generated behavior:
|
|
|
66
77
|
- Use `index.md` as the local discovery surface for humans and agents.
|
|
67
78
|
- Add a short topic description next to each link so agents can choose the right file without opening every page.
|
|
68
79
|
- Update `## Contents` whenever you add, remove, rename, or reorder docs files in a directory.
|
|
80
|
+
- Regenerate the framework-specific artifact after structural changes: `generate-index` for Fumadocs root manifests, `nav sync` for MkDocs `mkdocs.yml`.
|
|
69
81
|
- Refresh or freshness-check the generated artifact before committing structural docs changes.
|
|
70
82
|
|
|
71
83
|
## If You Are Trying To...
|
|
@@ -7,7 +7,13 @@ description: Standalone adoption lane for tracked OAT projects, workflow lifecyc
|
|
|
7
7
|
|
|
8
8
|
Agentic Workflows is the OAT lane for tracked, resumable work on top of the base CLI and provider-sync layers.
|
|
9
9
|
|
|
10
|
-
Use this section when you want explicit project artifacts, stable task IDs, review loops, and resumable execution across longer-running work.
|
|
10
|
+
Use this section when you want explicit project artifacts, stable task IDs, review loops, and resumable execution across longer-running work. The workflow layer is optional; stay with direct CLI usage when the task is straightforward and the overhead of project artifacts would outweigh the value.
|
|
11
|
+
|
|
12
|
+
## Contents
|
|
13
|
+
|
|
14
|
+
- [Ideas Workflow](ideas/index.md) - Lightweight idea capture, brainstorming, and promotion into tracked projects when the work becomes concrete.
|
|
15
|
+
- [Workflow & Projects](projects/index.md) - Lifecycle, artifacts, reviews, PR flow, and repository analysis.
|
|
16
|
+
- [Skills](skills/index.md) - Workflow-oriented skill discovery and use-case routing.
|
|
11
17
|
|
|
12
18
|
## What This Section Is
|
|
13
19
|
|
|
@@ -19,11 +25,33 @@ This section explains when workflow mode is worth the overhead, how OAT projects
|
|
|
19
25
|
- Users who want explicit discovery, planning, implementation, and review state
|
|
20
26
|
- Repos that need a repeatable human-in-the-loop execution model
|
|
21
27
|
|
|
28
|
+
## When To Use Workflow Mode
|
|
29
|
+
|
|
30
|
+
Use workflow mode when:
|
|
31
|
+
|
|
32
|
+
- the work spans multiple sessions or contributors
|
|
33
|
+
- you want explicit discovery, plan, implementation, and review artifacts
|
|
34
|
+
- you need stable task sequencing and resumable execution
|
|
35
|
+
- you want human-in-the-loop checkpoints around risky transitions
|
|
36
|
+
|
|
37
|
+
Stay with direct CLI usage when:
|
|
38
|
+
|
|
39
|
+
- the task is straightforward and bounded
|
|
40
|
+
- you mainly need provider sync or a utility command
|
|
41
|
+
- the overhead of project artifacts would outweigh the value
|
|
42
|
+
|
|
43
|
+
## Workflow Modes In Practice
|
|
44
|
+
|
|
45
|
+
- CLI only: direct commands, no tracked project artifacts
|
|
46
|
+
- Quick mode: tracked work with a lighter upfront planning path
|
|
47
|
+
- Spec-driven mode: explicit discovery, requirements, design, and plan artifacts
|
|
48
|
+
- Import mode: an externally-authored plan imported into OAT for tracked execution
|
|
49
|
+
|
|
22
50
|
## Start Here
|
|
23
51
|
|
|
24
|
-
- Read [Overview](overview.md) to decide whether you want workflow mode or just direct CLI usage.
|
|
25
52
|
- Use [Skills](skills/index.md) when you want task-oriented guidance on the most useful workflow skills.
|
|
26
53
|
- Go to [Workflow & Projects](projects/index.md) when you need the lifecycle and artifact model in detail.
|
|
54
|
+
- Use [Ideas](ideas/index.md) when the work is still exploratory.
|
|
27
55
|
|
|
28
56
|
## Common Tasks
|
|
29
57
|
|
|
@@ -34,7 +62,6 @@ This section explains when workflow mode is worth the overhead, how OAT projects
|
|
|
34
62
|
|
|
35
63
|
## Go Deeper
|
|
36
64
|
|
|
37
|
-
- [Overview](overview.md) - What the workflow layer adds and when to use it.
|
|
38
65
|
- [Skills](skills/index.md) - Workflow-oriented skill discovery and use-case routing.
|
|
39
66
|
- [Ideas](ideas/index.md) - Idea capture, refinement, and promotion flows.
|
|
40
67
|
- [Workflow & Projects](projects/index.md) - Lifecycle, artifacts, reviews, PR flow, and repository analysis.
|
|
@@ -9,6 +9,20 @@ Use this section when you want the detailed lifecycle and artifact model behind
|
|
|
9
9
|
|
|
10
10
|
Projects are where the workflow layer becomes concrete: lifecycle phases, `state.md`, `plan.md`, review gates, PR flow, and repository-analysis helpers all live here.
|
|
11
11
|
|
|
12
|
+
## Contents
|
|
13
|
+
|
|
14
|
+
- [Lifecycle](lifecycle.md) - End-to-end flow from discovery through completion.
|
|
15
|
+
- [Design Modes](design-modes.md) - How full design balances collaborative, selective collaborative, and draft-and-review interaction.
|
|
16
|
+
- [HiLL Checkpoints](hill-checkpoints.md) - Human-in-the-Loop Lifecycle configuration and approval behavior.
|
|
17
|
+
- [Dispatch Ceiling](dispatch-ceiling.md) - Provider-neutral ceiling model and provider-specific enforcement.
|
|
18
|
+
- [Project Artifacts](artifacts.md) - What lives in `state.md`, `discovery.md`, `plan.md`, `implementation.md`, and related files.
|
|
19
|
+
- [Implementation Execution](implementation-execution.md) - Phase dispatch, runtime selection, review/fix loop, and dry-run behavior.
|
|
20
|
+
- [Project Splitting](splitting.md) - How broad discoveries or brainstorms become coordination parents and child projects.
|
|
21
|
+
- [State Machine](state-machine.md) - Lifecycle and review status transitions across a project.
|
|
22
|
+
- [Reviews](reviews.md) - How review request/receive loops work inside OAT projects.
|
|
23
|
+
- [PR Flow](pr-flow.md) - Progress and final PR generation expectations.
|
|
24
|
+
- [Repository PR Comment Analysis](repo-analysis.md) - Repo-wide PR comment collection and triage workflows.
|
|
25
|
+
|
|
12
26
|
## What This Section Is
|
|
13
27
|
|
|
14
28
|
This sub-section is the deep technical surface for how tracked OAT projects execute and how their artifacts, reviews, and PR states fit together.
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@open-agent-toolkit/cli",
|
|
3
|
-
"version": "0.1.
|
|
3
|
+
"version": "0.1.23",
|
|
4
4
|
"private": false,
|
|
5
5
|
"description": "Open Agent Toolkit CLI",
|
|
6
6
|
"homepage": "https://github.com/voxmedia/open-agent-toolkit/tree/main/packages/cli",
|
|
@@ -34,7 +34,7 @@
|
|
|
34
34
|
"ora": "^9.0.0",
|
|
35
35
|
"yaml": "2.8.2",
|
|
36
36
|
"zod": "^3.25.76",
|
|
37
|
-
"@open-agent-toolkit/control-plane": "0.1.
|
|
37
|
+
"@open-agent-toolkit/control-plane": "0.1.23"
|
|
38
38
|
},
|
|
39
39
|
"devDependencies": {
|
|
40
40
|
"@types/node": "^22.10.0",
|
|
@@ -1,33 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
title: CLI Utilities Overview
|
|
3
|
-
description: Plain-language explanation of the OAT CLI surface that lives outside provider sync, docs tooling, and tracked workflows.
|
|
4
|
-
---
|
|
5
|
-
|
|
6
|
-
# CLI Utilities Overview
|
|
7
|
-
|
|
8
|
-
Not every OAT command belongs to a single product lane. Some commands are general-purpose setup, configuration, pack-management, or diagnostic utilities that support the rest of the toolkit without being specific to provider sync, docs tooling, or tracked workflow execution.
|
|
9
|
-
|
|
10
|
-
That is what this section covers.
|
|
11
|
-
|
|
12
|
-
## What Lives Here
|
|
13
|
-
|
|
14
|
-
- bootstrap and setup flows such as `oat init`
|
|
15
|
-
- bundled pack management through `oat tools`
|
|
16
|
-
- general configuration guidance
|
|
17
|
-
- utility command groups for config, local state, diagnostics, and related inspection flows
|
|
18
|
-
|
|
19
|
-
## When To Use This Section
|
|
20
|
-
|
|
21
|
-
Use CLI Utilities when:
|
|
22
|
-
|
|
23
|
-
- you are first setting up OAT in a repo
|
|
24
|
-
- you need to install or update OAT packs
|
|
25
|
-
- you are looking for configuration or local-state inspection help
|
|
26
|
-
- you need the general CLI surface without committing to one of the deeper lanes yet
|
|
27
|
-
|
|
28
|
-
## Continue Here
|
|
29
|
-
|
|
30
|
-
- [CLI Bootstrap](bootstrap.md) for initial setup
|
|
31
|
-
- [Tool Packs](tool-packs.md) for pack lifecycle management
|
|
32
|
-
- [Configuration](configuration.md) for config semantics
|
|
33
|
-
- [Config and Local State](config-and-local-state.md) for the wider utility command map
|
|
@@ -1,31 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
title: Docs Tooling Overview
|
|
3
|
-
description: Plain-language explanation of OAT docs support, docs app choices, and the index contract.
|
|
4
|
-
---
|
|
5
|
-
|
|
6
|
-
# Docs Tooling Overview
|
|
7
|
-
|
|
8
|
-
OAT can help bootstrap and maintain a structured docs surface, not just code and provider assets. The docs tooling is built around a simple contract: each directory owns an `index.md`, and that index owns a `## Contents` section that supports local discovery and generated navigation.
|
|
9
|
-
|
|
10
|
-
OAT supports both Fumadocs and MkDocs. The site framework changes the surrounding app setup, but the underlying documentation contract stays the same.
|
|
11
|
-
|
|
12
|
-
## When To Use This Section
|
|
13
|
-
|
|
14
|
-
Use Docs Tooling when:
|
|
15
|
-
|
|
16
|
-
- you are adding a docs app to a repo
|
|
17
|
-
- you need to keep index pages and nav structure in sync
|
|
18
|
-
- you want a controlled analyze/apply loop for docs restructuring work
|
|
19
|
-
|
|
20
|
-
## Typical Flow
|
|
21
|
-
|
|
22
|
-
1. Bootstrap or adopt a docs app in the repo.
|
|
23
|
-
2. Use the docs commands to generate or sync index/navigation structure.
|
|
24
|
-
3. Apply the docs workflow when you want analysis-backed restructuring rather than ad hoc manual edits.
|
|
25
|
-
|
|
26
|
-
## Continue Here
|
|
27
|
-
|
|
28
|
-
- [Add Docs to a Repo](add-docs-to-a-repo.md) for initial setup
|
|
29
|
-
- [Commands](commands.md) for the CLI surface
|
|
30
|
-
- [Workflows](workflows.md) for governed docs changes
|
|
31
|
-
- [Docs Index Contract](../reference/docs-index-contract.md) for the underlying rules
|
|
@@ -1,38 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
title: Provider Sync Overview
|
|
3
|
-
description: Plain-language explanation of canonical assets, provider views, and the first-sync loop.
|
|
4
|
-
---
|
|
5
|
-
|
|
6
|
-
# Provider Sync Overview
|
|
7
|
-
|
|
8
|
-
Provider sync lets OAT manage one canonical set of agent assets and then project those assets into provider-specific views. In practice, that means you edit the canonical layout in `.agents/` and `.oat/`, then let OAT generate or reconcile the provider copies.
|
|
9
|
-
|
|
10
|
-
This is useful when you want consistent instructions, skills, and rules across multiple providers without treating each provider directory as a long-lived hand-maintained source of truth.
|
|
11
|
-
|
|
12
|
-
## What OAT Treats As Canonical
|
|
13
|
-
|
|
14
|
-
- canonical skills, agents, and rules under `.agents/`
|
|
15
|
-
- sync state and related metadata under `.oat/`
|
|
16
|
-
- provider-specific files as derived views unless they are explicitly adopted back into canonical form
|
|
17
|
-
|
|
18
|
-
## Typical Flow
|
|
19
|
-
|
|
20
|
-
1. Run `oat init` to create the base OAT layout and setup state.
|
|
21
|
-
2. Inspect current sync state with `oat status`.
|
|
22
|
-
3. Adjust provider enablement with `oat providers ...` if needed.
|
|
23
|
-
4. Run `oat sync` to materialize provider views from canonical assets.
|
|
24
|
-
5. Re-run `oat status` after edits to confirm whether anything drifted or needs adoption.
|
|
25
|
-
|
|
26
|
-
## When To Use This Section
|
|
27
|
-
|
|
28
|
-
Use Provider Sync when:
|
|
29
|
-
|
|
30
|
-
- you want to adopt OAT incrementally, without committing to tracked project workflows yet
|
|
31
|
-
- you need a clear model for drift, strays, and adoption
|
|
32
|
-
- you want to understand which files should be edited directly and which should be regenerated
|
|
33
|
-
|
|
34
|
-
## Continue Here
|
|
35
|
-
|
|
36
|
-
- [CLI Bootstrap](../cli-utilities/bootstrap.md) for the first sync setup flow
|
|
37
|
-
- [Scope and Surface](scope-and-surface.md) for the canonical/provider-view model
|
|
38
|
-
- [Commands](commands.md) for the exact CLI behavior
|
|
@@ -1,38 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
title: Agentic Workflows Overview
|
|
3
|
-
description: Plain-language explanation of when to use tracked OAT projects versus direct CLI usage.
|
|
4
|
-
---
|
|
5
|
-
|
|
6
|
-
# Agentic Workflows Overview
|
|
7
|
-
|
|
8
|
-
OAT workflow mode adds a tracked lifecycle on top of the base CLI. Instead of just running commands directly, you work through explicit project artifacts such as `state.md`, `plan.md`, and `implementation.md`, with stable task IDs and review checkpoints.
|
|
9
|
-
|
|
10
|
-
That extra structure is optional. You only need it when the work is large enough, risky enough, or long-lived enough that resumability and explicit coordination matter.
|
|
11
|
-
|
|
12
|
-
## When To Use Workflow Mode
|
|
13
|
-
|
|
14
|
-
Use workflow mode when:
|
|
15
|
-
|
|
16
|
-
- the work spans multiple sessions or contributors
|
|
17
|
-
- you want explicit discovery, plan, implementation, and review artifacts
|
|
18
|
-
- you need stable task sequencing and resumable execution
|
|
19
|
-
- you want human-in-the-loop checkpoints around risky transitions
|
|
20
|
-
|
|
21
|
-
Stay with direct CLI usage when:
|
|
22
|
-
|
|
23
|
-
- the task is straightforward and bounded
|
|
24
|
-
- you mainly need provider sync or a utility command
|
|
25
|
-
- the overhead of project artifacts would outweigh the value
|
|
26
|
-
|
|
27
|
-
## Workflow Modes In Practice
|
|
28
|
-
|
|
29
|
-
- CLI only: direct commands, no tracked project artifacts
|
|
30
|
-
- Quick mode: tracked work with a lighter upfront planning path
|
|
31
|
-
- Spec-driven mode: explicit discovery, requirements, design, and plan artifacts
|
|
32
|
-
- Import mode: an externally-authored plan imported into OAT for tracked execution
|
|
33
|
-
|
|
34
|
-
## Continue Here
|
|
35
|
-
|
|
36
|
-
- [Skills](skills/index.md) for task-oriented workflow skill discovery
|
|
37
|
-
- [Ideas](ideas/index.md) for lightweight capture and refinement
|
|
38
|
-
- [Workflow & Projects](projects/index.md) for the lifecycle, artifact, and review model
|