@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.
Files changed (93) hide show
  1. package/LICENSE +21 -0
  2. package/README.md +12 -20
  3. package/assets/docs/{guide/getting-started.md → cli-utilities/bootstrap.md} +8 -2
  4. package/assets/docs/cli-utilities/config-and-local-state.md +84 -0
  5. package/assets/docs/{guide → cli-utilities}/configuration.md +2 -2
  6. package/assets/docs/cli-utilities/index.md +41 -0
  7. package/assets/docs/cli-utilities/overview.md +33 -0
  8. package/assets/docs/{guide → cli-utilities}/tool-packs.md +9 -3
  9. package/assets/docs/contributing/code.md +4 -2
  10. package/assets/docs/contributing/design-principles.md +3 -3
  11. package/assets/docs/contributing/documentation.md +12 -4
  12. package/assets/docs/{guide/documentation/quickstart.md → docs-tooling/add-docs-to-a-repo.md} +1 -1
  13. package/assets/docs/{guide/documentation → docs-tooling}/commands.md +8 -1
  14. package/assets/docs/docs-tooling/index.md +40 -0
  15. package/assets/docs/docs-tooling/overview.md +31 -0
  16. package/assets/docs/{guide/documentation → docs-tooling}/workflows.md +3 -3
  17. package/assets/docs/guide/concepts.md +9 -9
  18. package/assets/docs/guide/index.md +14 -11
  19. package/assets/docs/index.md +34 -18
  20. package/assets/docs/{guide/provider-sync → provider-sync}/commands.md +10 -4
  21. package/assets/docs/{guide/provider-sync → provider-sync}/config.md +1 -1
  22. package/assets/docs/provider-sync/index.md +43 -0
  23. package/assets/docs/{guide/provider-sync → provider-sync}/manifest-and-drift.md +8 -0
  24. package/assets/docs/provider-sync/overview.md +38 -0
  25. package/assets/docs/{guide/provider-sync → provider-sync}/scope-and-surface.md +3 -3
  26. package/assets/docs/quickstart.md +43 -126
  27. package/assets/docs/reference/cli-reference.md +35 -0
  28. package/assets/docs/reference/docs-index-contract.md +1 -2
  29. package/assets/docs/reference/index.md +5 -4
  30. package/assets/docs/workflows/index.md +40 -0
  31. package/assets/docs/workflows/overview.md +38 -0
  32. package/assets/docs/workflows/projects/index.md +37 -0
  33. package/assets/docs/{guide/workflow → workflows/projects}/lifecycle.md +6 -0
  34. package/assets/docs/{guide/workflow → workflows/projects}/repo-analysis.md +6 -0
  35. package/assets/docs/{guide/workflow → workflows/projects}/state-machine.md +8 -0
  36. package/assets/docs/{guide → workflows}/skills/index.md +2 -2
  37. package/assets/public-package-versions.json +4 -4
  38. package/assets/skills/oat-agent-instructions-analyze/scripts/resolve-instruction-files.sh +0 -0
  39. package/assets/skills/oat-agent-instructions-analyze/scripts/resolve-providers.sh +0 -0
  40. package/assets/skills/oat-project-complete/SKILL.md +21 -27
  41. package/assets/skills/oat-project-document/SKILL.md +2 -2
  42. package/assets/skills/oat-project-import-plan/scripts/find-recent-provider-plans.sh +0 -0
  43. package/assets/skills/oat-project-subagent-implement/scripts/dispatch.sh +0 -0
  44. package/assets/skills/oat-project-subagent-implement/scripts/reconcile.sh +0 -0
  45. package/assets/skills/oat-project-subagent-implement/scripts/review-gate.sh +0 -0
  46. package/assets/skills/oat-project-subagent-implement/tests/test-dry-run.sh +0 -0
  47. package/assets/skills/oat-project-subagent-implement/tests/test-reconcile.sh +0 -0
  48. package/assets/skills/oat-project-subagent-implement/tests/test-review-gate.sh +0 -0
  49. package/assets/skills/oat-repo-maintainability-review/scripts/resolve-analysis-output.sh +0 -0
  50. package/assets/skills/oat-review-provide/scripts/resolve-review-output.sh +0 -0
  51. package/assets/skills/oat-worktree-bootstrap-auto/scripts/bootstrap.sh +0 -0
  52. package/dist/app/create-program.js +1 -1
  53. package/dist/commands/docs/index-generate/index.d.ts +1 -0
  54. package/dist/commands/docs/index-generate/index.d.ts.map +1 -1
  55. package/dist/commands/docs/index-generate/index.js +6 -3
  56. package/dist/commands/docs/init/index.d.ts +3 -0
  57. package/dist/commands/docs/init/index.d.ts.map +1 -1
  58. package/dist/commands/docs/init/index.js +52 -3
  59. package/dist/commands/docs/init/resolve-options.d.ts +1 -1
  60. package/dist/commands/docs/init/resolve-options.d.ts.map +1 -1
  61. package/dist/commands/docs/init/resolve-options.js +1 -0
  62. package/dist/commands/docs/init/scaffold.d.ts +1 -0
  63. package/dist/commands/docs/init/scaffold.d.ts.map +1 -1
  64. package/dist/commands/docs/init/scaffold.js +26 -8
  65. package/dist/commands/internal/index.d.ts.map +1 -1
  66. package/dist/commands/internal/index.js +3 -1
  67. package/dist/commands/internal/validate-oat-skills.d.ts +2 -2
  68. package/dist/commands/internal/validate-oat-skills.d.ts.map +1 -1
  69. package/dist/commands/internal/validate-oat-skills.js +5 -4
  70. package/dist/commands/internal/validate-skill-version-bumps.d.ts +10 -0
  71. package/dist/commands/internal/validate-skill-version-bumps.d.ts.map +1 -0
  72. package/dist/commands/internal/validate-skill-version-bumps.js +74 -0
  73. package/dist/commands/project/archive/archive-utils.d.ts.map +1 -1
  74. package/dist/commands/project/archive/archive-utils.js +34 -2
  75. package/dist/manifest/manager.js +1 -1
  76. package/dist/validation/index.d.ts +2 -2
  77. package/dist/validation/index.d.ts.map +1 -1
  78. package/dist/validation/index.js +1 -1
  79. package/dist/validation/skills.d.ts +25 -1
  80. package/dist/validation/skills.d.ts.map +1 -1
  81. package/dist/validation/skills.js +95 -1
  82. package/package.json +17 -17
  83. package/assets/docs/guide/cli-reference.md +0 -211
  84. package/assets/docs/guide/documentation/index.md +0 -27
  85. package/assets/docs/guide/provider-sync/index.md +0 -65
  86. package/assets/docs/guide/workflow/index.md +0 -34
  87. /package/assets/docs/{guide/provider-sync → provider-sync}/providers.md +0 -0
  88. /package/assets/docs/{guide → workflows}/ideas/index.md +0 -0
  89. /package/assets/docs/{guide → workflows}/ideas/lifecycle.md +0 -0
  90. /package/assets/docs/{guide/workflow → workflows/projects}/artifacts.md +0 -0
  91. /package/assets/docs/{guide/workflow → workflows/projects}/hill-checkpoints.md +0 -0
  92. /package/assets/docs/{guide/workflow → workflows/projects}/pr-flow.md +0 -0
  93. /package/assets/docs/{guide/workflow → workflows/projects}/reviews.md +0 -0
package/LICENSE ADDED
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2026 Thomas Stang
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
package/README.md CHANGED
@@ -1,6 +1,6 @@
1
1
  # @open-agent-toolkit/cli
2
2
 
3
- Open Agent Toolkit command-line interface for provider sync, workflow tooling, docs scaffolding, and project hygiene.
3
+ Open Agent Toolkit command-line interface for provider sync, docs tooling, workflow utilities, and diagnostics.
4
4
 
5
5
  ## Install
6
6
 
@@ -8,38 +8,27 @@ Open Agent Toolkit command-line interface for provider sync, workflow tooling, d
8
8
  npm install -g @open-agent-toolkit/cli
9
9
  ```
10
10
 
11
- You can also run it without a global install:
11
+ Run without a global install:
12
12
 
13
13
  ```bash
14
14
  npx @open-agent-toolkit/cli --help
15
15
  ```
16
16
 
17
- ## Usage
17
+ ## Quick Start
18
18
 
19
19
  ```bash
20
20
  oat init --scope project
21
21
  oat status --scope all
22
22
  oat sync --scope all
23
23
  oat config describe
24
- oat config describe archive.s3Uri
25
- oat project archive sync
26
- oat project archive sync my-project
27
- oat docs init --app-name my-docs
28
24
  ```
29
25
 
30
- Archive lifecycle settings are managed through shared repo config:
26
+ Additional useful entry points:
31
27
 
32
- - `archive.s3Uri`
33
- - `archive.s3SyncOnComplete`
34
- - `archive.summaryExportPath`
35
-
36
- Use `oat config describe` to inspect which file owns a setting and which command surface mutates it. Completion writes dated archive snapshots to S3 and exports dated summary snapshots when those archive settings are configured.
37
-
38
- ## Related Packages
39
-
40
- - `@open-agent-toolkit/docs-config`
41
- - `@open-agent-toolkit/docs-theme`
42
- - `@open-agent-toolkit/docs-transforms`
28
+ - `oat tools install`
29
+ - `oat docs init --app-name my-docs`
30
+ - `oat project archive sync`
31
+ - `oat doctor`
43
32
 
44
33
  ## Requirements
45
34
 
@@ -47,4 +36,7 @@ Use `oat config describe` to inspect which file owns a setting and which command
47
36
 
48
37
  ## Docs
49
38
 
50
- Repository and docs: <https://github.com/voxmedia/open-agent-toolkit>
39
+ - [Docs Home](https://voxmedia.github.io/open-agent-toolkit/)
40
+ - [CLI Utilities](https://voxmedia.github.io/open-agent-toolkit/cli-utilities)
41
+ - [Provider Sync](https://voxmedia.github.io/open-agent-toolkit/provider-sync)
42
+ - [Reference](https://voxmedia.github.io/open-agent-toolkit/reference)
@@ -7,6 +7,12 @@ description: 'Foundational setup via oat init for canonical directories, provide
7
7
 
8
8
  This page covers foundational CLI setup commands that prepare OAT structures and configuration before provider sync or tool-pack workflows.
9
9
 
10
+ ## Quick Look
11
+
12
+ - What it does: explains the initial `oat init` setup flow and the optional guided setup path that configures packs, local paths, and provider sync.
13
+ - When to use it: when you are first introducing OAT into a repo or need to re-run the guided setup path on an existing checkout.
14
+ - Primary commands: `oat init`, `oat init --setup`, `oat init --scope project`
15
+
10
16
  ## `oat init`
11
17
 
12
18
  Purpose:
@@ -59,5 +65,5 @@ oat init --scope project
59
65
  Related commands:
60
66
 
61
67
  - `oat tools ...` (tool-pack install, update, remove, list, info): `tool-packs.md`
62
- - `oat local ...`, `oat doctor`, and other utility commands: `cli-reference.md`
63
- - `oat status` / `oat sync` (provider sync): `provider-sync/index.md`
68
+ - `oat local ...`, `oat doctor`, and other utility commands: `config-and-local-state.md`
69
+ - `oat status` / `oat sync` (provider sync): `../provider-sync/index.md`
@@ -0,0 +1,84 @@
1
+ ---
2
+ title: Config and Local State
3
+ description: Utility command groups for config discovery, backlog helpers, local paths, instruction integrity, and diagnostics.
4
+ ---
5
+
6
+ # Config and Local State
7
+
8
+ This page covers the general-purpose OAT command groups that support configuration discovery, local-only state, backlog maintenance, instruction integrity, and diagnostics.
9
+
10
+ Use these commands when you need operational support around the toolkit rather than one of the deeper product lanes.
11
+
12
+ ## `oat backlog ...`
13
+
14
+ Use the `oat backlog` group when you want direct CLI support for the file-backed backlog under `.oat/repo/reference/backlog/`.
15
+
16
+ - `oat backlog init` - scaffold `.oat/repo/reference/backlog/` with starter files and directories for a fresh repo
17
+ - `oat backlog generate-id <filename>` - generate a unique backlog ID from a filename seed
18
+ - `oat backlog generate-id <filename> --created-at <timestamp>` - generate a reproducible ID for a known creation timestamp
19
+ - `oat backlog regenerate-index` - rebuild the managed backlog index table from item frontmatter
20
+
21
+ Run `oat backlog init` first when the local backlog scaffold does not exist yet in a fresh repo. This command group is primarily used by the `oat-pjm-*` project-management skills, but it is also available directly when you need to inspect or repair backlog metadata by hand.
22
+
23
+ ## `oat local ...`
24
+
25
+ `oat local` manages local-only, gitignored paths that still need to follow you between the main repo and worktrees.
26
+
27
+ Common examples:
28
+
29
+ - `.oat/ideas/`
30
+ - `.oat/**/reviews/archived/`
31
+
32
+ Available commands:
33
+
34
+ - `oat local status` - show whether configured local paths exist and are gitignored
35
+ - `oat local apply` - write the managed `.gitignore` section for configured paths
36
+ - `oat local sync` - copy local paths between the main repo and a worktree
37
+ - `oat local add` / `oat local remove` - maintain the `localPaths` config entries
38
+
39
+ Use this when you want archived review history or idea scratchpads to persist locally without being committed.
40
+
41
+ ## `oat config ...`
42
+
43
+ Use `oat config` for repo runtime config inspection and supported key mutation.
44
+
45
+ - `oat config get <key>` - read one resolved config value
46
+ - `oat config set <key> <value>` - update a supported shared or repo-local key
47
+ - `oat config list` - show the resolved command-surface values with source information
48
+ - `oat config describe` - list supported config surfaces and keys across shared repo, repo-local, user, and sync/provider config
49
+ - `oat config describe <key>` - show file location, scope, default, mutability, and owning command for one key
50
+
51
+ Archive lifecycle settings live here as shared repo config:
52
+
53
+ - `archive.s3Uri`
54
+ - `archive.s3SyncOnComplete`
55
+ - `archive.summaryExportPath`
56
+
57
+ When archive settings are configured, completion uploads dated archive snapshots to S3 and exports dated summary snapshots into the configured summary reference directory.
58
+
59
+ Use these reference pages for file ownership and schema details:
60
+
61
+ - [File Locations](../reference/file-locations.md)
62
+ - [`.oat` Directory Structure](../reference/oat-directory-structure.md)
63
+ - [Sync Config (`.oat/sync/config.json`)](../provider-sync/config.md)
64
+
65
+ ## `oat instructions ...`
66
+
67
+ These commands validate and repair pointer integrity between `AGENTS.md` and sibling `CLAUDE.md` files.
68
+
69
+ - `oat instructions validate` - read-only integrity check
70
+ - `oat instructions sync` - preview or apply pointer repairs
71
+
72
+ Use this command group when instruction files drift after manual edits or generated updates.
73
+
74
+ ## Repo state helpers
75
+
76
+ - `oat state refresh` - rebuild the `.oat/state.md` dashboard for the repo
77
+ - `oat index init` - generate a lightweight `project-index.md` for orientation
78
+
79
+ ## Internal helpers and diagnostics
80
+
81
+ - `oat internal validate-oat-skills` - validate `oat-*` skill contracts and metadata
82
+ - `oat doctor` - run environment and setup diagnostics, including installed-vs-bundled skill version checks
83
+
84
+ `oat doctor` is the quickest way to confirm that your runtime, directory structure, and installed OAT assets are healthy before deeper debugging. The `/oat-doctor` skill (installed via the core pack) provides richer diagnostics with check and summary modes, including config explanations sourced from bundled documentation.
@@ -14,7 +14,7 @@ For the deep file-by-file reference, see:
14
14
 
15
15
  - [File Locations](../reference/file-locations.md)
16
16
  - [`.oat` Directory Structure](../reference/oat-directory-structure.md)
17
- - [Sync Config (`.oat/sync/config.json`)](provider-sync/config.md)
17
+ - [Sync Config (`.oat/sync/config.json`)](../provider-sync/config.md)
18
18
 
19
19
  ## The four config surfaces
20
20
 
@@ -117,7 +117,7 @@ Use:
117
117
  - `oat config describe ...` to understand sync keys
118
118
  - `oat providers set ...` to mutate sync/provider settings
119
119
 
120
- For the provider-sync schema details, use [Sync Config (`.oat/sync/config.json`)](provider-sync/config.md).
120
+ For the provider-sync schema details, use [Sync Config (`.oat/sync/config.json`)](../provider-sync/config.md).
121
121
 
122
122
  ## Recommended workflow
123
123
 
@@ -0,0 +1,41 @@
1
+ ---
2
+ title: CLI Utilities
3
+ description: Standalone adoption lane for general OAT CLI surfaces outside provider sync, docs tooling, and tracked workflows.
4
+ ---
5
+
6
+ # CLI Utilities
7
+
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
+
10
+ Use this section when you want bootstrap guidance, tool-pack lifecycle details, configuration help, and general-purpose command references.
11
+
12
+ ## What This Section Is
13
+
14
+ 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
+
16
+ ## Who It's For
17
+
18
+ - Users getting OAT set up in a repo
19
+ - Teams managing installed tool packs and local config
20
+ - People who need a general command map without diving into workflow lifecycle docs
21
+
22
+ ## Start Here
23
+
24
+ - Read [Overview](overview.md) to see what command groups live here and how this section relates to the other adoption lanes.
25
+ - Use [CLI Bootstrap](bootstrap.md) when you are starting with `oat init`.
26
+ - Go to [Tool Packs](tool-packs.md) when you are managing bundled OAT packs and installed assets.
27
+
28
+ ## Common Tasks
29
+
30
+ - Bootstrap OAT in a repo with [CLI Bootstrap](bootstrap.md).
31
+ - Manage installed packs in [Tool Packs](tool-packs.md).
32
+ - Adjust settings in [Configuration](configuration.md).
33
+ - Use [Config and Local State](config-and-local-state.md) for the utility command groups that support inspection and diagnostics.
34
+
35
+ ## Go Deeper
36
+
37
+ - [Overview](overview.md) - What belongs in CLI Utilities and when to use this section.
38
+ - [CLI Bootstrap](bootstrap.md) - Foundational `oat init` guidance outside provider-sync-specific onboarding.
39
+ - [Tool Packs](tool-packs.md) - Bundled packs and `oat tools` lifecycle commands.
40
+ - [Configuration](configuration.md) - OAT configuration guidance.
41
+ - [Config and Local State](config-and-local-state.md) - Utility command groups for config, local state, diagnostics, and related inspection flows.
@@ -0,0 +1,33 @@
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
@@ -7,6 +7,12 @@ description: 'Tool-pack lifecycle commands (oat tools) for installing, updating,
7
7
 
8
8
  This page covers CLI commands that manage bundled OAT tool packs and installed OAT skill/agent assets in canonical directories.
9
9
 
10
+ ## Quick Look
11
+
12
+ - What it does: explains how bundled OAT packs are installed, updated, inspected, and removed.
13
+ - When to use it: when you need to add capabilities to a repo, update installed skills, or understand which packs own which tools.
14
+ - Primary commands: `oat tools list`, `oat tools install`, `oat tools update`, `oat tools remove`
15
+
10
16
  ## Bundled packs at a glance
11
17
 
12
18
  - `core` - foundational diagnostics and docs access (`oat-doctor`, `oat-docs`)
@@ -162,6 +168,6 @@ These commands mutate by default; use `--dry-run` to preview deletions.
162
168
 
163
169
  Related docs:
164
170
 
165
- - Bootstrap (`oat init`): `getting-started.md`
166
- - Provider sync (`oat status`, `oat sync`, `oat providers ...`): `provider-sync/index.md`
167
- - Diagnostics and local-state commands: `cli-reference.md`
171
+ - Bootstrap (`oat init`): `bootstrap.md`
172
+ - Provider sync (`oat status`, `oat sync`, `oat providers ...`): `../provider-sync/index.md`
173
+ - Diagnostics and local-state commands: `config-and-local-state.md`
@@ -69,8 +69,10 @@ not the steady-state path.
69
69
  - Publish the four public packages manually the first time under the new npm
70
70
  org scope.
71
71
  - After those packages exist in npm, configure npm trusted publishing for this
72
- repository so `.github/workflows/release.yml` can become the steady-state
73
- release path without an npm token.
72
+ repository so `.github/workflows/release.yml` can stay the steady-state
73
+ top-level release path without an npm token.
74
+ - In steady state, `release.yml` owns automatic releases from `main` and manual
75
+ reruns for an existing release tag; `ci.yml` remains validation-only.
74
76
  - Use `.github/workflows/release-dry-run.yml` to validate the GitHub path after
75
77
  the npm trust relationship is configured.
76
78
 
@@ -119,6 +119,6 @@ For CLI behavior changes:
119
119
 
120
120
  ## Related Docs
121
121
 
122
- - CLI Reference: [`../guide/cli-reference.md`](../guide/cli-reference.md)
123
- - Provider sync commands: [`../guide/provider-sync/commands.md`](../guide/provider-sync/commands.md)
124
- - Provider sync manifest and drift: [`../guide/provider-sync/manifest-and-drift.md`](../guide/provider-sync/manifest-and-drift.md)
122
+ - CLI Reference: [`../reference/cli-reference.md`](../reference/cli-reference.md)
123
+ - Provider sync commands: [`../provider-sync/commands.md`](../provider-sync/commands.md)
124
+ - Provider sync manifest and drift: [`../provider-sync/manifest-and-drift.md`](../provider-sync/manifest-and-drift.md)
@@ -27,13 +27,21 @@ Documentation should ship with the code it explains. This page covers the core d
27
27
  pnpm build:docs
28
28
  ```
29
29
 
30
- 3. Run Markdown linting:
30
+ 3. Check rendered links against a local or deployed docs host:
31
+
32
+ ```bash
33
+ pnpm docs:check-links
34
+ # or target a local docs server explicitly
35
+ pnpm docs:check-links --url http://127.0.0.1:3000/open-agent-toolkit/
36
+ ```
37
+
38
+ 4. Run Markdown linting:
31
39
 
32
40
  ```bash
33
41
  pnpm --filter oat-docs docs:lint
34
42
  ```
35
43
 
36
- 4. Run Markdown formatting:
44
+ 5. Run Markdown formatting:
37
45
 
38
46
  ```bash
39
47
  pnpm --filter oat-docs docs:format
@@ -60,10 +68,10 @@ Documentation should ship with the code it explains. This page covers the core d
60
68
  ## Related Guides
61
69
 
62
70
  - [Markdown Features](markdown-features.md)
63
- - [Documentation User Guide](../guide/documentation/index.md)
71
+ - [Docs Tooling](../docs-tooling/index.md)
64
72
 
65
73
  ## If You Are Trying To...
66
74
 
67
- - use docs commands or bootstrap a docs app, start with [Documentation User Guide](../guide/documentation/index.md)
75
+ - use docs commands or bootstrap a docs app, start with [Docs Tooling](../docs-tooling/index.md)
68
76
  - follow the authoring contract for `index.md` and navigation, stay on this page and then read [Docs Index Contract](../reference/docs-index-contract.md)
69
77
  - understand supported markdown patterns, use [Markdown Features](markdown-features.md)
@@ -161,4 +161,4 @@ Important:
161
161
 
162
162
  - [`commands.md`](commands.md)
163
163
  - [`workflows.md`](workflows.md)
164
- - [`../../reference/docs-index-contract.md`](../../reference/docs-index-contract.md)
164
+ - [`../reference/docs-index-contract.md`](../reference/docs-index-contract.md)
@@ -9,6 +9,12 @@ OAT includes a dedicated docs command family for bootstrapping and maintaining
9
9
  documentation apps. Two frameworks are supported: **Fumadocs** (Next.js-based)
10
10
  and **MkDocs Material**.
11
11
 
12
+ ## Quick Look
13
+
14
+ - What it does: documents the docs-specific CLI surface for scaffolding apps, migrating markdown, generating indexes, and syncing navigation.
15
+ - When to use it: when you already know you are working on a docs surface and need the exact command-level behavior.
16
+ - Primary commands: `oat docs init`, `oat docs migrate`, `oat docs generate-index`, `oat docs nav sync`
17
+
12
18
  ## Command surface
13
19
 
14
20
  | Command | Purpose |
@@ -50,6 +56,7 @@ Supported flags:
50
56
  - `--target-dir <path>`
51
57
  - `--framework <fumadocs|mkdocs>` (default: `fumadocs` in non-interactive mode)
52
58
  - `--description <text>` (site description, optional)
59
+ - `--lint <none|markdownlint-cli2>`
53
60
  - `--format <oxfmt|none>`
54
61
  - `--yes`
55
62
 
@@ -139,7 +146,7 @@ oat docs nav sync --target-dir apps/oat-docs
139
146
 
140
147
  Related reference:
141
148
 
142
- - [`../../reference/docs-index-contract.md`](../../reference/docs-index-contract.md)
149
+ - [`../reference/docs-index-contract.md`](../reference/docs-index-contract.md)
143
150
 
144
151
  ## `oat docs analyze` and `oat docs apply`
145
152
 
@@ -0,0 +1,40 @@
1
+ ---
2
+ title: Docs Tooling
3
+ description: Standalone adoption lane for docs app setup, docs commands, and docs maintenance workflows.
4
+ ---
5
+
6
+ # Docs Tooling
7
+
8
+ Docs Tooling is the OAT lane for setting up, maintaining, and restructuring a documentation surface with OAT.
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.
11
+
12
+ ## What This Section Is
13
+
14
+ This section explains how OAT supports docs surfaces, how the index contract works in practice, and which commands or workflows to use for bootstrapping, maintenance, and restructure work.
15
+
16
+ ## Who It's For
17
+
18
+ - Repos adding a docs app for the first time
19
+ - Teams maintaining directory indexes and generated navigation
20
+ - Users who want a controlled analyze/apply flow for docs changes
21
+
22
+ ## Start Here
23
+
24
+ - Read [Overview](overview.md) for the docs-tooling model and where Fumadocs versus MkDocs matters.
25
+ - Use [Add Docs to a Repo](add-docs-to-a-repo.md) when you are bootstrapping a docs surface.
26
+ - Go to [Commands](commands.md) when you already have a docs app and need the CLI surface.
27
+
28
+ ## Common Tasks
29
+
30
+ - Bootstrap docs app support with [Add Docs to a Repo](add-docs-to-a-repo.md).
31
+ - Maintain docs structure with [Commands](commands.md).
32
+ - Use the governed workflow in [Workflows](workflows.md).
33
+ - Check the underlying docs contract in [Docs Index Contract](../reference/docs-index-contract.md).
34
+
35
+ ## Go Deeper
36
+
37
+ - [Overview](overview.md) - What docs tooling is for and how the docs contract fits together.
38
+ - [Add Docs to a Repo](add-docs-to-a-repo.md) - Bootstrap a docs app and adopt the docs workflow in a repo.
39
+ - [Commands](commands.md) - Docs CLI surface for init, migration, index generation, and nav sync.
40
+ - [Workflows](workflows.md) - How the docs CLI helpers pair with analyze/apply workflows.
@@ -0,0 +1,31 @@
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
@@ -62,6 +62,6 @@ to open every page.
62
62
  ## Related docs
63
63
 
64
64
  - [`commands.md`](commands.md)
65
- - [`quickstart.md`](quickstart.md)
66
- - [`../../reference/docs-index-contract.md`](../../reference/docs-index-contract.md)
67
- - [`../../contributing/skills.md`](../../contributing/skills.md)
65
+ - [`add-docs-to-a-repo.md`](add-docs-to-a-repo.md)
66
+ - [`../reference/docs-index-contract.md`](../reference/docs-index-contract.md)
67
+ - [`../contributing/skills.md`](../contributing/skills.md)
@@ -33,7 +33,7 @@ flowchart LR
33
33
 
34
34
  Use these docs next:
35
35
 
36
- - [Provider Sync](provider-sync/index.md)
36
+ - [Provider Sync](../provider-sync/index.md)
37
37
  - [Reference](../reference/index.md)
38
38
 
39
39
  ## Sync, Drift, and Adoption
@@ -42,8 +42,8 @@ Use these docs next:
42
42
 
43
43
  Use these docs next:
44
44
 
45
- - [Provider Sync Commands](provider-sync/commands.md)
46
- - [Manifest and Drift](provider-sync/manifest-and-drift.md)
45
+ - [Provider Sync Commands](../provider-sync/commands.md)
46
+ - [Manifest and Drift](../provider-sync/manifest-and-drift.md)
47
47
 
48
48
  ## Scopes
49
49
 
@@ -51,8 +51,8 @@ Most OAT operations run in one of three scopes: `project`, `user`, or `all`. Pro
51
51
 
52
52
  Use these docs next:
53
53
 
54
- - [Scope and Surface](provider-sync/scope-and-surface.md)
55
- - [CLI Reference](cli-reference.md)
54
+ - [Scope and Surface](../provider-sync/scope-and-surface.md)
55
+ - [CLI Reference](../reference/cli-reference.md)
56
56
 
57
57
  ## Skills and CLI Commands
58
58
 
@@ -60,7 +60,7 @@ Skills are structured workflow instructions stored in `.agents/skills`, while CL
60
60
 
61
61
  Use these docs next:
62
62
 
63
- - [Skills](skills/index.md)
63
+ - [Skills](../workflows/skills/index.md)
64
64
  - [Contributing Skills](../contributing/skills.md)
65
65
 
66
66
  ## The Three Usage Modes
@@ -76,7 +76,7 @@ These layers stack. You can stay at the interop layer, use only the tooling laye
76
76
  Use these docs next:
77
77
 
78
78
  - [Quickstart](../quickstart.md)
79
- - [Workflow & Projects](workflow/index.md)
79
+ - [Workflow & Projects](../workflows/projects/index.md)
80
80
 
81
81
  ## Human-in-the-Loop Lifecycle
82
82
 
@@ -84,5 +84,5 @@ The workflow system supports explicit checkpoints so a project can pause at sele
84
84
 
85
85
  Use these docs next:
86
86
 
87
- - [Workflow & Projects](workflow/index.md)
88
- - [Hill Checkpoints](workflow/hill-checkpoints.md)
87
+ - [Workflow & Projects](../workflows/projects/index.md)
88
+ - [Hill Checkpoints](../workflows/projects/hill-checkpoints.md)
@@ -5,16 +5,19 @@ description: User-facing guide for operating OAT across provider sync, docs tool
5
5
 
6
6
  # User Guide
7
7
 
8
- Use this section when you want to operate OAT as a user of the toolkit rather than contribute to the codebase itself.
8
+ This page is now a compatibility router.
9
9
 
10
- ## Contents
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
- - [Core Concepts](concepts.md) - Mental model for canonical assets, provider views, scopes, skills, and workflow layers.
13
- - [Getting Started](getting-started.md) - Foundational CLI setup and guided `oat init` usage.
14
- - [Provider Sync](provider-sync/index.md) - Provider interoperability, drift, sync, and config behavior.
15
- - [Tool Packs](tool-packs.md) - Install, update, and remove bundled OAT tool packs.
16
- - [Documentation](documentation/index.md) - Docs app setup, docs commands, and docs workflow entry points.
17
- - [Workflow & Projects](workflow/index.md) - Lifecycle, project artifacts, reviews, PR flow, and repo analysis docs.
18
- - [Skills](skills/index.md) - Skill families and recommended entry points by use case.
19
- - [Ideas](ideas/index.md) - Lightweight brainstorming and idea capture flow.
20
- - [CLI Reference](cli-reference.md) - Scannable command-group reference for the current OAT CLI surface.
12
+ ## Canonical Sections
13
+
14
+ - [Provider Sync](../provider-sync/index.md) - Provider interoperability, drift, sync, and config behavior.
15
+ - [Agentic Workflows](../workflows/index.md) - Tracked projects, ideas, workflow skills, and lifecycle execution.
16
+ - [Docs Tooling](../docs-tooling/index.md) - Docs app setup, docs commands, and docs workflow entry points.
17
+ - [CLI Utilities](../cli-utilities/index.md) - Bootstrap, tool packs, configuration, and general CLI surfaces.
18
+ - [Reference](../reference/index.md) - Durable contracts and reference material.
19
+
20
+ ## Legacy Pages Still Under Guide
21
+
22
+ - [Core Concepts](concepts.md) - High-level mental model while concept material is being redistributed.
23
+ - This guide bucket is being retired. Use the canonical top-level sections above for active documentation.
@@ -15,27 +15,34 @@ OAT is organized as three distinct capabilities that can be used together or ind
15
15
 
16
16
  ## Contents
17
17
 
18
- - [Quickstart](quickstart.md) - Shared entry point for interop-only, tooling, and workflow adoption.
19
- - [User Guide](guide/index.md) - User-facing guide for provider sync, docs tooling, workflow execution, skills, and ideas.
18
+ - [Quickstart](quickstart.md) - Canonical Start Here page for choosing the right OAT adoption path.
19
+ - [Provider Sync](provider-sync/index.md) - Canonical section for provider interoperability, drift management, and canonical-to-provider sync.
20
+ - [Agentic Workflows](workflows/index.md) - Canonical section for tracked project workflows, ideas, lifecycle execution, and workflow-oriented skills.
21
+ - [Docs Tooling](docs-tooling/index.md) - Canonical section for docs app setup, docs commands, and docs maintenance workflows.
22
+ - [CLI Utilities](cli-utilities/index.md) - Canonical section for general OAT CLI surfaces outside provider sync, docs tooling, and tracked workflows.
20
23
  - [Contributing](contributing/index.md) - Contributor-facing guide for code, docs, markdown features, and skill authoring.
21
24
  - [Reference](reference/index.md) - Durable reference material for operating and maintaining OAT.
22
25
 
23
- ## Choose a usage path
24
-
25
- - Provider sync and CLI users:
26
- - Start with [`quickstart.md`](quickstart.md)
27
- - Then [`guide/provider-sync/index.md`](guide/provider-sync/index.md) and [`guide/cli-reference.md`](guide/cli-reference.md)
28
- - Docs-tooling users:
29
- - Start with [`guide/documentation/index.md`](guide/documentation/index.md)
30
- - Then [`guide/documentation/commands.md`](guide/documentation/commands.md)
31
- - Workflow users:
32
- - Start with [`quickstart.md`](quickstart.md)
33
- - Then [`guide/workflow/index.md`](guide/workflow/index.md), [`guide/skills/index.md`](guide/skills/index.md), and [`reference/index.md`](reference/index.md)
34
- - Contributors:
35
- - Start with [`contributing/index.md`](contributing/index.md)
36
- - Then route into code, docs, markdown features, or skill authoring guidance
37
- - Idea and backlog users:
38
- - Start with [`guide/ideas/index.md`](guide/ideas/index.md)
26
+ ## Why OAT Exists
27
+
28
+ Teams often need some combination of:
29
+
30
+ - provider-specific agent instructions that stay aligned from one tool to another
31
+ - reusable skills and helper tooling that do not depend on one provider
32
+ - a more structured workflow for longer-running implementation work
33
+
34
+ OAT exists to make those layers work together without forcing teams to adopt all of them at once.
35
+
36
+ ## Start Here
37
+
38
+ If you are new to OAT, start with [Quickstart](quickstart.md).
39
+
40
+ That page is the canonical path-selection guide. Use it to choose whether you need:
41
+
42
+ - provider sync
43
+ - agentic workflows
44
+ - docs tooling
45
+ - general CLI utilities
39
46
 
40
47
  ## Source-of-truth hierarchy
41
48
 
@@ -43,3 +50,12 @@ OAT is organized as three distinct capabilities that can be used together or ind
43
50
  2. Skill behavior contracts: `.agents/skills/*/SKILL.md`
44
51
  3. OAT templates and runtime state: `.oat/templates/**`, `.oat/sync/**`, `.oat/config.json`, `.oat/config.local.json`
45
52
  4. Repo reference records: `.oat/repo/**`
53
+
54
+ ## Where To Go Next
55
+
56
+ - New to OAT: [Quickstart](quickstart.md)
57
+ - Need canonical-to-provider sync: [Provider Sync](provider-sync/index.md)
58
+ - Need tracked project execution: [Agentic Workflows](workflows/index.md)
59
+ - Need docs app or docs maintenance tooling: [Docs Tooling](docs-tooling/index.md)
60
+ - Need general command-line help: [CLI Utilities](cli-utilities/index.md)
61
+ - Need stable contracts and reference material: [Reference](reference/index.md)