@open-agent-toolkit/cli 0.0.10 → 0.0.18
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/LICENSE +21 -0
- package/README.md +12 -20
- package/assets/docs/{guide/getting-started.md → cli-utilities/bootstrap.md} +8 -2
- package/assets/docs/cli-utilities/config-and-local-state.md +84 -0
- package/assets/docs/{guide → cli-utilities}/configuration.md +2 -2
- package/assets/docs/cli-utilities/index.md +41 -0
- package/assets/docs/cli-utilities/overview.md +33 -0
- package/assets/docs/{guide → cli-utilities}/tool-packs.md +9 -3
- package/assets/docs/contributing/code.md +4 -2
- package/assets/docs/contributing/design-principles.md +3 -3
- package/assets/docs/contributing/documentation.md +12 -4
- package/assets/docs/{guide/documentation/quickstart.md → docs-tooling/add-docs-to-a-repo.md} +1 -1
- package/assets/docs/{guide/documentation → docs-tooling}/commands.md +8 -1
- package/assets/docs/docs-tooling/index.md +40 -0
- package/assets/docs/docs-tooling/overview.md +31 -0
- package/assets/docs/{guide/documentation → docs-tooling}/workflows.md +3 -3
- package/assets/docs/guide/concepts.md +9 -9
- package/assets/docs/guide/index.md +14 -11
- package/assets/docs/index.md +34 -18
- package/assets/docs/{guide/provider-sync → provider-sync}/commands.md +10 -4
- package/assets/docs/{guide/provider-sync → provider-sync}/config.md +1 -1
- package/assets/docs/provider-sync/index.md +43 -0
- package/assets/docs/{guide/provider-sync → provider-sync}/manifest-and-drift.md +8 -0
- package/assets/docs/provider-sync/overview.md +38 -0
- package/assets/docs/{guide/provider-sync → provider-sync}/scope-and-surface.md +3 -3
- package/assets/docs/quickstart.md +43 -126
- package/assets/docs/reference/cli-reference.md +35 -0
- package/assets/docs/reference/docs-index-contract.md +1 -2
- package/assets/docs/reference/index.md +5 -4
- package/assets/docs/workflows/index.md +40 -0
- package/assets/docs/workflows/overview.md +38 -0
- package/assets/docs/workflows/projects/index.md +37 -0
- package/assets/docs/{guide/workflow → workflows/projects}/lifecycle.md +6 -0
- package/assets/docs/{guide/workflow → workflows/projects}/repo-analysis.md +6 -0
- package/assets/docs/{guide/workflow → workflows/projects}/state-machine.md +8 -0
- package/assets/docs/{guide → workflows}/skills/index.md +2 -2
- package/assets/public-package-versions.json +4 -4
- package/assets/skills/oat-agent-instructions-analyze/scripts/resolve-instruction-files.sh +0 -0
- package/assets/skills/oat-agent-instructions-analyze/scripts/resolve-providers.sh +0 -0
- package/assets/skills/oat-project-complete/SKILL.md +21 -27
- package/assets/skills/oat-project-document/SKILL.md +2 -2
- package/assets/skills/oat-project-import-plan/scripts/find-recent-provider-plans.sh +0 -0
- package/assets/skills/oat-project-subagent-implement/scripts/dispatch.sh +0 -0
- package/assets/skills/oat-project-subagent-implement/scripts/reconcile.sh +0 -0
- package/assets/skills/oat-project-subagent-implement/scripts/review-gate.sh +0 -0
- package/assets/skills/oat-project-subagent-implement/tests/test-dry-run.sh +0 -0
- package/assets/skills/oat-project-subagent-implement/tests/test-reconcile.sh +0 -0
- package/assets/skills/oat-project-subagent-implement/tests/test-review-gate.sh +0 -0
- package/assets/skills/oat-repo-maintainability-review/scripts/resolve-analysis-output.sh +0 -0
- package/assets/skills/oat-review-provide/scripts/resolve-review-output.sh +0 -0
- package/assets/skills/oat-worktree-bootstrap-auto/scripts/bootstrap.sh +0 -0
- package/dist/app/create-program.js +1 -1
- package/dist/commands/docs/index-generate/index.d.ts +1 -0
- package/dist/commands/docs/index-generate/index.d.ts.map +1 -1
- package/dist/commands/docs/index-generate/index.js +6 -3
- package/dist/commands/docs/init/index.d.ts +3 -0
- package/dist/commands/docs/init/index.d.ts.map +1 -1
- package/dist/commands/docs/init/index.js +52 -3
- package/dist/commands/docs/init/resolve-options.d.ts +1 -1
- package/dist/commands/docs/init/resolve-options.d.ts.map +1 -1
- package/dist/commands/docs/init/resolve-options.js +1 -0
- package/dist/commands/docs/init/scaffold.d.ts +1 -0
- package/dist/commands/docs/init/scaffold.d.ts.map +1 -1
- package/dist/commands/docs/init/scaffold.js +26 -8
- package/dist/commands/internal/index.d.ts.map +1 -1
- package/dist/commands/internal/index.js +3 -1
- package/dist/commands/internal/validate-oat-skills.d.ts +2 -2
- package/dist/commands/internal/validate-oat-skills.d.ts.map +1 -1
- package/dist/commands/internal/validate-oat-skills.js +5 -4
- package/dist/commands/internal/validate-skill-version-bumps.d.ts +10 -0
- package/dist/commands/internal/validate-skill-version-bumps.d.ts.map +1 -0
- package/dist/commands/internal/validate-skill-version-bumps.js +74 -0
- package/dist/commands/project/archive/archive-utils.d.ts.map +1 -1
- package/dist/commands/project/archive/archive-utils.js +34 -2
- package/dist/manifest/manager.js +1 -1
- package/dist/validation/index.d.ts +2 -2
- package/dist/validation/index.d.ts.map +1 -1
- package/dist/validation/index.js +1 -1
- package/dist/validation/skills.d.ts +25 -1
- package/dist/validation/skills.d.ts.map +1 -1
- package/dist/validation/skills.js +95 -1
- package/package.json +17 -17
- package/assets/docs/guide/cli-reference.md +0 -211
- package/assets/docs/guide/documentation/index.md +0 -27
- package/assets/docs/guide/provider-sync/index.md +0 -65
- package/assets/docs/guide/workflow/index.md +0 -34
- /package/assets/docs/{guide/provider-sync → provider-sync}/providers.md +0 -0
- /package/assets/docs/{guide → workflows}/ideas/index.md +0 -0
- /package/assets/docs/{guide → workflows}/ideas/lifecycle.md +0 -0
- /package/assets/docs/{guide/workflow → workflows/projects}/artifacts.md +0 -0
- /package/assets/docs/{guide/workflow → workflows/projects}/hill-checkpoints.md +0 -0
- /package/assets/docs/{guide/workflow → workflows/projects}/pr-flow.md +0 -0
- /package/assets/docs/{guide/workflow → workflows/projects}/reviews.md +0 -0
|
@@ -9,13 +9,19 @@ description: 'CLI commands for provider status, sync, and drift management.'
|
|
|
9
9
|
|
|
10
10
|
These command definitions inherit the cross-cutting CLI conventions in:
|
|
11
11
|
|
|
12
|
-
- [
|
|
12
|
+
- [`../contributing/design-principles.md`](../contributing/design-principles.md)
|
|
13
13
|
|
|
14
14
|
## Adjacent command docs (outside provider interop scope)
|
|
15
15
|
|
|
16
|
-
- `oat init` (bootstrap): `../
|
|
17
|
-
- `oat tools ...` (tool-pack lifecycle — install, update, remove, list, info): `../tool-packs.md`
|
|
18
|
-
- `oat doctor` (cross-cutting diagnostics): `../cli-reference.md`
|
|
16
|
+
- `oat init` (bootstrap): `../cli-utilities/bootstrap.md`
|
|
17
|
+
- `oat tools ...` (tool-pack lifecycle — install, update, remove, list, info): `../cli-utilities/tool-packs.md`
|
|
18
|
+
- `oat doctor` (cross-cutting diagnostics): `../reference/cli-reference.md`
|
|
19
|
+
|
|
20
|
+
## Quick Look
|
|
21
|
+
|
|
22
|
+
- What it does: defines the day-to-day provider-sync command surface for inspecting state, reconciling provider views, and changing provider enablement.
|
|
23
|
+
- When to use it: after you have canonical assets in place and need to check sync state, write provider views, or change provider config.
|
|
24
|
+
- Primary commands: `oat status`, `oat sync`, `oat providers list`, `oat providers inspect`, `oat providers set`
|
|
19
25
|
|
|
20
26
|
## `oat status`
|
|
21
27
|
|
|
@@ -74,4 +74,4 @@ It is read by:
|
|
|
74
74
|
|
|
75
75
|
- [`commands.md`](commands.md)
|
|
76
76
|
- [`manifest-and-drift.md`](manifest-and-drift.md)
|
|
77
|
-
- [
|
|
77
|
+
- [`../reference/oat-directory-structure.md`](../reference/oat-directory-structure.md)
|
|
@@ -0,0 +1,43 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: Provider Sync
|
|
3
|
+
description: Standalone adoption lane for canonical assets, provider views, sync commands, and drift management.
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# Provider Sync
|
|
7
|
+
|
|
8
|
+
Provider Sync is the OAT lane for keeping a canonical rules-and-skills layout in sync with provider-specific surfaces such as Claude, Cursor, Copilot, Gemini, or Codex.
|
|
9
|
+
|
|
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
|
+
|
|
12
|
+
## What This Section Is
|
|
13
|
+
|
|
14
|
+
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
|
+
|
|
16
|
+
## Who It's For
|
|
17
|
+
|
|
18
|
+
- Teams adopting OAT primarily for provider interoperability
|
|
19
|
+
- Users who want one canonical asset layout instead of hand-maintaining provider copies
|
|
20
|
+
- Repos that need drift detection, adoption flows, and explicit sync control
|
|
21
|
+
|
|
22
|
+
## Start Here
|
|
23
|
+
|
|
24
|
+
- Read [Overview](overview.md) for the plain-language model and the first-sync flow.
|
|
25
|
+
- Use [CLI Bootstrap](../cli-utilities/bootstrap.md) when you are bootstrapping OAT and want the sync-relevant setup path.
|
|
26
|
+
- Go to [Commands](commands.md) once you are actively using `oat status`, `oat sync`, and `oat providers`.
|
|
27
|
+
|
|
28
|
+
## Common Tasks
|
|
29
|
+
|
|
30
|
+
- Understand the canonical/provider-view model in [Scope and Surface](scope-and-surface.md).
|
|
31
|
+
- Learn provider-specific mappings in [Providers](providers.md).
|
|
32
|
+
- Diagnose drift and adoption behavior in [Manifest and Drift](manifest-and-drift.md).
|
|
33
|
+
- Adjust provider enablement and scope behavior in [Sync Config](config.md).
|
|
34
|
+
|
|
35
|
+
## Go Deeper
|
|
36
|
+
|
|
37
|
+
- [Overview](overview.md) - What provider sync is, when to use it, and what a typical sync loop looks like.
|
|
38
|
+
- [CLI Bootstrap](../cli-utilities/bootstrap.md) - Foundational setup before first sync.
|
|
39
|
+
- [Scope and Surface](scope-and-surface.md) - Canonical assets, provider views, scopes, and the sync surface area.
|
|
40
|
+
- [Commands](commands.md) - `oat status`, `oat sync`, and `oat providers ...` behavior.
|
|
41
|
+
- [Providers](providers.md) - Provider-specific mappings, capabilities, and path conventions.
|
|
42
|
+
- [Manifest and Drift](manifest-and-drift.md) - How OAT tracks synced state, stray files, and adoption decisions.
|
|
43
|
+
- [Sync Config](config.md) - Provider config model, enablement, and scope semantics.
|
|
@@ -5,6 +5,14 @@ description: 'Manifest tracking, drift states, and stray adoption for canonical-
|
|
|
5
5
|
|
|
6
6
|
# Manifest and Drift
|
|
7
7
|
|
|
8
|
+
This page explains how OAT remembers what it manages and how it distinguishes clean sync state from drift, missing files, or unmanaged strays.
|
|
9
|
+
|
|
10
|
+
## Quick Look
|
|
11
|
+
|
|
12
|
+
- What it does: describes the manifest contract behind provider sync and the drift/adoption model built on top of it.
|
|
13
|
+
- When to use it: when `oat status` shows drift or strays and you need to understand why OAT thinks a file is managed, missing, or adoptable.
|
|
14
|
+
- Primary commands: `oat status`, `oat init`, `oat sync`
|
|
15
|
+
|
|
8
16
|
## Manifest locations
|
|
9
17
|
|
|
10
18
|
- Project: `.oat/sync/manifest.json`
|
|
@@ -0,0 +1,38 @@
|
|
|
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
|
|
@@ -37,9 +37,9 @@ Rules are currently project-scoped canonical content. Unlike skills and agents,
|
|
|
37
37
|
|
|
38
38
|
## Adjacent CLI commands (commonly used with provider interop)
|
|
39
39
|
|
|
40
|
-
- `oat init` (bootstrap canonical structure and sync config) — see `../
|
|
41
|
-
- `oat tools ...` (install/update/remove/list/inspect tools) — see `../tool-packs.md`
|
|
42
|
-
- `oat doctor` (environment + skill-version diagnostics) — see `../cli-reference.md`
|
|
40
|
+
- `oat init` (bootstrap canonical structure and sync config) — see `../cli-utilities/bootstrap.md`
|
|
41
|
+
- `oat tools ...` (install/update/remove/list/inspect tools) — see `../cli-utilities/tool-packs.md`
|
|
42
|
+
- `oat doctor` (environment + skill-version diagnostics) — see `../reference/cli-reference.md`
|
|
43
43
|
|
|
44
44
|
## Provider enablement model
|
|
45
45
|
|
|
@@ -1,162 +1,79 @@
|
|
|
1
1
|
---
|
|
2
2
|
title: Quickstart
|
|
3
|
-
description: '
|
|
3
|
+
description: 'Start-here guide for choosing the right OAT adoption path.'
|
|
4
4
|
---
|
|
5
5
|
|
|
6
6
|
# Quickstart
|
|
7
7
|
|
|
8
|
-
|
|
8
|
+
Use this page to choose the OAT path that matches what you are actually trying to do.
|
|
9
9
|
|
|
10
|
-
|
|
11
|
-
- pnpm `10.13.1+`
|
|
10
|
+
This page is intentionally lightweight. It is not the full command manual. Once you choose a path, continue into the owning section for the deeper operational detail.
|
|
12
11
|
|
|
13
|
-
##
|
|
12
|
+
## Choose a Path
|
|
14
13
|
|
|
15
|
-
|
|
16
|
-
pnpm install
|
|
17
|
-
pnpm run cli -- --help
|
|
18
|
-
```
|
|
14
|
+
### Provider Sync
|
|
19
15
|
|
|
20
|
-
|
|
16
|
+
Use this path when you want canonical skills, agents, and rules to stay aligned across provider surfaces such as Claude, Cursor, Copilot, Gemini, or Codex.
|
|
21
17
|
|
|
22
|
-
|
|
23
|
-
pnpm run cli -- init --scope project
|
|
24
|
-
```
|
|
18
|
+
Best fit:
|
|
25
19
|
|
|
26
|
-
|
|
20
|
+
- you want cross-provider sync and drift checks
|
|
21
|
+
- you care about canonical-to-provider asset management
|
|
22
|
+
- you do not necessarily need tracked project workflows
|
|
27
23
|
|
|
28
|
-
|
|
24
|
+
Continue here:
|
|
29
25
|
|
|
30
|
-
|
|
31
|
-
pnpm run cli -- status --scope all
|
|
32
|
-
pnpm run cli -- sync --scope all
|
|
33
|
-
```
|
|
26
|
+
- [Provider Sync](provider-sync/index.md)
|
|
34
27
|
|
|
35
|
-
|
|
28
|
+
### Agentic Workflows
|
|
36
29
|
|
|
37
|
-
|
|
30
|
+
Use this path when you want tracked, resumable implementation work with explicit lifecycle artifacts, reviews, and handoff-friendly state.
|
|
38
31
|
|
|
39
|
-
|
|
32
|
+
Best fit:
|
|
40
33
|
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
pnpm run cli -- tools install project-management
|
|
45
|
-
```
|
|
34
|
+
- you want structured project execution
|
|
35
|
+
- you want lifecycle artifacts like `state.md`, `plan.md`, and `implementation.md`
|
|
36
|
+
- you want a workflow layer on top of the base CLI/tooling
|
|
46
37
|
|
|
47
|
-
|
|
38
|
+
Continue here:
|
|
48
39
|
|
|
49
|
-
-
|
|
50
|
-
- `oat init tools` remains available as a backward-compatible install path.
|
|
51
|
-
- If installed OAT skills are older than bundled versions, interactive runs prompt for selective updates.
|
|
52
|
-
- Non-interactive runs report outdated skills without updating them.
|
|
40
|
+
- [Agentic Workflows](workflows/index.md)
|
|
53
41
|
|
|
54
|
-
###
|
|
42
|
+
### Docs Tooling
|
|
55
43
|
|
|
56
|
-
|
|
57
|
-
pnpm run cli -- remove skill oat-idea-scratchpad
|
|
58
|
-
pnpm run cli -- remove skills --pack utility
|
|
59
|
-
```
|
|
44
|
+
Use this path when you are bootstrapping or maintaining a documentation surface with OAT.
|
|
60
45
|
|
|
61
|
-
|
|
46
|
+
Best fit:
|
|
62
47
|
|
|
63
|
-
-
|
|
64
|
-
-
|
|
48
|
+
- you need docs app setup or maintenance workflows
|
|
49
|
+
- you care about docs navigation, docs commands, and docs-specific analysis/apply flows
|
|
50
|
+
- you want the docs-system contract rather than the broader workflow layer
|
|
65
51
|
|
|
66
|
-
|
|
52
|
+
Continue here:
|
|
67
53
|
|
|
68
|
-
|
|
69
|
-
pnpm run cli -- instructions validate
|
|
70
|
-
pnpm run cli -- instructions sync
|
|
71
|
-
```
|
|
54
|
+
- [Docs Tooling](docs-tooling/index.md)
|
|
72
55
|
|
|
73
|
-
|
|
56
|
+
### CLI Utilities
|
|
74
57
|
|
|
75
|
-
-
|
|
76
|
-
- `instructions sync` mutates by default; use `--dry-run` to preview changes.
|
|
77
|
-
- Use `instructions sync --force` if you intend to overwrite mismatched `CLAUDE.md` content.
|
|
58
|
+
Use this path when you want general OAT CLI help outside the dedicated provider-sync, workflows, and docs-tooling lanes.
|
|
78
59
|
|
|
79
|
-
|
|
60
|
+
Best fit:
|
|
80
61
|
|
|
81
|
-
|
|
82
|
-
|
|
83
|
-
|
|
62
|
+
- you want bootstrap/setup guidance
|
|
63
|
+
- you want tool-pack, configuration, local-state, or utility command guidance
|
|
64
|
+
- you want a general CLI surface map rather than one specific product lane
|
|
84
65
|
|
|
85
|
-
|
|
86
|
-
pnpm run cli -- docs init --app-name my-docs
|
|
87
|
-
pnpm run cli -- docs nav sync --target-dir apps/my-docs
|
|
66
|
+
Continue here:
|
|
88
67
|
|
|
89
|
-
|
|
90
|
-
pnpm run cli -- backlog init
|
|
91
|
-
pnpm run cli -- backlog generate-id add-webhook-support --created-at 2026-03-15T14:30:00Z
|
|
92
|
-
pnpm run cli -- backlog regenerate-index
|
|
68
|
+
- [CLI Utilities](cli-utilities/index.md)
|
|
93
69
|
|
|
94
|
-
|
|
95
|
-
pnpm oat:validate-skills
|
|
96
|
-
```
|
|
70
|
+
## If You Are Unsure
|
|
97
71
|
|
|
98
|
-
|
|
72
|
+
Start with the path that best matches the primary thing you need right now.
|
|
99
73
|
|
|
100
|
-
|
|
74
|
+
- If you are trying to sync canonical assets across tools, choose Provider Sync.
|
|
75
|
+
- If you are trying to run a tracked implementation workflow, choose Agentic Workflows.
|
|
76
|
+
- If you are working on the docs system itself, choose Docs Tooling.
|
|
77
|
+
- If you mainly need command-line setup or utility guidance, choose CLI Utilities.
|
|
101
78
|
|
|
102
|
-
|
|
103
|
-
|
|
104
|
-
When `@open-agent-toolkit/cli` is consumed as a built package or linked binary, use `oat` directly:
|
|
105
|
-
|
|
106
|
-
```bash
|
|
107
|
-
oat --help
|
|
108
|
-
oat init --scope project
|
|
109
|
-
oat tools install
|
|
110
|
-
oat status --scope all
|
|
111
|
-
oat sync --scope all
|
|
112
|
-
oat instructions validate
|
|
113
|
-
oat instructions sync
|
|
114
|
-
oat remove skills --pack utility
|
|
115
|
-
oat doctor --scope all
|
|
116
|
-
oat project new my-project --mode spec-driven
|
|
117
|
-
oat backlog init
|
|
118
|
-
oat backlog regenerate-index
|
|
119
|
-
```
|
|
120
|
-
|
|
121
|
-
## Path B: Provider-agnostic tooling (skills + utilities)
|
|
122
|
-
|
|
123
|
-
Use shared skills and helper tooling without adopting the spec-driven OAT project lifecycle.
|
|
124
|
-
|
|
125
|
-
This is also the right path for plan-first ideation that can later be synced/imported into an OAT project.
|
|
126
|
-
|
|
127
|
-
Start here:
|
|
128
|
-
|
|
129
|
-
- [`guide/skills/index.md`](guide/skills/index.md)
|
|
130
|
-
- [`guide/documentation/workflows.md`](guide/documentation/workflows.md)
|
|
131
|
-
- [`guide/documentation/commands.md`](guide/documentation/commands.md)
|
|
132
|
-
- [`guide/documentation/quickstart.md`](guide/documentation/quickstart.md)
|
|
133
|
-
- [`reference/index.md`](reference/index.md)
|
|
134
|
-
|
|
135
|
-
## Path C: Workflow layer (optional)
|
|
136
|
-
|
|
137
|
-
Adopt the workflow layer when you want tracked project artifacts, explicit review gates, and resumable execution state.
|
|
138
|
-
|
|
139
|
-
Start with:
|
|
140
|
-
|
|
141
|
-
- [`guide/workflow/index.md`](guide/workflow/index.md)
|
|
142
|
-
- [`guide/workflow/lifecycle.md`](guide/workflow/lifecycle.md)
|
|
143
|
-
- [`guide/workflow/artifacts.md`](guide/workflow/artifacts.md)
|
|
144
|
-
|
|
145
|
-
Typical entry points:
|
|
146
|
-
|
|
147
|
-
- Spec-driven work: `oat-project-new` or `oat-project-open`, then discovery → spec → design → plan → implement
|
|
148
|
-
- Quick work: `oat-project-quick-start`, then plan or lightweight design as needed before implementation
|
|
149
|
-
- Imported plans: `oat-project-import-plan`, then tracked implementation and review
|
|
150
|
-
|
|
151
|
-
Implementation modes:
|
|
152
|
-
|
|
153
|
-
- `oat-project-implement` for sequential execution
|
|
154
|
-
- `oat-project-subagent-implement` for parallel/subagent-driven execution
|
|
155
|
-
|
|
156
|
-
Review and close-out:
|
|
157
|
-
|
|
158
|
-
- `oat-project-review-provide` / `oat-project-review-receive`
|
|
159
|
-
- `oat-project-pr-progress` or `oat-project-pr-final`
|
|
160
|
-
- `oat-project-document` and `oat-project-complete` when the work is ready to close
|
|
161
|
-
|
|
162
|
-
If you are importing plans from external provider plan folders, set `OAT_PROVIDER_PLAN_DIRS` before running `oat-project-import-plan`.
|
|
79
|
+
You can adopt more than one lane over time. OAT is designed so these sections can be used together or independently.
|
|
@@ -0,0 +1,35 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: CLI Reference
|
|
3
|
+
description: Scannable reference for the current OAT CLI surface, with links to the deeper owning sections for each command family.
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# CLI Reference
|
|
7
|
+
|
|
8
|
+
Use this page when you need a quick map of the OAT CLI rather than the full command-by-command docs. It is intentionally shallow: each section points to the owning page that documents the detailed behavior.
|
|
9
|
+
|
|
10
|
+
The CLI is also a standalone value path. You can use `oat init`, `oat sync`, `oat tools`, docs commands, and repo-analysis commands without adopting the full project workflow.
|
|
11
|
+
|
|
12
|
+
## Contents
|
|
13
|
+
|
|
14
|
+
- [CLI Bootstrap](../cli-utilities/bootstrap.md) - Bootstrap a repo with `oat init`, guided setup, and initial provider adoption.
|
|
15
|
+
- [Tool Packs](../cli-utilities/tool-packs.md) - Install, update, inspect, and remove bundled OAT skills and agents.
|
|
16
|
+
- [Config and Local State](../cli-utilities/config-and-local-state.md) - Config, backlog, local paths, diagnostics, and related utility commands.
|
|
17
|
+
- [Docs Tooling Commands](../docs-tooling/commands.md) - Docs app scaffolding, migration, index generation, and nav sync.
|
|
18
|
+
- [Provider Sync](../provider-sync/index.md) - Sync behavior, provider capabilities, config, and drift management.
|
|
19
|
+
- [Agentic Workflows](../workflows/index.md) - Tracked project execution, skills, ideas, and workflow routing.
|
|
20
|
+
- [Workflow & Projects](../workflows/projects/index.md) - Project lifecycle, artifacts, reviews, PR flow, and state-machine docs.
|
|
21
|
+
- [Repository Analysis](../workflows/projects/repo-analysis.md) - Detailed `oat repo pr-comments ...` behavior.
|
|
22
|
+
|
|
23
|
+
## Command Groups
|
|
24
|
+
|
|
25
|
+
| Command group | What it covers | Go deeper |
|
|
26
|
+
| ----------------------------------------------- | ----------------------------------------------------------------------------------------- | -------------------------------------------------------------------- |
|
|
27
|
+
| `oat init` | Bootstrap canonical OAT directories, sync config, optional hooks, and guided setup. | [CLI Bootstrap](../cli-utilities/bootstrap.md) |
|
|
28
|
+
| `oat tools ...` | Install, inspect, update, and remove bundled OAT tool packs and assets. | [Tool Packs](../cli-utilities/tool-packs.md) |
|
|
29
|
+
| `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) |
|
|
30
|
+
| `oat config ...` / `oat instructions ...` | Config discovery, supported mutations, and instruction-integrity helpers. | [Config and Local State](../cli-utilities/config-and-local-state.md) |
|
|
31
|
+
| `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) |
|
|
32
|
+
| `oat docs ...` | Docs app bootstrap, migration, index generation, nav sync, and docs workflow entrypoints. | [Docs Tooling Commands](../docs-tooling/commands.md) |
|
|
33
|
+
| `oat status` / `oat sync` / `oat providers ...` | Provider sync, drift inspection, provider configuration, and adoption behavior. | [Provider Sync](../provider-sync/index.md) |
|
|
34
|
+
| `oat project ...` / `oat cleanup ...` | Project scaffolding, execution mode, and project/artifact cleanup commands. | [Workflow & Projects](../workflows/projects/index.md) |
|
|
35
|
+
| `oat repo ...` | Repository-level analysis workflows, currently centered on PR comments. | [Repository Analysis](../workflows/projects/repo-analysis.md) |
|
|
@@ -12,7 +12,6 @@ OAT docs navigation is generated from each directory `index.md`, not from hand-m
|
|
|
12
12
|
- Every documentation directory must contain an `index.md`.
|
|
13
13
|
- Every `index.md` must include a `## Contents` section.
|
|
14
14
|
- The `## Contents` section is the only machine-readable source used by `oat docs nav sync`.
|
|
15
|
-
- `overview.md` is deprecated. Replace it with `index.md`, or convert it to a descriptive leaf page when the directory already has its own `index.md`.
|
|
16
15
|
|
|
17
16
|
## `## Contents` format
|
|
18
17
|
|
|
@@ -49,5 +48,5 @@ Generated behavior:
|
|
|
49
48
|
|
|
50
49
|
## If You Are Trying To...
|
|
51
50
|
|
|
52
|
-
- learn the docs workflow or docs commands as a user, start with [
|
|
51
|
+
- learn the docs workflow or docs commands as a user, start with [Docs Tooling](../docs-tooling/index.md)
|
|
53
52
|
- contribute or restructure docs in this repo, pair this contract with [Contributing to OAT Docs](../contributing/documentation.md)
|
|
@@ -5,12 +5,13 @@ description: 'Durable reference material for OAT file locations, docs contracts,
|
|
|
5
5
|
|
|
6
6
|
# Reference
|
|
7
7
|
|
|
8
|
-
Use this section for durable facts and contracts that should stay stable even as the
|
|
8
|
+
Use this section for durable facts and contracts that should stay stable even as the user-facing adoption lanes and contributor flows evolve.
|
|
9
9
|
|
|
10
|
-
Contributor how-to material now lives under `contributing/`, and
|
|
10
|
+
Contributor how-to material now lives under `contributing/`, and user-facing routing now lives in the top-level adoption lanes.
|
|
11
11
|
|
|
12
12
|
## Contents
|
|
13
13
|
|
|
14
|
+
- [CLI Reference](cli-reference.md) - Shallow map of the OAT command surface with links to owning sections.
|
|
14
15
|
- [File Locations](file-locations.md) - Where core OAT files, assets, and artifacts live.
|
|
15
16
|
- [Docs Index Contract](docs-index-contract.md) - Rules for directory `index.md` files and reserved `## Contents` sections.
|
|
16
17
|
- [OAT Directory Structure](oat-directory-structure.md) - Canonical `.oat/` tree map and the role of each major directory.
|
|
@@ -24,6 +25,6 @@ Contributor how-to material now lives under `contributing/`, and audience-routin
|
|
|
24
25
|
|
|
25
26
|
## Related Sections
|
|
26
27
|
|
|
27
|
-
- [CLI Reference](
|
|
28
|
-
- [
|
|
28
|
+
- [CLI Reference](cli-reference.md) for the command-surface map
|
|
29
|
+
- [Docs Tooling](../docs-tooling/index.md) for docs app setup and workflow guidance
|
|
29
30
|
- [Contributing](../contributing/index.md) for code, docs, and skill-authoring practices
|
|
@@ -0,0 +1,40 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: Agentic Workflows
|
|
3
|
+
description: Standalone adoption lane for tracked OAT projects, workflow lifecycle execution, ideas, and workflow-oriented skills.
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# Agentic Workflows
|
|
7
|
+
|
|
8
|
+
Agentic Workflows is the OAT lane for tracked, resumable work on top of the base CLI and provider-sync layers.
|
|
9
|
+
|
|
10
|
+
Use this section when you want explicit project artifacts, stable task IDs, review loops, and resumable execution across longer-running work.
|
|
11
|
+
|
|
12
|
+
## What This Section Is
|
|
13
|
+
|
|
14
|
+
This section explains when workflow mode is worth the overhead, how OAT projects move through lifecycle phases, and how ideas, skills, reviews, and PR flow fit into that model.
|
|
15
|
+
|
|
16
|
+
## Who It's For
|
|
17
|
+
|
|
18
|
+
- Teams doing multi-session or multi-phase work that benefits from tracked artifacts
|
|
19
|
+
- Users who want explicit discovery, planning, implementation, and review state
|
|
20
|
+
- Repos that need a repeatable human-in-the-loop execution model
|
|
21
|
+
|
|
22
|
+
## Start Here
|
|
23
|
+
|
|
24
|
+
- Read [Overview](overview.md) to decide whether you want workflow mode or just direct CLI usage.
|
|
25
|
+
- Use [Skills](skills/index.md) when you want task-oriented guidance on the most useful workflow skills.
|
|
26
|
+
- Go to [Workflow & Projects](projects/index.md) when you need the lifecycle and artifact model in detail.
|
|
27
|
+
|
|
28
|
+
## Common Tasks
|
|
29
|
+
|
|
30
|
+
- Capture or refine early work in [Ideas](ideas/index.md).
|
|
31
|
+
- Understand how tracked projects progress in [Workflow & Projects](projects/index.md).
|
|
32
|
+
- Learn the artifact contract in [Artifacts](projects/artifacts.md).
|
|
33
|
+
- Understand review and PR expectations in [Reviews](projects/reviews.md) and [PR Flow](projects/pr-flow.md).
|
|
34
|
+
|
|
35
|
+
## Go Deeper
|
|
36
|
+
|
|
37
|
+
- [Overview](overview.md) - What the workflow layer adds and when to use it.
|
|
38
|
+
- [Skills](skills/index.md) - Workflow-oriented skill discovery and use-case routing.
|
|
39
|
+
- [Ideas](ideas/index.md) - Idea capture, refinement, and promotion flows.
|
|
40
|
+
- [Workflow & Projects](projects/index.md) - Lifecycle, artifacts, reviews, PR flow, and repository analysis.
|
|
@@ -0,0 +1,38 @@
|
|
|
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
|
|
@@ -0,0 +1,37 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: Workflow & Projects
|
|
3
|
+
description: 'Lifecycle, project artifacts, reviews, PR flow, and repository analysis for tracked OAT projects.'
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# Workflow & Projects
|
|
7
|
+
|
|
8
|
+
Use this section when you want the detailed lifecycle and artifact model behind tracked OAT projects.
|
|
9
|
+
|
|
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
|
+
|
|
12
|
+
## What This Section Is
|
|
13
|
+
|
|
14
|
+
This sub-section is the deep technical surface for how tracked OAT projects execute and how their artifacts, reviews, and PR states fit together.
|
|
15
|
+
|
|
16
|
+
## Start Here
|
|
17
|
+
|
|
18
|
+
- Start with [Lifecycle](lifecycle.md) for the end-to-end flow.
|
|
19
|
+
- Read [Artifacts](artifacts.md) once you need the file contract behind project execution.
|
|
20
|
+
- Use [HiLL Checkpoints](hill-checkpoints.md) when you want to understand pause/approval behavior.
|
|
21
|
+
|
|
22
|
+
## Common Tasks
|
|
23
|
+
|
|
24
|
+
- Understand lifecycle order and alternate lanes in [Lifecycle](lifecycle.md).
|
|
25
|
+
- Learn the artifact system of record in [Artifacts](artifacts.md).
|
|
26
|
+
- Understand lifecycle and review transitions in [State Machine](state-machine.md).
|
|
27
|
+
- Learn review and PR expectations in [Reviews](reviews.md) and [PR Flow](pr-flow.md).
|
|
28
|
+
|
|
29
|
+
## Go Deeper
|
|
30
|
+
|
|
31
|
+
- [Lifecycle](lifecycle.md) - End-to-end flow from discovery through completion.
|
|
32
|
+
- [HiLL Checkpoints](hill-checkpoints.md) - Human-in-the-Loop Lifecycle configuration and approval behavior.
|
|
33
|
+
- [Artifacts](artifacts.md) - What lives in `state.md`, `discovery.md`, `plan.md`, `implementation.md`, and related files.
|
|
34
|
+
- [State Machine](state-machine.md) - Lifecycle and review status transitions across a project.
|
|
35
|
+
- [Reviews](reviews.md) - How review request/receive loops work inside OAT projects.
|
|
36
|
+
- [PR Flow](pr-flow.md) - Progress and final PR generation expectations.
|
|
37
|
+
- [Repository Analysis](repo-analysis.md) - Repo-wide PR comment collection and triage workflows.
|
|
@@ -23,6 +23,12 @@ OAT lifecycle order:
|
|
|
23
23
|
|
|
24
24
|
**Shortcut:** `oat-project-next` reads project state and invokes the correct next skill automatically — use it instead of remembering which skill comes next. Complements `oat-project-progress` (which is read-only diagnostic).
|
|
25
25
|
|
|
26
|
+
## Quick Look
|
|
27
|
+
|
|
28
|
+
- What it does: explains the end-to-end lifecycle for tracked OAT projects, including alternate quick and import lanes.
|
|
29
|
+
- When to use it: when you need the actual project execution model, not just a high-level overview of workflow mode.
|
|
30
|
+
- Primary entry points: `oat-project-new`, `oat-project-quick-start`, `oat-project-import-plan`, `oat-project-implement`
|
|
31
|
+
|
|
26
32
|
## Lifecycle Map
|
|
27
33
|
|
|
28
34
|
```mermaid
|
|
@@ -7,6 +7,12 @@ description: 'Repository-level analysis commands for collecting and triaging PR
|
|
|
7
7
|
|
|
8
8
|
The `oat repo` command group provides repository-level analysis and insight tools. These commands operate across merged pull requests rather than on individual PRs.
|
|
9
9
|
|
|
10
|
+
## Quick Look
|
|
11
|
+
|
|
12
|
+
- What it does: collects and triages review-comment data across merged pull requests so you can mine recurring feedback patterns.
|
|
13
|
+
- When to use it: when you want repo-wide review insight rather than project-by-project execution guidance.
|
|
14
|
+
- Primary commands: `oat repo pr-comments collect`, `oat repo pr-comments triage-collection`
|
|
15
|
+
|
|
10
16
|
## Commands
|
|
11
17
|
|
|
12
18
|
| Command | Purpose |
|
|
@@ -5,6 +5,14 @@ description: 'Workflow and review state transitions across lifecycle phases and
|
|
|
5
5
|
|
|
6
6
|
# State Machine
|
|
7
7
|
|
|
8
|
+
This page is the compact contract for how project lifecycle state and review state advance across a tracked OAT project.
|
|
9
|
+
|
|
10
|
+
## Quick Look
|
|
11
|
+
|
|
12
|
+
- What it does: defines the allowed lifecycle and review-state transitions recorded in `state.md` and `plan.md`.
|
|
13
|
+
- When to use it: when you need to debug lifecycle routing, review posture, or why a project is not advancing to the next phase.
|
|
14
|
+
- Primary artifacts: `state.md`, `plan.md`, `implementation.md`
|
|
15
|
+
|
|
8
16
|
## State Transition Map
|
|
9
17
|
|
|
10
18
|
```mermaid
|
|
@@ -10,7 +10,7 @@ Use this section when you want to choose the right OAT skill for a task. If you
|
|
|
10
10
|
## Contents
|
|
11
11
|
|
|
12
12
|
- [Writing Skills](../../contributing/skills.md) - Contributor guide to skill authoring, contracts, and governance.
|
|
13
|
-
- [Docs Workflows](
|
|
13
|
+
- [Docs Workflows](../../docs-tooling/workflows.md) - How docs CLI helpers and docs skills work together.
|
|
14
14
|
|
|
15
15
|
## Key Skills by Use Case
|
|
16
16
|
|
|
@@ -33,7 +33,7 @@ Use this section when you want to choose the right OAT skill for a task. If you
|
|
|
33
33
|
|
|
34
34
|
- choose the right skill for a task, stay in this guide page
|
|
35
35
|
- write or update a skill, use [Writing Skills](../../contributing/skills.md)
|
|
36
|
-
- understand how docs-specific skills fit with docs commands, use [Docs Workflows](
|
|
36
|
+
- understand how docs-specific skills fit with docs commands, use [Docs Workflows](../../docs-tooling/workflows.md)
|
|
37
37
|
|
|
38
38
|
## Full Catalog
|
|
39
39
|
|
|
File without changes
|
|
File without changes
|