diff --git a/docs/cli/intent-exclude.md b/docs/cli/intent-exclude.md index 1c1d4db2..1d29d554 100644 --- a/docs/cli/intent-exclude.md +++ b/docs/cli/intent-exclude.md @@ -1,43 +1,74 @@ ---- -title: intent exclude -id: intent-exclude ---- - -`intent exclude` manages `package.json#intent.exclude` entries. - -```bash -npx @tanstack/intent@latest exclude [list|add|remove] [pattern] [--json] -``` - -## Options - -- `--json`: print the configured exclude patterns as JSON - -## Actions - -1. `list` (default): print current excludes -2. `add `: append one exclude pattern -3. `remove `: remove one exclude pattern - -## Examples - -```bash -npx @tanstack/intent@latest exclude -npx @tanstack/intent@latest exclude list --json -npx @tanstack/intent@latest exclude add @tanstack/router#experimental-* -npx @tanstack/intent@latest exclude remove @tanstack/router#experimental-* -``` - -## Behavior - -- Reads and writes the current working directory `package.json` -- Creates `intent.exclude` when missing -- Keeps existing excludes and appends new patterns in order -- Validates pattern syntax before writing -- Refuses invalid `package.json` structures for `intent` and `intent.exclude` - -## Related - -- [Configuration](../concepts/configuration) -- [intent list](./intent-list) -- [intent load](./intent-load) +--- +title: intent exclude +id: intent-exclude +--- + +`intent exclude` manages `package.json#intent.exclude` entries. + + + +react: @tanstack/intent@latest exclude [list|add|remove] [pattern] [--json] +solid: @tanstack/intent@latest exclude [list|add|remove] [pattern] [--json] +vue: @tanstack/intent@latest exclude [list|add|remove] [pattern] [--json] +svelte: @tanstack/intent@latest exclude [list|add|remove] [pattern] [--json] +angular: @tanstack/intent@latest exclude [list|add|remove] [pattern] [--json] +lit: @tanstack/intent@latest exclude [list|add|remove] [pattern] [--json] + + + +## Options + +- `--json`: print the configured exclude patterns as JSON + +## Actions + +1. `list` (default): print current excludes +2. `add `: append one exclude pattern +3. `remove `: remove one exclude pattern + +## Examples + + + +```text +react: @tanstack/intent@latest exclude +react: @tanstack/intent@latest exclude list --json +react: @tanstack/intent@latest exclude add @tanstack/router#experimental-* +react: @tanstack/intent@latest exclude remove @tanstack/router#experimental-* +solid: @tanstack/intent@latest exclude +solid: @tanstack/intent@latest exclude list --json +solid: @tanstack/intent@latest exclude add @tanstack/router#experimental-* +solid: @tanstack/intent@latest exclude remove @tanstack/router#experimental-* +vue: @tanstack/intent@latest exclude +vue: @tanstack/intent@latest exclude list --json +vue: @tanstack/intent@latest exclude add @tanstack/router#experimental-* +vue: @tanstack/intent@latest exclude remove @tanstack/router#experimental-* +svelte: @tanstack/intent@latest exclude +svelte: @tanstack/intent@latest exclude list --json +svelte: @tanstack/intent@latest exclude add @tanstack/router#experimental-* +svelte: @tanstack/intent@latest exclude remove @tanstack/router#experimental-* +angular: @tanstack/intent@latest exclude +angular: @tanstack/intent@latest exclude list --json +angular: @tanstack/intent@latest exclude add @tanstack/router#experimental-* +angular: @tanstack/intent@latest exclude remove @tanstack/router#experimental-* +lit: @tanstack/intent@latest exclude +lit: @tanstack/intent@latest exclude list --json +lit: @tanstack/intent@latest exclude add @tanstack/router#experimental-* +lit: @tanstack/intent@latest exclude remove @tanstack/router#experimental-* +``` + + + +## Behavior + +- Reads and writes the current working directory `package.json` +- Creates `intent.exclude` when missing +- Keeps existing excludes and appends new patterns in order +- Validates pattern syntax before writing +- Refuses invalid `package.json` structures for `intent` and `intent.exclude` + +## Related + +- [Configuration](../concepts/configuration) +- [intent list](./intent-list) +- [intent load](./intent-load) diff --git a/docs/cli/intent-hooks.md b/docs/cli/intent-hooks.md index ccdd4167..b2e4c2d4 100644 --- a/docs/cli/intent-hooks.md +++ b/docs/cli/intent-hooks.md @@ -5,9 +5,16 @@ id: intent-hooks `intent hooks install` installs lifecycle hooks that surface available Intent skills and gate supported edit tools until they observe an Intent guidance check. -```bash -npx @tanstack/intent@latest hooks install [--scope project|user] [--agents copilot,claude,codex|all] -``` + + +react: @tanstack/intent@latest hooks install [--scope project|user] [--agents copilot,claude,codex|all] +solid: @tanstack/intent@latest hooks install [--scope project|user] [--agents copilot,claude,codex|all] +vue: @tanstack/intent@latest hooks install [--scope project|user] [--agents copilot,claude,codex|all] +svelte: @tanstack/intent@latest hooks install [--scope project|user] [--agents copilot,claude,codex|all] +angular: @tanstack/intent@latest hooks install [--scope project|user] [--agents copilot,claude,codex|all] +lit: @tanstack/intent@latest hooks install [--scope project|user] [--agents copilot,claude,codex|all] + + ## Options diff --git a/docs/cli/intent-install.md b/docs/cli/intent-install.md index 91fcc85c..27b93c30 100644 --- a/docs/cli/intent-install.md +++ b/docs/cli/intent-install.md @@ -5,9 +5,16 @@ id: intent-install `intent install` confirms skill-source permissions on first use, then creates or updates an `intent-skills` guidance block in a project guidance file. -```bash -npx @tanstack/intent@latest install [--map] [--dry-run] [--print-prompt] [--global] [--global-only] [--no-notices] -``` + + +react: @tanstack/intent@latest install [--maintainer] [--review] [--map] [--dry-run] [--print-prompt] [--global] [--global-only] [--no-notices] +solid: @tanstack/intent@latest install [--maintainer] [--review] [--map] [--dry-run] [--print-prompt] [--global] [--global-only] [--no-notices] +vue: @tanstack/intent@latest install [--maintainer] [--review] [--map] [--dry-run] [--print-prompt] [--global] [--global-only] [--no-notices] +svelte: @tanstack/intent@latest install [--maintainer] [--review] [--map] [--dry-run] [--print-prompt] [--global] [--global-only] [--no-notices] +angular: @tanstack/intent@latest install [--maintainer] [--review] [--map] [--dry-run] [--print-prompt] [--global] [--global-only] [--no-notices] +lit: @tanstack/intent@latest install [--maintainer] [--review] [--map] [--dry-run] [--print-prompt] [--global] [--global-only] [--no-notices] + + ## Options @@ -29,6 +36,17 @@ npx @tanstack/intent@latest install [--map] [--dry-run] [--print-prompt] [--glob ## Behavior +### Maintainer workflow + +For the full command workflow, use [`intent maintainer setup`](./intent-maintainer). `install --maintainer` remains available when only the repository instruction block is needed. + +`install --maintainer` enables initial skill batches and source-aware skill maintenance in repository agent instructions. It works without an interactive terminal or existing consumer permissions. It writes a separate `intent-maintainer` block, preserves consumer guidance, and is idempotent. `--dry-run` previews the block. + +Run it from the library root. The block loads the packaged authoring procedure for substantial library work; that procedure covers the cumulative domain map, spec, and skill tree, source review, task checks, and revision-bound outcomes. It updates the file that already contains either Intent managed block, or creates `AGENTS.md` when neither exists. It cannot be combined with `--review`, `--map`, `--print-prompt`, `--global`, or `--global-only`. See [Quick Start for Maintainers](../getting-started/quick-start-maintainers). + +> [!NOTE] Maintainer installation writes guidance +> It does not add Intent to `package.json`, configure consumer skill permissions, install agent hooks, or add CI. The managed block uses the detected package manager's runner with `@tanstack/intent@latest`. + ### Default install If `intent.skills` is already configured, including through workspace inheritance, `install` only updates guidance. It does not prompt or change `package.json`. Run `intent install --review` to change permissions. @@ -73,9 +91,16 @@ After permissions are saved, Intent updates an existing managed guidance block i ### Review existing permissions -```bash -npx @tanstack/intent@latest install --review -``` + + +react: @tanstack/intent@latest install --review +solid: @tanstack/intent@latest install --review +vue: @tanstack/intent@latest install --review +svelte: @tanstack/intent@latest install --review +angular: @tanstack/intent@latest install --review +lit: @tanstack/intent@latest install --review + + Review starts from the current `intent.skills` rules. Continue with them, add packages/scopes/individual skills, remove explicit rules, or review individual skills within enabled packages. Existing rules stay intact unless you change them, including rules for packages or skills that are **not discovered**. Removing a rule requires unchecking it; Intent never removes it automatically. @@ -103,34 +128,11 @@ Supported config files: `AGENTS.md`, `CLAUDE.md`, `.cursorrules`, `.github/copil ## Default output -The default block tells agents to discover skills and load matching guidance on demand: - -```markdown - -## Skill Loading - -Before editing files for a substantial task: -- Run `npx @tanstack/intent@latest list` from the workspace root to see available local skills. -- If a listed skill matches the task, run `npx @tanstack/intent@latest load #` before changing files. -- Use the loaded `SKILL.md` guidance while making the change. -- Monorepos: when working across packages, run the skill check from the workspace root and prefer the local skill for the package being changed. -- Multiple matches: prefer the most specific local skill for the package or concern you are changing; load additional skills only when the task spans multiple packages or concerns. - -``` +The managed `intent-skills` block instructs agents to discover skills with `intent list`, load matching guidance with `intent load`, and apply it before editing. It tells agents to work from the workspace root, prefer the most specific local skill, and load additional skills only when the task spans multiple concerns. Generated commands use the detected package manager's runner with `@tanstack/intent@latest`. ## Mapping output -`--map` writes compact skill identities and commands: - -```yaml - -# TanStack Intent - before editing files, run the matching guidance command. -tanstackIntent: - - id: "@tanstack/query#fetching" - run: "npx @tanstack/intent@latest load @tanstack/query#fetching" - for: "Query data fetching patterns" - -``` +`--map` writes a `tanstackIntent` list inside the managed `intent-skills` block. Each mapping contains: - `id`: portable skill identity in `#` format - `run`: package-manager-aware command agents should run before editing diff --git a/docs/cli/intent-list.md b/docs/cli/intent-list.md index 7fe6438e..3d4d4d46 100644 --- a/docs/cli/intent-list.md +++ b/docs/cli/intent-list.md @@ -5,9 +5,16 @@ id: intent-list `intent list` discovers skill-enabled packages and shows the skills available under the project's permissions and exclusions. It does not change permissions or write guidance. -```bash -npx @tanstack/intent@latest list [--json] [--debug] [--global] [--global-only] [--show-hidden] [--no-notices] -``` + + +react: @tanstack/intent@latest list [--json] [--debug] [--global] [--global-only] [--show-hidden] [--no-notices] +solid: @tanstack/intent@latest list [--json] [--debug] [--global] [--global-only] [--show-hidden] [--no-notices] +vue: @tanstack/intent@latest list [--json] [--debug] [--global] [--global-only] [--show-hidden] [--no-notices] +svelte: @tanstack/intent@latest list [--json] [--debug] [--global] [--global-only] [--show-hidden] [--no-notices] +angular: @tanstack/intent@latest list [--json] [--debug] [--global] [--global-only] [--show-hidden] [--no-notices] +lit: @tanstack/intent@latest list [--json] [--debug] [--global] [--global-only] [--show-hidden] [--no-notices] + + ## Options @@ -25,6 +32,9 @@ npx @tanstack/intent@latest list [--json] [--debug] [--global] [--global-only] [ ## Behavior +> [!NOTE] +> `list` is the consumer catalog for skills shipped by project and workspace dependencies. Library maintainers load Intent's packaged authoring procedures through `intent meta` or the installed maintainer block; `intent maintainer` handles setup, registration, synchronization, and checks. + ### Default list Intent scans project and workspace dependencies, applies `package.json#intent.skills`, then removes packages and skills matched by `intent.exclude`. It uses project `node_modules` when available and Yarn's PnP API in PnP projects without usable `node_modules`. @@ -81,7 +91,7 @@ Text output includes: - A skill tree grouped by package, with descriptions and commands to load each skill. - Version conflicts and discovery warnings, when present. -Load commands use the detected package manager and preserve the selected global scan scope. `SOURCE` distinguishes local discovery from explicit global scanning. +Load commands use the detected package manager's `@tanstack/intent@latest` runner and preserve the selected global scan scope. `SOURCE` distinguishes local discovery from explicit global scanning. Text output and discovery warnings go to stdout. Policy notices and `--debug` details go to stderr. @@ -99,7 +109,8 @@ Text output and discovery warnings go to stdout. Policy notices and `--debug` de "packageVersion": "5.0.0", "packageSource": "local", "skillName": "fetching", - "description": "Query data fetching patterns", + "description": "Use when fetching and caching server data with TanStack Query.", + "purpose": "Query data fetching patterns", "type": "core", "framework": "react" } @@ -124,6 +135,8 @@ Text output and discovery warnings go to stdout. Policy notices and `--debug` de | Field | Meaning | | --- | --- | | `skills` | Available skills. `use` is the portable `#` identity; `type` and `framework` are optional. | +| Skill `description` | Standard agent-discovery text describing when to use the skill. Also used in the text listing. | +| Skill `purpose` | Optional descriptive explanation from `metadata.purpose`, kept separate from activation guidance. Omitted from JSON when absent. | | `packages` | Selected packages, their source and location, and permitted skill counts. | | `hiddenSourceCount` | Number of packages hidden by the explicit allowlist. | | `hiddenSources` | Objects with `name` and `skillCount` in human sessions, even without `--show-hidden`. Always empty in agent sessions. | @@ -156,6 +169,7 @@ JSON includes diagnostics in the object instead of printing separate warning or - [intent install](./intent-install) - [intent load](./intent-load) +- [intent meta](./intent-meta) - [intent exclude](./intent-exclude) - [Configuration](../concepts/configuration) - [Trust model](../concepts/trust-model) diff --git a/docs/cli/intent-load.md b/docs/cli/intent-load.md index 48fc0654..8e36876c 100644 --- a/docs/cli/intent-load.md +++ b/docs/cli/intent-load.md @@ -5,10 +5,19 @@ id: intent-load `intent load` loads a compact skill identity from the current install and prints the matching `SKILL.md` content. -```bash -npx @tanstack/intent@latest load # [--path] [--json] [--debug] [--global] [--global-only] + + +```text +react: @tanstack/intent@latest load # [--path] [--json] [--debug] [--global] [--global-only] +solid: @tanstack/intent@latest load # [--path] [--json] [--debug] [--global] [--global-only] +vue: @tanstack/intent@latest load # [--path] [--json] [--debug] [--global] [--global-only] +svelte: @tanstack/intent@latest load # [--path] [--json] [--debug] [--global] [--global-only] +angular: @tanstack/intent@latest load # [--path] [--json] [--debug] [--global] [--global-only] +lit: @tanstack/intent@latest load # [--path] [--json] [--debug] [--global] [--global-only] ``` + + ## Options - `--path`: print the resolved skill path instead of the file content @@ -44,12 +53,34 @@ The package can be scoped or unscoped. The skill can include slash-separated sub Examples: -```bash -npx @tanstack/intent@latest load @tanstack/query#fetching -npx @tanstack/intent@latest load @tanstack/query#core/fetching -npx @tanstack/intent@latest load @tanstack/router-core#auth-and-guards -npx @tanstack/intent@latest load some-lib#core --path -``` + + +react: @tanstack/intent@latest load @tanstack/query#fetching +react: @tanstack/intent@latest load @tanstack/query#core/fetching +react: @tanstack/intent@latest load @tanstack/router-core#auth-and-guards +react: @tanstack/intent@latest load some-lib#core --path +solid: @tanstack/intent@latest load @tanstack/query#fetching +solid: @tanstack/intent@latest load @tanstack/query#core/fetching +solid: @tanstack/intent@latest load @tanstack/router-core#auth-and-guards +solid: @tanstack/intent@latest load some-lib#core --path +vue: @tanstack/intent@latest load @tanstack/query#fetching +vue: @tanstack/intent@latest load @tanstack/query#core/fetching +vue: @tanstack/intent@latest load @tanstack/router-core#auth-and-guards +vue: @tanstack/intent@latest load some-lib#core --path +svelte: @tanstack/intent@latest load @tanstack/query#fetching +svelte: @tanstack/intent@latest load @tanstack/query#core/fetching +svelte: @tanstack/intent@latest load @tanstack/router-core#auth-and-guards +svelte: @tanstack/intent@latest load some-lib#core --path +angular: @tanstack/intent@latest load @tanstack/query#fetching +angular: @tanstack/intent@latest load @tanstack/query#core/fetching +angular: @tanstack/intent@latest load @tanstack/router-core#auth-and-guards +angular: @tanstack/intent@latest load some-lib#core --path +lit: @tanstack/intent@latest load @tanstack/query#fetching +lit: @tanstack/intent@latest load @tanstack/query#core/fetching +lit: @tanstack/intent@latest load @tanstack/router-core#auth-and-guards +lit: @tanstack/intent@latest load some-lib#core --path + + ## JSON output diff --git a/docs/cli/intent-maintainer.md b/docs/cli/intent-maintainer.md new file mode 100644 index 00000000..74626f2c --- /dev/null +++ b/docs/cli/intent-maintainer.md @@ -0,0 +1,168 @@ +--- +title: intent maintainer +id: intent-maintainer +--- + +`intent maintainer` provides one command workflow for creating, maintaining, and distributing library skills. Skills stay in their owning packages. The commands keep registrations and generated metadata consistent; maintainers and coding agents supply the task knowledge and review conclusions. + +## Commands + +| Command | What it does | +| --- | --- | +| `maintainer setup` | Install repository guidance, create missing planning records, and save the distribution choice. | +| `maintainer add ` | Create a skill skeleton or register an existing skill in the cumulative record. | +| `maintainer status` | Show authoring gaps, stale generated files, and pending source reviews. | +| `maintainer sync` | Align tree metadata, package publishing entries, plugin manifests, and consumer install commands. | +| `maintainer review` | Inspect Git changes and record supplied outcomes against content fingerprints. | +| `maintainer check` | Check skill structure, registration, generated metadata, and recorded reviews locally or in CI. | + +The former `scaffold` command is removed. Use `maintainer setup` and `maintainer add` for file creation, and `meta generate-skill` for the authoring procedure. + +## Setup + +Run from a Git working tree containing the library's package manifest: + + + +react: @tanstack/intent@latest maintainer setup +solid: @tanstack/intent@latest maintainer setup +vue: @tanstack/intent@latest maintainer setup +svelte: @tanstack/intent@latest maintainer setup +angular: @tanstack/intent@latest maintainer setup +lit: @tanstack/intent@latest maintainer setup + + + +Setup preserves existing documents and repository instructions. Standalone packages use `skills/_artifacts/`; monorepos share `_artifacts/` at the repository root. An existing custom location is retained. If several locations exist, select one with `--artifacts `. + +The three records have separate jobs: + +| Record | Owns | +| --- | --- | +| `domain_map.yaml` | Domains, developer tasks, supported failure modes, and knowledge gaps. | +| `skill_spec.md` | Coverage, maintainer decisions, check results, and batch history. | +| `skill_tree.yaml` | Skill identities, owning packages, paths, source mappings, prerequisites, and the distribution choice. | + +Generated skeletons remain unfinished. Author their contents and remove the `intent:needs-authoring` marker after completing that work. A successful setup command does not mean the skills are ready to publish. + +## Add a skill + + + +react: @tanstack/intent@latest maintainer add retries --package packages/client --domain requests --description "Use when configuring retries with this client." --source "src/retry.ts" +solid: @tanstack/intent@latest maintainer add retries --package packages/client --domain requests --description "Use when configuring retries with this client." --source "src/retry.ts" +vue: @tanstack/intent@latest maintainer add retries --package packages/client --domain requests --description "Use when configuring retries with this client." --source "src/retry.ts" +svelte: @tanstack/intent@latest maintainer add retries --package packages/client --domain requests --description "Use when configuring retries with this client." --source "src/retry.ts" +angular: @tanstack/intent@latest maintainer add retries --package packages/client --domain requests --description "Use when configuring retries with this client." --source "src/retry.ts" +lit: @tanstack/intent@latest maintainer add retries --package packages/client --domain requests --description "Use when configuring retries with this client." --source "src/retry.ts" + + + +Omit `--package` for a standalone package or a repository-owned discovery skill. The default path is `skills//SKILL.md` within that package. Use `--path /SKILL.md` for an established layout. Repeat `--source` and `--requires` to supply multiple paths or prerequisites. + +To register existing guidance, supply its name, domain, package, and path. The command reads its frontmatter and preserves the file. To change an already registered skill, edit its guidance and run `maintainer sync`. + +Registration updates the tree and domain map and appends an entry to the spec. Write the task coverage, source-backed guidance, and consequential decisions; the command does not infer them. + +## Choose repository distribution + +Package skills can also be offered through GitHub installers and native plugins. Select the registered skills explicitly: + + + +react: @tanstack/intent@latest maintainer setup --distribution repo --repository owner/library --skill discover-library --skill retries +solid: @tanstack/intent@latest maintainer setup --distribution repo --repository owner/library --skill discover-library --skill retries +vue: @tanstack/intent@latest maintainer setup --distribution repo --repository owner/library --skill discover-library --skill retries +svelte: @tanstack/intent@latest maintainer setup --distribution repo --repository owner/library --skill discover-library --skill retries +angular: @tanstack/intent@latest maintainer setup --distribution repo --repository owner/library --skill discover-library --skill retries +lit: @tanstack/intent@latest maintainer setup --distribution repo --repository owner/library --skill discover-library --skill retries + + + +The repository is inferred from package metadata when available. `--plugin-name ` can choose the initial plugin name. New skills are never added to the selection automatically, and local prerequisites must be selected explicitly. + +To keep the package distribution workflow without generating repository exports: + + + +react: @tanstack/intent@latest maintainer setup --distribution none +solid: @tanstack/intent@latest maintainer setup --distribution none +vue: @tanstack/intent@latest maintainer setup --distribution none +svelte: @tanstack/intent@latest maintainer setup --distribution none +angular: @tanstack/intent@latest maintainer setup --distribution none +lit: @tanstack/intent@latest maintainer setup --distribution none + + + +Setup remembers this choice. `maintainer check` reports an unconfigured choice until either option is recorded. + +After authoring, `maintainer sync` updates Claude and Cursor plugin manifests and marketplace entries that point to the existing skill directories. It preserves unrelated plugin fields and other marketplace entries. It writes `.intent/skill-distribution.json` with source paths and install arguments, and prints commands consumers can copy. Conflicting plugin identities or source roots require resolution before synchronization writes anything. + +Opting out after exports exist clears the selected paths and Intent's marketplace entry on the next sync. Other plugin features and source skills remain. This does not revoke installed copies or hide public GitHub files. + +### Consumer choices + +- Use the generated `npx skills add owner/library --skill ` command for a selected set, or `gh skill add owner/library ` for an individual skill. +- Install the generated marketplace through Claude Code or Cursor's native plugin flow. +- Install the npm package and use Intent's existing `list`, `install`, and `load` commands for its bundled version of the guidance. + +Repository location and installation scope are separate choices. The skill installers default to project scope; consumers can explicitly choose user scope with `--global` for `skills` or `--scope user` for `gh`. Third-party tools retain their own discovery behavior: a full scan or `--all` may expose other public skills. Use the generated selection or exact paths for a curated subset. + +A discovery skill can help someone decide whether a library fits before they install it. Keep that guidance about supported tasks and setup choices, respect the project's chosen stack, and hand API implementation to the installed package's skills and source. Avoid maintaining another copy of version-sensitive API instructions in the discovery skill. + +## Maintain and check + + + +react: @tanstack/intent@latest maintainer status +react: @tanstack/intent@latest maintainer sync +react: @tanstack/intent@latest maintainer review --json +solid: @tanstack/intent@latest maintainer status +solid: @tanstack/intent@latest maintainer sync +solid: @tanstack/intent@latest maintainer review --json +vue: @tanstack/intent@latest maintainer status +vue: @tanstack/intent@latest maintainer sync +vue: @tanstack/intent@latest maintainer review --json +svelte: @tanstack/intent@latest maintainer status +svelte: @tanstack/intent@latest maintainer sync +svelte: @tanstack/intent@latest maintainer review --json +angular: @tanstack/intent@latest maintainer status +angular: @tanstack/intent@latest maintainer sync +angular: @tanstack/intent@latest maintainer review --json +lit: @tanstack/intent@latest maintainer status +lit: @tanstack/intent@latest maintainer sync +lit: @tanstack/intent@latest maintainer review --json + + + +Status accepts `--json` and an actual Git comparison base with `--base `. Sync copies descriptions, purpose, sources, and prerequisites from the registered skills into the tree. It also adds the package discovery keyword and includes skill directories in existing `files` allowlists. An absent allowlist stays absent, preserving npm's default contents. Inspect the actual packed archive in the library's release checks. + +Save the review report under `.intent/`, annotate completed items with an outcome, reason, and actual evidence, then record and check: + + + +react: @tanstack/intent@latest maintainer review --record .intent/review.json +react: @tanstack/intent@latest maintainer check +solid: @tanstack/intent@latest maintainer review --record .intent/review.json +solid: @tanstack/intent@latest maintainer check +vue: @tanstack/intent@latest maintainer review --record .intent/review.json +vue: @tanstack/intent@latest maintainer check +svelte: @tanstack/intent@latest maintainer review --record .intent/review.json +svelte: @tanstack/intent@latest maintainer check +angular: @tanstack/intent@latest maintainer review --record .intent/review.json +angular: @tanstack/intent@latest maintainer check +lit: @tanstack/intent@latest maintainer review --record .intent/review.json +lit: @tanstack/intent@latest maintainer check + + + +The [source-review reference](./intent-review) describes the report format, fingerprints, and baseline recovery. `maintainer review` supports its `--base`, `--json`, and `--record` options. The standalone `review` command also remains available for workflow reminder output and review-only checks. + +`maintainer check --base ` runs the same maintainer checks in CI. It does not publish, install consumer skills, or certify that an agent's recorded conclusion is correct. Missing task evidence remains a review responsibility. + +## Related + +- [Maintainer quick start](../getting-started/quick-start-maintainers) +- [Source review](./intent-review) +- [CI setup](./intent-setup) +- [Publishing and registry discovery](../registry) diff --git a/docs/cli/intent-meta.md b/docs/cli/intent-meta.md index 041daae7..2cae9327 100644 --- a/docs/cli/intent-meta.md +++ b/docs/cli/intent-meta.md @@ -5,11 +5,25 @@ id: intent-meta `intent meta` lists bundled meta-skills or prints one meta-skill file. -```bash -npx @tanstack/intent@latest meta -npx @tanstack/intent@latest meta + + +```text +react: @tanstack/intent@latest meta +react: @tanstack/intent@latest meta +solid: @tanstack/intent@latest meta +solid: @tanstack/intent@latest meta +vue: @tanstack/intent@latest meta +vue: @tanstack/intent@latest meta +svelte: @tanstack/intent@latest meta +svelte: @tanstack/intent@latest meta +angular: @tanstack/intent@latest meta +angular: @tanstack/intent@latest meta +lit: @tanstack/intent@latest meta +lit: @tanstack/intent@latest meta ``` + + ## Arguments - `` is a meta-skill directory under `node_modules/@tanstack/intent/meta/` @@ -30,5 +44,5 @@ npx @tanstack/intent@latest meta - Meta directory not found - Invalid `` format -- Unknown `` (message suggests running `npx @tanstack/intent meta`) +- Unknown `` (message suggests listing the available meta-skills) - Read failure for target `SKILL.md` diff --git a/docs/cli/intent-review.md b/docs/cli/intent-review.md new file mode 100644 index 00000000..e89314e8 --- /dev/null +++ b/docs/cli/intent-review.md @@ -0,0 +1,262 @@ +--- +title: intent review +id: intent-review +--- + +`intent review` shows which library skills and planning records need review after source changes. Completed reviews are remembered until their source or guidance changes again. + +For the full maintainer pipeline, use [`intent maintainer review`](./intent-maintainer) with `--base`, `--json`, or `--record`. It uses the same source-review implementation and report format described here. `intent maintainer check` combines review with registration, skill validation, distribution, and generated-file checks. The standalone command remains available for review-only checks and generated workflow reminders. + + + +```text +react: @tanstack/intent@latest review [dir] [--base ] [--json] [--check] [--record ] [--github-review] [--package-label