@open-agent-toolkit/cli 0.3.30 → 0.3.31
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.
|
@@ -69,7 +69,7 @@ For framework apps, it wraps `oat docs init` with a seven-step guided flow: pref
|
|
|
69
69
|
|
|
70
70
|
What the framework path adds over the raw CLI:
|
|
71
71
|
|
|
72
|
-
- **Preflight +
|
|
72
|
+
- **Preflight + existing-docs front door.** Detects existing `documentation` config / docs app dir / root `AGENTS.md` section and defaults to audit (`oat-docs-analyze` then approved `oat-docs-apply`), then exits before scaffolding. Replacement requires an explicit choice; a second app remains unsupported. See [IA selection and existing-docs routing](workflows.md#ia-selection-and-guidance).
|
|
73
73
|
- **Richer inputs.** Asks for a **site name** separate from the package name, so layout branding and page metadata converge on the same display title. `createDocsConfig()` handles runtime configuration, not titles.
|
|
74
74
|
- **CLI-owned guidance.** Fresh Fumadocs and MkDocs apps include app-root `AGENTS.md`, a reader-first Getting Started stub, a human contributor entry and `docs/contributing/docs-toolchain.md`. Commands state their working directory. Bootstrap observes this output; older CLIs missing it get analyze/manual CLI-template upgrade advice, rather than a second template owner. Existing and Markdown surfaces are preserved. Nested-standalone Fumadocs still uses the ESM-safe Turbopack root while monorepo and single-package apps use Next root discovery.
|
|
75
75
|
- **Agent Markdown.** Fumadocs exports `/llms.txt`, `/llms-full.txt` and `/llms/<page-slugs>/content.md` (root `/llms/content.md`) from loaded `.md` readers. MDX and configured non-readers are excluded. Source headers identify how to resolve authored relative links; rendered and Markdown URLs include the deployment base path once.
|
|
@@ -19,7 +19,9 @@ Install the workflow skills with `oat tools install docs` (preferred) or
|
|
|
19
19
|
- `oat docs migrate` converts MkDocs admonitions to GFM callouts and injects frontmatter
|
|
20
20
|
- `oat docs generate-index` generates a Fumadocs app-root docs index manifest from the Markdown file tree
|
|
21
21
|
- `oat docs nav sync` regenerates MkDocs `mkdocs.yml` nav, or strict Fumadocs `meta.json` files, from `index.md` `## Contents` sections
|
|
22
|
-
- `oat docs
|
|
22
|
+
- [`oat docs check`](check.md) checks reader pages, navigation, contributor commands and diagrams without building a site
|
|
23
|
+
- [`oat docs literals`](commands.md#oat-docs-literals) supplies bounded inline-code occurrence evidence for analyze
|
|
24
|
+
- `oat docs analyze` and `oat docs apply` expose guidance pointers in CLI help; the skills perform analysis and apply
|
|
23
25
|
|
|
24
26
|
### Skills
|
|
25
27
|
|
|
@@ -93,8 +95,9 @@ Diagram: bootstrap once, then analyze, approve and apply only agreed improvement
|
|
|
93
95
|
Q -->|"all skipped"| STOP
|
|
94
96
|
```
|
|
95
97
|
|
|
96
|
-
- **
|
|
97
|
-
you to confirm its inputs, then runs `oat docs init`.
|
|
98
|
+
- **Fresh setup or explicit adoption.** `oat-docs-bootstrap` checks the repo without writing, asks
|
|
99
|
+
you to confirm its inputs, then runs `oat docs init`. Existing docs default to
|
|
100
|
+
[analyze then approved apply](#ia-selection-and-guidance) and exit before scaffolding. Plain Markdown setup validates authored files,
|
|
98
101
|
configuration and guidance without installing app dependencies or building a
|
|
99
102
|
site. Fumadocs and MkDocs setup inspects CLI-owned scaffold output, installs
|
|
100
103
|
dependencies, verifies the build and provides a walkthrough.
|
|
@@ -277,9 +280,10 @@ with a docs app simply because one can be scaffolded.
|
|
|
277
280
|
|
|
278
281
|
Preflight only reads. It checks declared documentation configuration before
|
|
279
282
|
discovery and checks framework evidence before assuming a populated
|
|
280
|
-
directory is plain Markdown.
|
|
281
|
-
|
|
282
|
-
|
|
283
|
+
directory is plain Markdown. Existing docs default to analyze then approved
|
|
284
|
+
apply and exit before scaffolding. For fresh setup or explicit adoption, the
|
|
285
|
+
skill summarizes your choices and asks you to confirm them before it runs
|
|
286
|
+
`oat docs init`. The two setup paths differ from that point on.
|
|
283
287
|
|
|
284
288
|
**Plain Markdown path:** Use this when you want plain Markdown files and no
|
|
285
289
|
site runtime. The skill collects a title, a dedicated repository-relative
|
|
@@ -352,8 +356,9 @@ pages, grouped headings in one flat index often suffice.
|
|
|
352
356
|
For fresh Markdown/framework setup and explicit adoption, bootstrap proposes
|
|
353
357
|
two plausible two-level trees with 5–8 representative page placements each,
|
|
354
358
|
page jobs, nearest presets and tradeoffs. Analyze's `--ia` does the same in its
|
|
355
|
-
existing analysis artifact and review loop.
|
|
356
|
-
|
|
359
|
+
existing analysis artifact and review loop. `--ia` and `--ia-guidance` are
|
|
360
|
+
**skill arguments**, not `oat docs init` flags. The CLI accepts the approved
|
|
361
|
+
selection through the paired [`--ia-preset` and `--planned-pages` flags](commands.md#approved-preset-readers).
|
|
357
362
|
|
|
358
363
|
Resolve advisory sources in this order: explicit `--ia-guidance <path|url>` or
|
|
359
364
|
conversation, repo `documentation.guidance`, user config, then the installed
|
|
@@ -372,8 +377,15 @@ proposal becomes durable only after approval: bootstrap/apply use `oat decision
|
|
|
372
377
|
and an Information architecture section in the framework docs-app `AGENTS.md`
|
|
373
378
|
or Markdown contributing page, plus the shared `documentation.ia` mirror.
|
|
374
379
|
Authored records stay authoritative; missing/conflicting records become `ask_user`.
|
|
375
|
-
|
|
376
|
-
|
|
380
|
+
Fresh empty targets can now materialize all six presets and their relevant
|
|
381
|
+
page-template subsets, including Feature and QA validation templates, through
|
|
382
|
+
that opt-in flag pair. Counts below 15 collapse reader tracks into grouped root
|
|
383
|
+
headings; 15 or more creates tracks, while `flat-small` always stays flat.
|
|
384
|
+
`contributing/templates/**` is excluded from reader navigation, checks and
|
|
385
|
+
manifests. See [preset mappings and template subsets](commands.md#approved-preset-readers),
|
|
386
|
+
including the MkDocs rendered-route limitation. Selection does not create the
|
|
387
|
+
separate approved IA decision; the IA Proposal template remains the selection
|
|
388
|
+
artifact.
|
|
377
389
|
|
|
378
390
|
## oat-docs-analyze
|
|
379
391
|
|
|
@@ -454,8 +466,10 @@ navigation or generated-artifact refreshes, plus a structured result listing
|
|
|
454
466
|
applied, skipped (ID/reason), and failed IDs. Markdown retains its authored
|
|
455
467
|
index and needs no framework build or nav sync; Fumadocs sidebar metadata is
|
|
456
468
|
regenerated only with recorded `navOwner: nav-sync`. Hand-authored navigation
|
|
457
|
-
gets approved edits and read-only Contents membership/order comparison
|
|
458
|
-
|
|
469
|
+
gets approved edits and read-only Contents membership/order comparison.
|
|
470
|
+
[Absent optional metadata/pages/nav skips comparison](check.md); implicit
|
|
471
|
+
Fumadocs order is not checked. Explicit lists remain checked and nav-sync
|
|
472
|
+
freshness stays strict. Undeclared ownership becomes `ask_user`. The summary
|
|
459
473
|
reports the applied plan and checks.
|
|
460
474
|
|
|
461
475
|
**What it does without asking:** Nothing changes until you approve the plan.
|
|
@@ -526,8 +540,13 @@ source citations and existing recommendation approval classes still govern.
|
|
|
526
540
|
|
|
527
541
|
For framework apps, offline drift compares installed `@open-agent-toolkit/docs-*` packages to the
|
|
528
542
|
running CLI's bundled `public-package-versions.json`, never registry latest.
|
|
529
|
-
|
|
530
|
-
upgrade command.
|
|
543
|
+
Older installed packages produce an explicit drift recommendation with the
|
|
544
|
+
exact upgrade command. Equal versions are current. Newer packages are `ahead`: select
|
|
545
|
+
or update the intended CLI installation before re-analysis, without a package
|
|
546
|
+
downgrade command. Missing installations or bundle metadata and non-orderable
|
|
547
|
+
versions are `unverified` and require manual verification; hoisted-only packages
|
|
548
|
+
also remain unverified. Neither ahead nor unverified supplies a package-update
|
|
549
|
+
command or authorizes an upgrade. Individual tooling approval permits only docs-app `@open-agent-toolkit/docs-*`
|
|
531
550
|
dependency bumps (and resulting lockfile), the admonition/frontmatter conversions
|
|
532
551
|
already supported by `oat docs migrate`, and build verification. App config,
|
|
533
552
|
routes and package scripts remain manual required changes.
|
|
@@ -4,9 +4,9 @@ description: Run when you need to evaluate documentation structure, navigation,
|
|
|
4
4
|
argument-hint: '[target] [--ia] [--ia-guidance <path|url>]'
|
|
5
5
|
disable-model-invocation: true
|
|
6
6
|
user-invocable: true
|
|
7
|
-
allowed-tools: Read, Write, Bash(git:*), Bash(oat config:*), Bash(oat docs nav sync --check:*), Bash(oat docs check:*), Bash(oat docs literals:*), Bash(pnpm:*), Bash(bash:*), Bash(jq:*), Bash(node:*), Bash(mkdir:*), Bash(date:*), Bash(echo:*), Bash(cd:*), Bash(pwd:*), Glob, Grep, AskUserQuestion, Task
|
|
7
|
+
allowed-tools: Read, Write, Bash(git:*), Bash(oat config:*), Bash(oat docs nav sync --check:*), Bash(oat docs check:*), Bash(oat docs literals:*), Bash(pnpm:*), Bash(bash:*), Bash(jq:*), Bash(node:*), Bash(command -v:*), Bash(sed:*), Bash(npm root -g:*), Bash(test:*), Bash(oat --version), Bash(mkdir:*), Bash(date:*), Bash(echo:*), Bash(cd:*), Bash(pwd:*), Glob, Grep, AskUserQuestion, Task
|
|
8
8
|
metadata:
|
|
9
|
-
version: '1.7.
|
|
9
|
+
version: '1.7.5'
|
|
10
10
|
---
|
|
11
11
|
|
|
12
12
|
# Docs Analysis
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@open-agent-toolkit/cli",
|
|
3
|
-
"version": "0.3.
|
|
3
|
+
"version": "0.3.31",
|
|
4
4
|
"private": false,
|
|
5
5
|
"description": "Open Agent Toolkit CLI",
|
|
6
6
|
"homepage": "https://github.com/voxmedia/open-agent-toolkit/tree/main/packages/cli",
|
|
@@ -42,8 +42,8 @@
|
|
|
42
42
|
"unified": "11.0.5",
|
|
43
43
|
"yaml": "2.8.2",
|
|
44
44
|
"zod": "^3.25.76",
|
|
45
|
-
"@open-agent-toolkit/control-plane": "0.3.
|
|
46
|
-
"@open-agent-toolkit/docs-transforms": "0.3.
|
|
45
|
+
"@open-agent-toolkit/control-plane": "0.3.31",
|
|
46
|
+
"@open-agent-toolkit/docs-transforms": "0.3.31"
|
|
47
47
|
},
|
|
48
48
|
"devDependencies": {
|
|
49
49
|
"@types/jsdom": "28.0.3",
|