Skip to content

Commit ce74222

Browse files
authored
docs: sync AGENTS.md and agents-template with explicit change-id notation (#189)
Standardize archive command documentation to use `<change-id>` instead of `[change]` to clarify that the change ID must be explicitly passed. Remove OpenCode-specific slash command reference from AGENTS.md to keep it tool-agnostic.
1 parent 63b8a3e commit ce74222

File tree

2 files changed

+4
-5
lines changed

2 files changed

+4
-5
lines changed

openspec/AGENTS.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,6 @@ After deployment, create separate PR to:
6161
- Move `changes/[name]/``changes/archive/YYYY-MM-DD-[name]/`
6262
- Update `specs/` if capabilities changed
6363
- Use `openspec archive <change-id> --skip-specs --yes` for tooling-only changes (always pass the change ID explicitly)
64-
- OpenCode slash command: `/openspec:archive <change-id>` passes the change ID via arguments—fail fast if the ID is missing or invalid
6564
- Run `openspec validate --strict` to confirm the archived change passes checks
6665

6766
## Before Any Task
@@ -451,7 +450,7 @@ openspec list # What's in progress?
451450
openspec show [item] # View details
452451
openspec diff [change] # What's changing?
453452
openspec validate --strict # Is it correct?
454-
openspec archive [change] [--yes|-y] # Mark complete (add --yes for automation)
453+
openspec archive <change-id> [--yes|-y] # Mark complete (add --yes for automation)
455454
```
456455

457456
Remember: Specs are truth. Changes are proposals. Keep them in sync.

src/core/templates/agents-template.ts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ Track these steps as TODOs and complete them one by one.
6060
After deployment, create separate PR to:
6161
- Move \`changes/[name]/\` → \`changes/archive/YYYY-MM-DD-[name]/\`
6262
- Update \`specs/\` if capabilities changed
63-
- Use \`openspec archive [change] --skip-specs --yes\` for tooling-only changes
63+
- Use \`openspec archive <change-id> --skip-specs --yes\` for tooling-only changes (always pass the change ID explicitly)
6464
- Run \`openspec validate --strict\` to confirm the archived change passes checks
6565
6666
## Before Any Task
@@ -97,7 +97,7 @@ openspec list --specs # List specifications
9797
openspec show [item] # Display change or spec
9898
openspec diff [change] # Show spec differences
9999
openspec validate [item] # Validate changes or specs
100-
openspec archive [change] [--yes|-y] # Archive after deployment (add --yes for non-interactive runs)
100+
openspec archive <change-id> [--yes|-y] # Archive after deployment (add --yes for non-interactive runs)
101101
102102
# Project management
103103
openspec init [path] # Initialize OpenSpec
@@ -450,7 +450,7 @@ openspec list # What's in progress?
450450
openspec show [item] # View details
451451
openspec diff [change] # What's changing?
452452
openspec validate --strict # Is it correct?
453-
openspec archive [change] [--yes|-y] # Mark complete (add --yes for automation)
453+
openspec archive <change-id> [--yes|-y] # Mark complete (add --yes for automation)
454454
\`\`\`
455455
456456
Remember: Specs are truth. Changes are proposals. Keep them in sync.

0 commit comments

Comments
 (0)