@open-agent-toolkit/cli 0.1.30 → 0.1.32
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/config-and-local-state.md +18 -5
- package/assets/docs/cli-utilities/tool-packs.md +13 -8
- package/assets/docs/reference/cli-reference.md +14 -13
- package/assets/docs/reference/file-locations.md +2 -1
- package/assets/docs/reference/oat-directory-structure.md +35 -22
- package/assets/migration/pjm-restructure.md +500 -0
- package/assets/public-package-versions.json +4 -4
- package/assets/skills/deep-research/SKILL.md +2 -2
- package/assets/skills/oat-brainstorm/SKILL.md +3 -3
- package/assets/skills/oat-brainstorm/references/destinations.md +10 -2
- package/assets/skills/oat-brainstorm/references/dogfood-results.md +4 -4
- package/assets/skills/oat-pjm-add-backlog-item/SKILL.md +17 -20
- package/assets/skills/oat-pjm-decision/SKILL.md +129 -0
- package/assets/skills/oat-pjm-review-backlog/SKILL.md +17 -17
- package/assets/skills/oat-pjm-review-backlog/references/backlog-review-template.md +2 -2
- package/assets/skills/oat-pjm-review-backlog/references/priority-alignment-template.md +13 -13
- package/assets/skills/oat-pjm-update-repo-reference/SKILL.md +34 -25
- package/assets/skills/oat-project-complete/SKILL.md +2 -2
- package/assets/skills/oat-project-document/SKILL.md +4 -3
- package/assets/skills/oat-project-import-plan/SKILL.md +2 -2
- package/assets/skills/oat-project-summary/SKILL.md +76 -8
- package/assets/templates/backlog-item.md +1 -1
- package/assets/templates/current-state.md +11 -2
- package/assets/templates/decision.md +18 -0
- package/assets/templates/pjm-agents.md +13 -0
- package/assets/templates/reference-agents.md +14 -0
- package/assets/templates/repo-agents.md +13 -0
- package/assets/templates/roadmap.md +8 -3
- package/dist/commands/backlog/index.d.ts +1 -0
- package/dist/commands/backlog/index.d.ts.map +1 -1
- package/dist/commands/backlog/index.js +48 -11
- package/dist/commands/backlog/init.js +1 -1
- package/dist/commands/backlog/regenerate-index.d.ts.map +1 -1
- package/dist/commands/backlog/regenerate-index.js +24 -5
- package/dist/commands/backlog/shared/generate-id.d.ts +1 -3
- package/dist/commands/backlog/shared/generate-id.d.ts.map +1 -1
- package/dist/commands/backlog/shared/generate-id.js +4 -64
- package/dist/commands/cleanup/artifacts/artifacts.d.ts.map +1 -1
- package/dist/commands/cleanup/artifacts/artifacts.js +4 -1
- package/dist/commands/decision/index.d.ts +20 -0
- package/dist/commands/decision/index.d.ts.map +1 -0
- package/dist/commands/decision/index.js +177 -0
- package/dist/commands/decision/init.d.ts +7 -0
- package/dist/commands/decision/init.d.ts.map +1 -0
- package/dist/commands/decision/init.js +53 -0
- package/dist/commands/decision/migrate.d.ts +24 -0
- package/dist/commands/decision/migrate.d.ts.map +1 -0
- package/dist/commands/decision/migrate.js +270 -0
- package/dist/commands/decision/new.d.ts +16 -0
- package/dist/commands/decision/new.d.ts.map +1 -0
- package/dist/commands/decision/new.js +118 -0
- package/dist/commands/decision/regenerate-index.d.ts +14 -0
- package/dist/commands/decision/regenerate-index.d.ts.map +1 -0
- package/dist/commands/decision/regenerate-index.js +122 -0
- package/dist/commands/decision/shared/generate-id.d.ts +2 -0
- package/dist/commands/decision/shared/generate-id.d.ts.map +1 -0
- package/dist/commands/decision/shared/generate-id.js +5 -0
- package/dist/commands/doctor/index.d.ts +2 -0
- package/dist/commands/doctor/index.d.ts.map +1 -1
- package/dist/commands/doctor/index.js +6 -0
- package/dist/commands/index.d.ts.map +1 -1
- package/dist/commands/index.js +2 -0
- package/dist/commands/init/tools/shared/skill-manifest.d.ts +2 -2
- package/dist/commands/init/tools/shared/skill-manifest.d.ts.map +1 -1
- package/dist/commands/init/tools/shared/skill-manifest.js +5 -1
- package/dist/commands/pjm/doctor.d.ts +3 -0
- package/dist/commands/pjm/doctor.d.ts.map +1 -0
- package/dist/commands/pjm/doctor.js +238 -0
- package/dist/commands/pjm/index.d.ts +7 -0
- package/dist/commands/pjm/index.d.ts.map +1 -1
- package/dist/commands/pjm/index.js +132 -10
- package/dist/commands/pjm/init.d.ts +3 -2
- package/dist/commands/pjm/init.d.ts.map +1 -1
- package/dist/commands/pjm/init.js +42 -33
- package/dist/commands/pjm/migrate.d.ts +36 -0
- package/dist/commands/pjm/migrate.d.ts.map +1 -0
- package/dist/commands/pjm/migrate.js +393 -0
- package/dist/commands/shared/date-id.d.ts +2 -0
- package/dist/commands/shared/date-id.d.ts.map +1 -0
- package/dist/commands/shared/date-id.js +10 -0
- package/dist/commands/shared/managed-index.d.ts +22 -0
- package/dist/commands/shared/managed-index.d.ts.map +1 -0
- package/dist/commands/shared/managed-index.js +92 -0
- package/dist/commands/shared/slug.d.ts +2 -0
- package/dist/commands/shared/slug.d.ts.map +1 -0
- package/dist/commands/shared/slug.js +57 -0
- package/dist/commands/shared/strip-template-frontmatter.d.ts +2 -0
- package/dist/commands/shared/strip-template-frontmatter.d.ts.map +1 -0
- package/dist/commands/shared/strip-template-frontmatter.js +16 -0
- package/dist/engine/hook.d.ts.map +1 -1
- package/dist/engine/hook.js +13 -0
- package/dist/release/public-package-contract.d.ts.map +1 -1
- package/dist/release/public-package-contract.js +10 -1
- package/package.json +2 -2
- package/assets/templates/decision-record.md +0 -21
|
@@ -11,16 +11,29 @@ Use these commands when you need operational support around the toolkit rather t
|
|
|
11
11
|
|
|
12
12
|
## `oat backlog ...`
|
|
13
13
|
|
|
14
|
-
Use the `oat backlog` group when you want direct CLI support for the file-backed backlog under `.oat/repo/
|
|
14
|
+
Use the `oat backlog` group when you want direct CLI support for the file-backed backlog under `.oat/repo/pjm/backlog/`.
|
|
15
15
|
|
|
16
|
-
- `oat backlog init` - scaffold `.oat/repo/
|
|
17
|
-
- `oat backlog generate-id <
|
|
18
|
-
- `oat backlog generate-id <
|
|
16
|
+
- `oat backlog init` - scaffold `.oat/repo/pjm/backlog/` with starter files and directories for a fresh repo
|
|
17
|
+
- `oat backlog generate-id <title>` - generate a deterministic `BL-YYMMDD-slug` backlog ID from a title
|
|
18
|
+
- `oat backlog generate-id <title> --created-at <timestamp>` - generate a reproducible ID for a known creation timestamp
|
|
19
19
|
- `oat backlog regenerate-index` - rebuild the managed backlog index table from item frontmatter
|
|
20
20
|
|
|
21
|
+
Backlog IDs are deterministic date+slug identifiers (`BL-YYMMDD-slug`) derived from the creation date and title, so two machines or worktrees produce the same ID for the same record without scanning the local checkout. The slug is capped at 30 characters at the last whole-word boundary (with trailing stop-words trimmed), so prefer concise, meaningful titles. Index regeneration is deterministic and safe to re-run when resolving an index merge conflict.
|
|
22
|
+
|
|
21
23
|
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
24
|
|
|
23
|
-
For full project-management repo-reference setup, use [`oat pjm init`](tool-packs.md#install-vs-initialize). It scaffolds `current-state.md`, `roadmap.md`, `
|
|
25
|
+
For full project-management repo-reference setup, use [`oat pjm init`](tool-packs.md#install-vs-initialize). It scaffolds the two-layer PJM surface (`pjm/current-state.md`, `pjm/roadmap.md`, `reference/decisions/`, and AGENTS guides) and delegates the backlog sub-surface to `oat backlog init`.
|
|
26
|
+
|
|
27
|
+
## `oat decision ...`
|
|
28
|
+
|
|
29
|
+
Use the `oat decision` group for file-per-record decisions under `.oat/repo/reference/decisions/`. Each decision is its own file with a deterministic `DR-YYMMDD-slug` ID (the slug is capped at 30 characters at the last whole-word boundary, with trailing stop-words trimmed), and the human-facing index is a committed generated view.
|
|
30
|
+
|
|
31
|
+
- `oat decision init` - scaffold `.oat/repo/reference/decisions/` and the managed decision index
|
|
32
|
+
- `oat decision new <title>` - create a new decision record; supports `--status`, `--context`, and `--created-at`
|
|
33
|
+
- `oat decision regenerate-index` - rebuild the managed decision index table from record frontmatter
|
|
34
|
+
- `oat decision migrate` - convert a legacy single `decision-record.md` into file-per-record decisions, preserving each old `ADR-NNN`/`DR-NNN` ID as `legacy_id`; applies by default, so pass `--dry-run` to preview the legacy-to-new mappings without writing, and `--delete-legacy` to remove the source file after a verified migration (unlike `oat pjm migrate`, which defaults to dry-run)
|
|
35
|
+
|
|
36
|
+
The decision index uses managed marker pairs and is deterministic, so an index merge conflict can be resolved by re-running `oat decision regenerate-index` and staging the result. Decision records replace the legacy single `decision-record.md`; repos still on the old layout migrate with `oat decision migrate` (or the broader `oat pjm migrate`).
|
|
24
37
|
|
|
25
38
|
## `oat local ...`
|
|
26
39
|
|
|
@@ -20,7 +20,7 @@ This page covers CLI commands that manage bundled OAT tool packs and installed O
|
|
|
20
20
|
- `workflows` - project lifecycle skills, wrap-up reporting, reviewer agents, and core project templates
|
|
21
21
|
- `ideas` - lightweight ideation and promotion flows
|
|
22
22
|
- `utility` - review and repo-maintenance helpers
|
|
23
|
-
- `project-management` - file-backed backlog/reference skills plus backlog, roadmap, current-state, and
|
|
23
|
+
- `project-management` - file-backed backlog/reference skills plus backlog, roadmap, current-state, file-per-record decision, and AGENTS-guide templates
|
|
24
24
|
- `research` - research, analysis, comparison, and synthesis skills
|
|
25
25
|
- `brainstorm` - always-on brainstorming entry point with visual companion
|
|
26
26
|
|
|
@@ -33,7 +33,7 @@ The `oat tools` command group provides a unified interface for managing installe
|
|
|
33
33
|
The `project-management` pack has two lifecycle steps:
|
|
34
34
|
|
|
35
35
|
- **Install**: `oat tools install project-management` (or the legacy `oat init tools project-management`) copies project-management skills into `.agents/skills/` and template sources into `.oat/templates/`.
|
|
36
|
-
- **Initialize**: `oat pjm init` instantiates the working repo-reference surface under `.oat/repo
|
|
36
|
+
- **Initialize**: `oat pjm init` instantiates the two-layer working repo-reference surface under `.oat/repo/`.
|
|
37
37
|
|
|
38
38
|
Installing the pack makes the skills and templates available; it does not create the repo's working project-management reference docs. Run `oat pjm init` when you want to scaffold the canonical PJM surface for a repo:
|
|
39
39
|
|
|
@@ -41,18 +41,23 @@ Installing the pack makes the skills and templates available; it does not create
|
|
|
41
41
|
oat pjm init
|
|
42
42
|
```
|
|
43
43
|
|
|
44
|
-
The command creates missing files and directories for:
|
|
44
|
+
The canonical surface splits active operational state (under `pjm/`) from durable append-mostly references (under `reference/`). The command creates missing files and directories for:
|
|
45
45
|
|
|
46
|
-
- `.oat/repo/
|
|
47
|
-
- `.oat/repo/
|
|
48
|
-
- `.oat/repo/
|
|
49
|
-
- `.oat/repo/reference/
|
|
46
|
+
- `.oat/repo/pjm/current-state.md`
|
|
47
|
+
- `.oat/repo/pjm/roadmap.md`
|
|
48
|
+
- `.oat/repo/pjm/backlog/`
|
|
49
|
+
- `.oat/repo/reference/decisions/` (file-per-record decisions plus a generated index)
|
|
50
|
+
- AGENTS guides at `.oat/repo/AGENTS.md`, `.oat/repo/pjm/AGENTS.md`, and `.oat/repo/reference/AGENTS.md`
|
|
51
|
+
|
|
52
|
+
Decisions are now file-per-record under `reference/decisions/` (created and indexed with the [`oat decision`](config-and-local-state.md#oat-decision-) command group), replacing the legacy single `decision-record.md`. Repos still on the old `reference/` layout can migrate with `oat pjm migrate`.
|
|
50
53
|
|
|
51
54
|
`oat pjm init` is idempotent and non-destructive. Existing reference docs are skipped and left unchanged, so curated repo state is not overwritten on repeated runs.
|
|
52
55
|
|
|
56
|
+
Run `oat pjm doctor` to check an existing surface: it reports missing canonical files, leftover template frontmatter, and legacy/loose/second-roadmap drift, and accepts `--json` for machine-readable output. The same checks also run under project-scope `oat doctor` when `.oat/repo` exists.
|
|
57
|
+
|
|
53
58
|
Useful options:
|
|
54
59
|
|
|
55
|
-
- `--
|
|
60
|
+
- `--repo-root <path>` - scaffold a different repo-reference root instead of `.oat/repo`
|
|
56
61
|
- `--json` - emit a machine-readable result with created and skipped paths
|
|
57
62
|
|
|
58
63
|
Backlog scaffolding is delegated to the lower-level [`oat backlog init`](config-and-local-state.md#oat-backlog-) helper. Use `oat pjm init` for the full PJM repo-reference surface, and use `oat backlog init` directly only when you need to create or repair the backlog sub-surface by itself.
|
|
@@ -37,19 +37,20 @@ The first practical expansion path is to keep improving the existing owners: [Do
|
|
|
37
37
|
|
|
38
38
|
## Command Groups
|
|
39
39
|
|
|
40
|
-
| Command group | What it covers
|
|
41
|
-
| ----------------------------------------------- |
|
|
42
|
-
| `oat init` | Bootstrap canonical OAT directories, sync config, optional hooks, and guided setup.
|
|
43
|
-
| `oat tools ...` | Install, inspect, update, and remove bundled OAT tool packs and assets.
|
|
44
|
-
| `oat pjm ...` | Initialize the
|
|
45
|
-
| `oat
|
|
46
|
-
| `oat
|
|
47
|
-
| `oat
|
|
48
|
-
| `oat
|
|
49
|
-
| `oat
|
|
50
|
-
| `oat
|
|
51
|
-
| `oat
|
|
52
|
-
| `oat
|
|
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 two-layer repo-reference surface (`init`), run reference diagnostics (`doctor`), and migrate legacy layouts to `pjm/` + `reference/` (`migrate`) after installing the project-management pack. | [Install vs. initialize](../cli-utilities/tool-packs.md#install-vs-initialize) |
|
|
45
|
+
| `oat decision ...` | Create, index, and migrate file-per-record repo decisions under `reference/decisions/` (`init`, `new`, `regenerate-index`, `migrate`). | [Config and Local State](../cli-utilities/config-and-local-state.md#oat-decision-) |
|
|
46
|
+
| `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) |
|
|
47
|
+
| `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) |
|
|
48
|
+
| `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) |
|
|
49
|
+
| `oat docs ...` | Docs app bootstrap, migration, index generation, nav sync, and docs workflow entrypoints. | [Docs Tooling Commands](../docs-tooling/commands.md) |
|
|
50
|
+
| `oat status` / `oat sync` / `oat providers ...` | Provider sync, drift inspection, provider configuration, and adoption behavior. | [Provider Sync](../provider-sync/index.md) |
|
|
51
|
+
| `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) |
|
|
52
|
+
| `oat review ...` | Review artifact discovery helpers, including latest-review resolution for project and ad-hoc review flows. | [Reviews](../workflows/projects/reviews.md) |
|
|
53
|
+
| `oat repo ...` | Repository-level workflows such as archive sync and PR-comment analysis. | [Repository Analysis](../workflows/projects/repo-analysis.md) |
|
|
53
54
|
|
|
54
55
|
Notable commands introduced in the current CLI surface:
|
|
55
56
|
|
|
@@ -43,7 +43,8 @@ Config ownership note:
|
|
|
43
43
|
- Templates: `.oat/templates/`
|
|
44
44
|
- Runtime sync state: `.oat/sync/`
|
|
45
45
|
- Repo knowledge: `.oat/repo/knowledge/`
|
|
46
|
-
-
|
|
46
|
+
- Active PJM operational layer: `.oat/repo/pjm/` (`current-state.md`, `roadmap.md`, `backlog/`)
|
|
47
|
+
- Durable repo references: `.oat/repo/reference/` (file-per-record decisions under `decisions/`)
|
|
47
48
|
- Repo reviews: `.oat/repo/reviews/`
|
|
48
49
|
- Repo archive: `.oat/repo/archive/`
|
|
49
50
|
|
|
@@ -34,6 +34,7 @@ Project scope is used for project workflows and repo-local sync state. User scop
|
|
|
34
34
|
scripts/
|
|
35
35
|
repo/
|
|
36
36
|
knowledge/
|
|
37
|
+
pjm/
|
|
37
38
|
reference/
|
|
38
39
|
reviews/
|
|
39
40
|
archive/
|
|
@@ -41,16 +42,16 @@ Project scope is used for project workflows and repo-local sync state. User scop
|
|
|
41
42
|
|
|
42
43
|
## Top-level entries
|
|
43
44
|
|
|
44
|
-
| Path | Purpose
|
|
45
|
-
| ------------------------ |
|
|
46
|
-
| `.oat/config.json` | Shared repo runtime config for non-sync settings
|
|
47
|
-
| `.oat/config.local.json` | Local per-developer runtime state
|
|
48
|
-
| `.oat/state.md` | Generated repo state dashboard
|
|
49
|
-
| `.oat/projects/` | OAT project artifacts
|
|
50
|
-
| `.oat/ideas/` | Project-level ideas store
|
|
51
|
-
| `.oat/sync/` | Interop sync state/config
|
|
52
|
-
| `.oat/templates/` | Artifact templates used by OAT skills
|
|
53
|
-
| `.oat/repo/` | Repo-level knowledge/reference/review artifacts
|
|
45
|
+
| Path | Purpose | Notes |
|
|
46
|
+
| ------------------------ | --------------------------------------------------- | ------------------------------------------------------------------------------------------------------- |
|
|
47
|
+
| `.oat/config.json` | Shared repo runtime config for non-sync settings | Includes `worktrees.root`, `projects.root`, `git.defaultBranch`, `archive.*`, and `documentation.*` |
|
|
48
|
+
| `.oat/config.local.json` | Local per-developer runtime state | Gitignored; includes `activeProject`, `lastPausedProject`, `activeIdea` |
|
|
49
|
+
| `.oat/state.md` | Generated repo state dashboard | Gitignored; rebuilt with `oat state refresh` from config, project artifacts, and knowledge metadata |
|
|
50
|
+
| `.oat/projects/` | OAT project artifacts | `shared`, `local`, `archived` scopes |
|
|
51
|
+
| `.oat/ideas/` | Project-level ideas store | Often gitignored |
|
|
52
|
+
| `.oat/sync/` | Interop sync state/config | See details below |
|
|
53
|
+
| `.oat/templates/` | Artifact templates used by OAT skills | Source for scaffolding. Includes `docs-app-fuma/` (Fumadocs) and `docs-app-mkdocs/` (MkDocs) templates. |
|
|
54
|
+
| `.oat/repo/` | Repo-level PJM/knowledge/reference/review artifacts | Active PJM state under `pjm/`; durable references (including decisions) under `reference/` |
|
|
54
55
|
|
|
55
56
|
## `.oat/sync/` details
|
|
56
57
|
|
|
@@ -210,23 +211,35 @@ Not all workflow modes require every artifact:
|
|
|
210
211
|
|
|
211
212
|
## `.oat/repo/` structure
|
|
212
213
|
|
|
213
|
-
| Path | Purpose
|
|
214
|
-
| ---------------------- |
|
|
215
|
-
| `.oat/repo/knowledge/` | Generated codebase knowledge indexes
|
|
216
|
-
| `.oat/repo/
|
|
217
|
-
| `.oat/repo/
|
|
218
|
-
| `.oat/repo/
|
|
214
|
+
| Path | Purpose |
|
|
215
|
+
| ---------------------- | ---------------------------------------------------------------------------------------- |
|
|
216
|
+
| `.oat/repo/knowledge/` | Generated codebase knowledge indexes |
|
|
217
|
+
| `.oat/repo/pjm/` | Active operational PJM layer (`current-state.md`, `roadmap.md`, and `backlog/`) |
|
|
218
|
+
| `.oat/repo/reference/` | Durable append-mostly references, including file-per-record decisions under `decisions/` |
|
|
219
|
+
| `.oat/repo/reviews/` | Repo-scoped review artifacts (ad-hoc/non-project) |
|
|
220
|
+
| `.oat/repo/archive/` | Archived repo-level artifacts |
|
|
219
221
|
|
|
220
|
-
Canonical project-management repo-reference surface
|
|
222
|
+
Canonical project-management repo-reference surface splits the active
|
|
223
|
+
operational layer (`pjm/`) from durable references (`reference/`):
|
|
221
224
|
|
|
222
225
|
```text
|
|
223
|
-
.oat/repo/
|
|
224
|
-
|
|
225
|
-
|
|
226
|
-
|
|
227
|
-
|
|
226
|
+
.oat/repo/
|
|
227
|
+
AGENTS.md
|
|
228
|
+
pjm/
|
|
229
|
+
AGENTS.md
|
|
230
|
+
current-state.md
|
|
231
|
+
roadmap.md
|
|
232
|
+
backlog/
|
|
233
|
+
reference/
|
|
234
|
+
AGENTS.md
|
|
235
|
+
decisions/
|
|
228
236
|
```
|
|
229
237
|
|
|
238
|
+
Decisions are file-per-record under `reference/decisions/` (managed with the
|
|
239
|
+
`oat decision` command group), replacing the legacy single
|
|
240
|
+
`reference/decision-record.md`. Repos still on the old single-`reference/`
|
|
241
|
+
layout migrate with `oat pjm migrate`.
|
|
242
|
+
|
|
230
243
|
## User scope (`~/.oat/`)
|
|
231
244
|
|
|
232
245
|
Common user-scope entries:
|