Skip to content

Commit 67904a2

Browse files
committed
docs: use npx ai-devkit@latest in command examples
1 parent 4582f1d commit 67904a2

17 files changed

+35
-35
lines changed

docs/ai/design/feature-init-template.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,7 @@ description: Define the technical architecture, components, and data models
6666
- `installSkills(skills: TemplateSkill[]): Promise<SkillInstallResult[]>`
6767
- Request/response formats
6868
- CLI command
69-
- `npx ai-devkit init --template <path>`
69+
- `npx ai-devkit@latest init --template <path>`
7070
- Path resolution: absolute path as-is; relative path resolved from current working directory.
7171
- Sample YAML template
7272
```yaml

docs/ai/design/feature-memory-search-table-output.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -49,9 +49,9 @@ description: Define the technical architecture, components, and data models
4949
- Keep `memorySearchCommand(options)` unchanged.
5050
- Request/response formats
5151
- Existing command:
52-
- `npx ai-devkit memory search --query "<query>" [--tags "..."] [--scope "..."] [--limit N]`
52+
- `npx ai-devkit@latest memory search --query "<query>" [--tags "..."] [--scope "..."] [--limit N]`
5353
- New table mode:
54-
- `npx ai-devkit memory search --query "<query>" --table`
54+
- `npx ai-devkit@latest memory search --query "<query>" --table`
5555
- Table output columns:
5656
- `id`
5757
- `title`

docs/ai/design/feature-memory-update.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,7 @@ interface MemoryUpdateOptions {
7171
### CLI Command
7272

7373
```
74-
npx ai-devkit memory update --id <uuid> [--title <title>] [--content <content>] [--tags <tags>] [--scope <scope>]
74+
npx ai-devkit@latest memory update --id <uuid> [--title <title>] [--content <content>] [--tags <tags>] [--scope <scope>]
7575
```
7676

7777
| Option | Required | Description |

docs/ai/design/feature-setup-wizard.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -71,10 +71,10 @@ description: Define the technical architecture, components, and data models
7171
- `renderReport(report): void`
7272
- Request/response formats
7373
- CLI entry points
74-
- `npx ai-devkit setup` (interactive wizard default)
75-
- `npx ai-devkit setup --non-interactive --profile <name> --tools codex,claude --assets commands,skills`
76-
- `npx ai-devkit setup --dry-run`
77-
- `npx ai-devkit setup --doctor` (recommended extension for diagnostics)
74+
- `npx ai-devkit@latest setup` (interactive wizard default)
75+
- `npx ai-devkit@latest setup --non-interactive --profile <name> --tools codex,claude --assets commands,skills`
76+
- `npx ai-devkit@latest setup --dry-run`
77+
- `npx ai-devkit@latest setup --doctor` (recommended extension for diagnostics)
7878
- Output
7979
- Human-readable summary by default.
8080
- Optional machine-readable JSON report (`--json`) for CI/auditing.

docs/ai/design/feature-skill-find.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ description: Define the technical architecture, components, and data models
5858
- `ensureIndex(registries): Index` (checks TTL, registry list hash, optional head hash)
5959
- `searchIndex(index, keyword): SkillEntry[]`
6060
- Request/response formats
61-
- CLI: `npx ai-devkit skill find <keyword>`
61+
- CLI: `npx ai-devkit@latest skill find <keyword>`
6262
- Output: table or list with `skillName` and `description`
6363
- Authentication/authorization approach
6464
- GitHub unauthenticated rate limits apply (60 requests/hour).

docs/ai/implementation/feature-lint-command.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,7 @@ description: Technical implementation notes, patterns, and code guidelines
6666

6767
- Git command failures are converted into deterministic lint results (miss or warn), not thrown errors.
6868
- Missing files are reported with explicit path and remediation guidance.
69-
- Output includes suggested fixes (for example `npx ai-devkit init`, `git worktree add ...`).
69+
- Output includes suggested fixes (for example `npx ai-devkit@latest init`, `git worktree add ...`).
7070

7171
## Performance Considerations
7272
**How do we keep it fast?**

docs/ai/implementation/feature-web-skill-search.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ const filteredSkills = skills.filter(skill =>
5252

5353
### Copy to Clipboard
5454
```typescript
55-
navigator.clipboard.writeText(`npx ai-devkit skill add ${skill.name}`);
55+
navigator.clipboard.writeText(`npx ai-devkit@latest skill add ${skill.name}`);
5656
```
5757

5858
## Integration Points

docs/ai/planning/feature-lint-command.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ description: Break down work into actionable tasks and estimate timeline
3131
### Phase 3: Integration & Polish
3232
- [x] Task 3.1: Update help text and README command documentation
3333
- [x] Task 3.2: Decide whether to keep `skills/dev-lifecycle/scripts/check-docs.sh` as wrapper or migrate references to `ai-devkit lint`
34-
- [x] Task 3.3: Add actionable remediation guidance in failures (`npx ai-devkit init`, worktree creation command)
34+
- [x] Task 3.3: Add actionable remediation guidance in failures (`npx ai-devkit@latest init`, worktree creation command)
3535
- [x] Task 3.4: Validate behavior against existing lifecycle docs and feature naming conventions
3636

3737
### Phase 4: Validation

docs/ai/requirements/feature-init-template.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ description: Clarify the problem space, gather requirements, and define success
1010

1111
**What problem are we solving?**
1212

13-
- `npx ai-devkit init` currently requires interactive step-by-step prompts, which slows down repeatable setup and automation.
13+
- `npx ai-devkit@latest init` currently requires interactive step-by-step prompts, which slows down repeatable setup and automation.
1414
- Teams and power users cannot define a reusable bootstrap configuration that includes environments, phases, and skills in one command.
1515
- Skill installation during init is not fully declarative from a single template file.
1616
- Who is affected:
@@ -23,12 +23,12 @@ description: Clarify the problem space, gather requirements, and define success
2323
**What do we want to achieve?**
2424

2525
- Primary goals
26-
- Add support for `npx ai-devkit init --template <file>` (example: `npx ai-devkit init --template test.yaml`).
26+
- Add support for `npx ai-devkit@latest init --template <file>` (example: `npx ai-devkit@latest init --template test.yaml`).
2727
- Allow template-driven initialization for:
2828
- `environments`
2929
- `skills` (`registry`, `skill`)
3030
- `phases`
31-
- Automatically install requested skills via `npx ai-devkit skill add` during init.
31+
- Automatically install requested skills via `npx ai-devkit@latest skill add` during init.
3232
- Reduce or eliminate interactive prompts when a valid template provides required values.
3333
- Secondary goals
3434
- Keep backward compatibility for current interactive `init` flow.
@@ -43,7 +43,7 @@ description: Clarify the problem space, gather requirements, and define success
4343

4444
**How will users interact with the solution?**
4545

46-
- As a developer, I want to run `npx ai-devkit init --template test.yaml` so that I can initialize without answering prompts one by one.
46+
- As a developer, I want to run `npx ai-devkit@latest init --template test.yaml` so that I can initialize without answering prompts one by one.
4747
- As a team lead, I want to commit a template file so that every teammate gets the same environments, skills, and phases.
4848
- As a CI maintainer, I want deterministic initialization from template so that pipeline setup is reproducible.
4949
- Key workflows and scenarios
@@ -70,7 +70,7 @@ description: Clarify the problem space, gather requirements, and define success
7070
- Template format supports both YAML (`.yml`/`.yaml`) and JSON (`.json`) in v1.
7171
- Template path accepts both relative and absolute file paths.
7272
- Init parses template and applies `environments`, `skills`, and `phases`.
73-
- For each template skill entry, init triggers the same install path as `npx ai-devkit skill add`.
73+
- For each template skill entry, init triggers the same install path as `npx ai-devkit@latest skill add`.
7474
- Multiple entries with the same registry and different skill names are all processed.
7575
- Skill installation continues after individual failures and reports all failed items in the final summary.
7676
- If one or more skills fail, command exits with status code `0` and warning output.

docs/ai/requirements/feature-lint-command.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,7 @@ description: Clarify the problem space, gather requirements, and define success
7272
- `ai-devkit lint --feature <name>` checks dedicated worktree/branch convention (`feature-<name>`).
7373
- Missing dedicated worktree returns a warning, not a hard failure.
7474
- Command exits `0` when all required checks pass and non-zero when required checks fail.
75-
- Output includes recommended remediation (for example `npx ai-devkit init` or worktree creation commands).
75+
- Output includes recommended remediation (for example `npx ai-devkit@latest init` or worktree creation commands).
7676
- `--json` returns machine-readable structured results for CI tooling.
7777
- Performance benchmarks (if applicable)
7878
- File-system checks and git checks should avoid expensive scans and run in sub-second to low-second range.

0 commit comments

Comments
 (0)