完成uv运行python代码的skill
This commit is contained in:
@@ -1,156 +0,0 @@
|
|||||||
---
|
|
||||||
name: openspec-apply-change
|
|
||||||
description: Implement tasks from an OpenSpec change. Use when the user wants to start implementing, continue implementation, or work through tasks.
|
|
||||||
license: MIT
|
|
||||||
compatibility: Requires openspec CLI.
|
|
||||||
metadata:
|
|
||||||
author: openspec
|
|
||||||
version: "1.0"
|
|
||||||
generatedBy: "1.1.1"
|
|
||||||
---
|
|
||||||
|
|
||||||
Implement tasks from an OpenSpec change.
|
|
||||||
|
|
||||||
**Input**: Optionally specify a change name. If omitted, check if it can be inferred from conversation context. If vague or ambiguous you MUST prompt for available changes.
|
|
||||||
|
|
||||||
**Steps**
|
|
||||||
|
|
||||||
1. **Select the change**
|
|
||||||
|
|
||||||
If a name is provided, use it. Otherwise:
|
|
||||||
- Infer from conversation context if the user mentioned a change
|
|
||||||
- Auto-select if only one active change exists
|
|
||||||
- If ambiguous, run `openspec list --json` to get available changes and use the **AskUserQuestion tool** to let the user select
|
|
||||||
|
|
||||||
Always announce: "Using change: <name>" and how to override (e.g., `/opsx:apply <other>`).
|
|
||||||
|
|
||||||
2. **Check status to understand the schema**
|
|
||||||
```bash
|
|
||||||
openspec status --change "<name>" --json
|
|
||||||
```
|
|
||||||
Parse the JSON to understand:
|
|
||||||
- `schemaName`: The workflow being used (e.g., "spec-driven")
|
|
||||||
- Which artifact contains the tasks (typically "tasks" for spec-driven, check status for others)
|
|
||||||
|
|
||||||
3. **Get apply instructions**
|
|
||||||
|
|
||||||
```bash
|
|
||||||
openspec instructions apply --change "<name>" --json
|
|
||||||
```
|
|
||||||
|
|
||||||
This returns:
|
|
||||||
- Context file paths (varies by schema - could be proposal/specs/design/tasks or spec/tests/implementation/docs)
|
|
||||||
- Progress (total, complete, remaining)
|
|
||||||
- Task list with status
|
|
||||||
- Dynamic instruction based on current state
|
|
||||||
|
|
||||||
**Handle states:**
|
|
||||||
- If `state: "blocked"` (missing artifacts): show message, suggest using openspec-continue-change
|
|
||||||
- If `state: "all_done"`: congratulate, suggest archive
|
|
||||||
- Otherwise: proceed to implementation
|
|
||||||
|
|
||||||
4. **Read context files**
|
|
||||||
|
|
||||||
Read the files listed in `contextFiles` from the apply instructions output.
|
|
||||||
The files depend on the schema being used:
|
|
||||||
- **spec-driven**: proposal, specs, design, tasks
|
|
||||||
- Other schemas: follow the contextFiles from CLI output
|
|
||||||
|
|
||||||
5. **Show current progress**
|
|
||||||
|
|
||||||
Display:
|
|
||||||
- Schema being used
|
|
||||||
- Progress: "N/M tasks complete"
|
|
||||||
- Remaining tasks overview
|
|
||||||
- Dynamic instruction from CLI
|
|
||||||
|
|
||||||
6. **Implement tasks (loop until done or blocked)**
|
|
||||||
|
|
||||||
For each pending task:
|
|
||||||
- Show which task is being worked on
|
|
||||||
- Make the code changes required
|
|
||||||
- Keep changes minimal and focused
|
|
||||||
- Mark task complete in the tasks file: `- [ ]` → `- [x]`
|
|
||||||
- Continue to next task
|
|
||||||
|
|
||||||
**Pause if:**
|
|
||||||
- Task is unclear → ask for clarification
|
|
||||||
- Implementation reveals a design issue → suggest updating artifacts
|
|
||||||
- Error or blocker encountered → report and wait for guidance
|
|
||||||
- User interrupts
|
|
||||||
|
|
||||||
7. **On completion or pause, show status**
|
|
||||||
|
|
||||||
Display:
|
|
||||||
- Tasks completed this session
|
|
||||||
- Overall progress: "N/M tasks complete"
|
|
||||||
- If all done: suggest archive
|
|
||||||
- If paused: explain why and wait for guidance
|
|
||||||
|
|
||||||
**Output During Implementation**
|
|
||||||
|
|
||||||
```
|
|
||||||
## Implementing: <change-name> (schema: <schema-name>)
|
|
||||||
|
|
||||||
Working on task 3/7: <task description>
|
|
||||||
[...implementation happening...]
|
|
||||||
✓ Task complete
|
|
||||||
|
|
||||||
Working on task 4/7: <task description>
|
|
||||||
[...implementation happening...]
|
|
||||||
✓ Task complete
|
|
||||||
```
|
|
||||||
|
|
||||||
**Output On Completion**
|
|
||||||
|
|
||||||
```
|
|
||||||
## Implementation Complete
|
|
||||||
|
|
||||||
**Change:** <change-name>
|
|
||||||
**Schema:** <schema-name>
|
|
||||||
**Progress:** 7/7 tasks complete ✓
|
|
||||||
|
|
||||||
### Completed This Session
|
|
||||||
- [x] Task 1
|
|
||||||
- [x] Task 2
|
|
||||||
...
|
|
||||||
|
|
||||||
All tasks complete! Ready to archive this change.
|
|
||||||
```
|
|
||||||
|
|
||||||
**Output On Pause (Issue Encountered)**
|
|
||||||
|
|
||||||
```
|
|
||||||
## Implementation Paused
|
|
||||||
|
|
||||||
**Change:** <change-name>
|
|
||||||
**Schema:** <schema-name>
|
|
||||||
**Progress:** 4/7 tasks complete
|
|
||||||
|
|
||||||
### Issue Encountered
|
|
||||||
<description of the issue>
|
|
||||||
|
|
||||||
**Options:**
|
|
||||||
1. <option 1>
|
|
||||||
2. <option 2>
|
|
||||||
3. Other approach
|
|
||||||
|
|
||||||
What would you like to do?
|
|
||||||
```
|
|
||||||
|
|
||||||
**Guardrails**
|
|
||||||
- Keep going through tasks until done or blocked
|
|
||||||
- Always read context files before starting (from the apply instructions output)
|
|
||||||
- If task is ambiguous, pause and ask before implementing
|
|
||||||
- If implementation reveals issues, pause and suggest artifact updates
|
|
||||||
- Keep code changes minimal and scoped to each task
|
|
||||||
- Update task checkbox immediately after completing each task
|
|
||||||
- Pause on errors, blockers, or unclear requirements - don't guess
|
|
||||||
- Use contextFiles from CLI output, don't assume specific file names
|
|
||||||
|
|
||||||
**Fluid Workflow Integration**
|
|
||||||
|
|
||||||
This skill supports the "actions on a change" model:
|
|
||||||
|
|
||||||
- **Can be invoked anytime**: Before all artifacts are done (if tasks exist), after partial implementation, interleaved with other actions
|
|
||||||
- **Allows artifact updates**: If implementation reveals design issues, suggest updating artifacts - not phase-locked, work fluidly
|
|
||||||
@@ -1,114 +0,0 @@
|
|||||||
---
|
|
||||||
name: openspec-archive-change
|
|
||||||
description: Archive a completed change in the experimental workflow. Use when the user wants to finalize and archive a change after implementation is complete.
|
|
||||||
license: MIT
|
|
||||||
compatibility: Requires openspec CLI.
|
|
||||||
metadata:
|
|
||||||
author: openspec
|
|
||||||
version: "1.0"
|
|
||||||
generatedBy: "1.1.1"
|
|
||||||
---
|
|
||||||
|
|
||||||
Archive a completed change in the experimental workflow.
|
|
||||||
|
|
||||||
**Input**: Optionally specify a change name. If omitted, check if it can be inferred from conversation context. If vague or ambiguous you MUST prompt for available changes.
|
|
||||||
|
|
||||||
**Steps**
|
|
||||||
|
|
||||||
1. **If no change name provided, prompt for selection**
|
|
||||||
|
|
||||||
Run `openspec list --json` to get available changes. Use the **AskUserQuestion tool** to let the user select.
|
|
||||||
|
|
||||||
Show only active changes (not already archived).
|
|
||||||
Include the schema used for each change if available.
|
|
||||||
|
|
||||||
**IMPORTANT**: Do NOT guess or auto-select a change. Always let the user choose.
|
|
||||||
|
|
||||||
2. **Check artifact completion status**
|
|
||||||
|
|
||||||
Run `openspec status --change "<name>" --json` to check artifact completion.
|
|
||||||
|
|
||||||
Parse the JSON to understand:
|
|
||||||
- `schemaName`: The workflow being used
|
|
||||||
- `artifacts`: List of artifacts with their status (`done` or other)
|
|
||||||
|
|
||||||
**If any artifacts are not `done`:**
|
|
||||||
- Display warning listing incomplete artifacts
|
|
||||||
- Use **AskUserQuestion tool** to confirm user wants to proceed
|
|
||||||
- Proceed if user confirms
|
|
||||||
|
|
||||||
3. **Check task completion status**
|
|
||||||
|
|
||||||
Read the tasks file (typically `tasks.md`) to check for incomplete tasks.
|
|
||||||
|
|
||||||
Count tasks marked with `- [ ]` (incomplete) vs `- [x]` (complete).
|
|
||||||
|
|
||||||
**If incomplete tasks found:**
|
|
||||||
- Display warning showing count of incomplete tasks
|
|
||||||
- Use **AskUserQuestion tool** to confirm user wants to proceed
|
|
||||||
- Proceed if user confirms
|
|
||||||
|
|
||||||
**If no tasks file exists:** Proceed without task-related warning.
|
|
||||||
|
|
||||||
4. **Assess delta spec sync state**
|
|
||||||
|
|
||||||
Check for delta specs at `openspec/changes/<name>/specs/`. If none exist, proceed without sync prompt.
|
|
||||||
|
|
||||||
**If delta specs exist:**
|
|
||||||
- Compare each delta spec with its corresponding main spec at `openspec/specs/<capability>/spec.md`
|
|
||||||
- Determine what changes would be applied (adds, modifications, removals, renames)
|
|
||||||
- Show a combined summary before prompting
|
|
||||||
|
|
||||||
**Prompt options:**
|
|
||||||
- If changes needed: "Sync now (recommended)", "Archive without syncing"
|
|
||||||
- If already synced: "Archive now", "Sync anyway", "Cancel"
|
|
||||||
|
|
||||||
If user chooses sync, execute /opsx:sync logic (use the openspec-sync-specs skill). Proceed to archive regardless of choice.
|
|
||||||
|
|
||||||
5. **Perform the archive**
|
|
||||||
|
|
||||||
Create the archive directory if it doesn't exist:
|
|
||||||
```bash
|
|
||||||
mkdir -p openspec/changes/archive
|
|
||||||
```
|
|
||||||
|
|
||||||
Generate target name using current date: `YYYY-MM-DD-<change-name>`
|
|
||||||
|
|
||||||
**Check if target already exists:**
|
|
||||||
- If yes: Fail with error, suggest renaming existing archive or using different date
|
|
||||||
- If no: Move the change directory to archive
|
|
||||||
|
|
||||||
```bash
|
|
||||||
mv openspec/changes/<name> openspec/changes/archive/YYYY-MM-DD-<name>
|
|
||||||
```
|
|
||||||
|
|
||||||
6. **Display summary**
|
|
||||||
|
|
||||||
Show archive completion summary including:
|
|
||||||
- Change name
|
|
||||||
- Schema that was used
|
|
||||||
- Archive location
|
|
||||||
- Whether specs were synced (if applicable)
|
|
||||||
- Note about any warnings (incomplete artifacts/tasks)
|
|
||||||
|
|
||||||
**Output On Success**
|
|
||||||
|
|
||||||
```
|
|
||||||
## Archive Complete
|
|
||||||
|
|
||||||
**Change:** <change-name>
|
|
||||||
**Schema:** <schema-name>
|
|
||||||
**Archived to:** openspec/changes/archive/YYYY-MM-DD-<name>/
|
|
||||||
**Specs:** ✓ Synced to main specs (or "No delta specs" or "Sync skipped")
|
|
||||||
|
|
||||||
All artifacts complete. All tasks complete.
|
|
||||||
```
|
|
||||||
|
|
||||||
**Guardrails**
|
|
||||||
- Always prompt for change selection if not provided
|
|
||||||
- Use artifact graph (openspec status --json) for completion checking
|
|
||||||
- Don't block archive on warnings - just inform and confirm
|
|
||||||
- Preserve .openspec.yaml when moving to archive (it moves with the directory)
|
|
||||||
- Show clear summary of what happened
|
|
||||||
- If sync is requested, use openspec-sync-specs approach (agent-driven)
|
|
||||||
- If delta specs exist, always run the sync assessment and show the combined summary before prompting
|
|
||||||
@@ -1,246 +0,0 @@
|
|||||||
---
|
|
||||||
name: openspec-bulk-archive-change
|
|
||||||
description: Archive multiple completed changes at once. Use when archiving several parallel changes.
|
|
||||||
license: MIT
|
|
||||||
compatibility: Requires openspec CLI.
|
|
||||||
metadata:
|
|
||||||
author: openspec
|
|
||||||
version: "1.0"
|
|
||||||
generatedBy: "1.1.1"
|
|
||||||
---
|
|
||||||
|
|
||||||
Archive multiple completed changes in a single operation.
|
|
||||||
|
|
||||||
This skill allows you to batch-archive changes, handling spec conflicts intelligently by checking the codebase to determine what's actually implemented.
|
|
||||||
|
|
||||||
**Input**: None required (prompts for selection)
|
|
||||||
|
|
||||||
**Steps**
|
|
||||||
|
|
||||||
1. **Get active changes**
|
|
||||||
|
|
||||||
Run `openspec list --json` to get all active changes.
|
|
||||||
|
|
||||||
If no active changes exist, inform user and stop.
|
|
||||||
|
|
||||||
2. **Prompt for change selection**
|
|
||||||
|
|
||||||
Use **AskUserQuestion tool** with multi-select to let user choose changes:
|
|
||||||
- Show each change with its schema
|
|
||||||
- Include an option for "All changes"
|
|
||||||
- Allow any number of selections (1+ works, 2+ is the typical use case)
|
|
||||||
|
|
||||||
**IMPORTANT**: Do NOT auto-select. Always let the user choose.
|
|
||||||
|
|
||||||
3. **Batch validation - gather status for all selected changes**
|
|
||||||
|
|
||||||
For each selected change, collect:
|
|
||||||
|
|
||||||
a. **Artifact status** - Run `openspec status --change "<name>" --json`
|
|
||||||
- Parse `schemaName` and `artifacts` list
|
|
||||||
- Note which artifacts are `done` vs other states
|
|
||||||
|
|
||||||
b. **Task completion** - Read `openspec/changes/<name>/tasks.md`
|
|
||||||
- Count `- [ ]` (incomplete) vs `- [x]` (complete)
|
|
||||||
- If no tasks file exists, note as "No tasks"
|
|
||||||
|
|
||||||
c. **Delta specs** - Check `openspec/changes/<name>/specs/` directory
|
|
||||||
- List which capability specs exist
|
|
||||||
- For each, extract requirement names (lines matching `### Requirement: <name>`)
|
|
||||||
|
|
||||||
4. **Detect spec conflicts**
|
|
||||||
|
|
||||||
Build a map of `capability -> [changes that touch it]`:
|
|
||||||
|
|
||||||
```
|
|
||||||
auth -> [change-a, change-b] <- CONFLICT (2+ changes)
|
|
||||||
api -> [change-c] <- OK (only 1 change)
|
|
||||||
```
|
|
||||||
|
|
||||||
A conflict exists when 2+ selected changes have delta specs for the same capability.
|
|
||||||
|
|
||||||
5. **Resolve conflicts agentically**
|
|
||||||
|
|
||||||
**For each conflict**, investigate the codebase:
|
|
||||||
|
|
||||||
a. **Read the delta specs** from each conflicting change to understand what each claims to add/modify
|
|
||||||
|
|
||||||
b. **Search the codebase** for implementation evidence:
|
|
||||||
- Look for code implementing requirements from each delta spec
|
|
||||||
- Check for related files, functions, or tests
|
|
||||||
|
|
||||||
c. **Determine resolution**:
|
|
||||||
- If only one change is actually implemented -> sync that one's specs
|
|
||||||
- If both implemented -> apply in chronological order (older first, newer overwrites)
|
|
||||||
- If neither implemented -> skip spec sync, warn user
|
|
||||||
|
|
||||||
d. **Record resolution** for each conflict:
|
|
||||||
- Which change's specs to apply
|
|
||||||
- In what order (if both)
|
|
||||||
- Rationale (what was found in codebase)
|
|
||||||
|
|
||||||
6. **Show consolidated status table**
|
|
||||||
|
|
||||||
Display a table summarizing all changes:
|
|
||||||
|
|
||||||
```
|
|
||||||
| Change | Artifacts | Tasks | Specs | Conflicts | Status |
|
|
||||||
|---------------------|-----------|-------|---------|-----------|--------|
|
|
||||||
| schema-management | Done | 5/5 | 2 delta | None | Ready |
|
|
||||||
| project-config | Done | 3/3 | 1 delta | None | Ready |
|
|
||||||
| add-oauth | Done | 4/4 | 1 delta | auth (!) | Ready* |
|
|
||||||
| add-verify-skill | 1 left | 2/5 | None | None | Warn |
|
|
||||||
```
|
|
||||||
|
|
||||||
For conflicts, show the resolution:
|
|
||||||
```
|
|
||||||
* Conflict resolution:
|
|
||||||
- auth spec: Will apply add-oauth then add-jwt (both implemented, chronological order)
|
|
||||||
```
|
|
||||||
|
|
||||||
For incomplete changes, show warnings:
|
|
||||||
```
|
|
||||||
Warnings:
|
|
||||||
- add-verify-skill: 1 incomplete artifact, 3 incomplete tasks
|
|
||||||
```
|
|
||||||
|
|
||||||
7. **Confirm batch operation**
|
|
||||||
|
|
||||||
Use **AskUserQuestion tool** with a single confirmation:
|
|
||||||
|
|
||||||
- "Archive N changes?" with options based on status
|
|
||||||
- Options might include:
|
|
||||||
- "Archive all N changes"
|
|
||||||
- "Archive only N ready changes (skip incomplete)"
|
|
||||||
- "Cancel"
|
|
||||||
|
|
||||||
If there are incomplete changes, make clear they'll be archived with warnings.
|
|
||||||
|
|
||||||
8. **Execute archive for each confirmed change**
|
|
||||||
|
|
||||||
Process changes in the determined order (respecting conflict resolution):
|
|
||||||
|
|
||||||
a. **Sync specs** if delta specs exist:
|
|
||||||
- Use the openspec-sync-specs approach (agent-driven intelligent merge)
|
|
||||||
- For conflicts, apply in resolved order
|
|
||||||
- Track if sync was done
|
|
||||||
|
|
||||||
b. **Perform the archive**:
|
|
||||||
```bash
|
|
||||||
mkdir -p openspec/changes/archive
|
|
||||||
mv openspec/changes/<name> openspec/changes/archive/YYYY-MM-DD-<name>
|
|
||||||
```
|
|
||||||
|
|
||||||
c. **Track outcome** for each change:
|
|
||||||
- Success: archived successfully
|
|
||||||
- Failed: error during archive (record error)
|
|
||||||
- Skipped: user chose not to archive (if applicable)
|
|
||||||
|
|
||||||
9. **Display summary**
|
|
||||||
|
|
||||||
Show final results:
|
|
||||||
|
|
||||||
```
|
|
||||||
## Bulk Archive Complete
|
|
||||||
|
|
||||||
Archived 3 changes:
|
|
||||||
- schema-management-cli -> archive/2026-01-19-schema-management-cli/
|
|
||||||
- project-config -> archive/2026-01-19-project-config/
|
|
||||||
- add-oauth -> archive/2026-01-19-add-oauth/
|
|
||||||
|
|
||||||
Skipped 1 change:
|
|
||||||
- add-verify-skill (user chose not to archive incomplete)
|
|
||||||
|
|
||||||
Spec sync summary:
|
|
||||||
- 4 delta specs synced to main specs
|
|
||||||
- 1 conflict resolved (auth: applied both in chronological order)
|
|
||||||
```
|
|
||||||
|
|
||||||
If any failures:
|
|
||||||
```
|
|
||||||
Failed 1 change:
|
|
||||||
- some-change: Archive directory already exists
|
|
||||||
```
|
|
||||||
|
|
||||||
**Conflict Resolution Examples**
|
|
||||||
|
|
||||||
Example 1: Only one implemented
|
|
||||||
```
|
|
||||||
Conflict: specs/auth/spec.md touched by [add-oauth, add-jwt]
|
|
||||||
|
|
||||||
Checking add-oauth:
|
|
||||||
- Delta adds "OAuth Provider Integration" requirement
|
|
||||||
- Searching codebase... found src/auth/oauth.ts implementing OAuth flow
|
|
||||||
|
|
||||||
Checking add-jwt:
|
|
||||||
- Delta adds "JWT Token Handling" requirement
|
|
||||||
- Searching codebase... no JWT implementation found
|
|
||||||
|
|
||||||
Resolution: Only add-oauth is implemented. Will sync add-oauth specs only.
|
|
||||||
```
|
|
||||||
|
|
||||||
Example 2: Both implemented
|
|
||||||
```
|
|
||||||
Conflict: specs/api/spec.md touched by [add-rest-api, add-graphql]
|
|
||||||
|
|
||||||
Checking add-rest-api (created 2026-01-10):
|
|
||||||
- Delta adds "REST Endpoints" requirement
|
|
||||||
- Searching codebase... found src/api/rest.ts
|
|
||||||
|
|
||||||
Checking add-graphql (created 2026-01-15):
|
|
||||||
- Delta adds "GraphQL Schema" requirement
|
|
||||||
- Searching codebase... found src/api/graphql.ts
|
|
||||||
|
|
||||||
Resolution: Both implemented. Will apply add-rest-api specs first,
|
|
||||||
then add-graphql specs (chronological order, newer takes precedence).
|
|
||||||
```
|
|
||||||
|
|
||||||
**Output On Success**
|
|
||||||
|
|
||||||
```
|
|
||||||
## Bulk Archive Complete
|
|
||||||
|
|
||||||
Archived N changes:
|
|
||||||
- <change-1> -> archive/YYYY-MM-DD-<change-1>/
|
|
||||||
- <change-2> -> archive/YYYY-MM-DD-<change-2>/
|
|
||||||
|
|
||||||
Spec sync summary:
|
|
||||||
- N delta specs synced to main specs
|
|
||||||
- No conflicts (or: M conflicts resolved)
|
|
||||||
```
|
|
||||||
|
|
||||||
**Output On Partial Success**
|
|
||||||
|
|
||||||
```
|
|
||||||
## Bulk Archive Complete (partial)
|
|
||||||
|
|
||||||
Archived N changes:
|
|
||||||
- <change-1> -> archive/YYYY-MM-DD-<change-1>/
|
|
||||||
|
|
||||||
Skipped M changes:
|
|
||||||
- <change-2> (user chose not to archive incomplete)
|
|
||||||
|
|
||||||
Failed K changes:
|
|
||||||
- <change-3>: Archive directory already exists
|
|
||||||
```
|
|
||||||
|
|
||||||
**Output When No Changes**
|
|
||||||
|
|
||||||
```
|
|
||||||
## No Changes to Archive
|
|
||||||
|
|
||||||
No active changes found. Use `/opsx:new` to create a new change.
|
|
||||||
```
|
|
||||||
|
|
||||||
**Guardrails**
|
|
||||||
- Allow any number of changes (1+ is fine, 2+ is the typical use case)
|
|
||||||
- Always prompt for selection, never auto-select
|
|
||||||
- Detect spec conflicts early and resolve by checking codebase
|
|
||||||
- When both changes are implemented, apply specs in chronological order
|
|
||||||
- Skip spec sync only when implementation is missing (warn user)
|
|
||||||
- Show clear per-change status before confirming
|
|
||||||
- Use single confirmation for entire batch
|
|
||||||
- Track and report all outcomes (success/skip/fail)
|
|
||||||
- Preserve .openspec.yaml when moving to archive
|
|
||||||
- Archive directory target uses current date: YYYY-MM-DD-<name>
|
|
||||||
- If archive target exists, fail that change but continue with others
|
|
||||||
@@ -1,118 +0,0 @@
|
|||||||
---
|
|
||||||
name: openspec-continue-change
|
|
||||||
description: Continue working on an OpenSpec change by creating the next artifact. Use when the user wants to progress their change, create the next artifact, or continue their workflow.
|
|
||||||
license: MIT
|
|
||||||
compatibility: Requires openspec CLI.
|
|
||||||
metadata:
|
|
||||||
author: openspec
|
|
||||||
version: "1.0"
|
|
||||||
generatedBy: "1.1.1"
|
|
||||||
---
|
|
||||||
|
|
||||||
Continue working on a change by creating the next artifact.
|
|
||||||
|
|
||||||
**Input**: Optionally specify a change name. If omitted, check if it can be inferred from conversation context. If vague or ambiguous you MUST prompt for available changes.
|
|
||||||
|
|
||||||
**Steps**
|
|
||||||
|
|
||||||
1. **If no change name provided, prompt for selection**
|
|
||||||
|
|
||||||
Run `openspec list --json` to get available changes sorted by most recently modified. Then use the **AskUserQuestion tool** to let the user select which change to work on.
|
|
||||||
|
|
||||||
Present the top 3-4 most recently modified changes as options, showing:
|
|
||||||
- Change name
|
|
||||||
- Schema (from `schema` field if present, otherwise "spec-driven")
|
|
||||||
- Status (e.g., "0/5 tasks", "complete", "no tasks")
|
|
||||||
- How recently it was modified (from `lastModified` field)
|
|
||||||
|
|
||||||
Mark the most recently modified change as "(Recommended)" since it's likely what the user wants to continue.
|
|
||||||
|
|
||||||
**IMPORTANT**: Do NOT guess or auto-select a change. Always let the user choose.
|
|
||||||
|
|
||||||
2. **Check current status**
|
|
||||||
```bash
|
|
||||||
openspec status --change "<name>" --json
|
|
||||||
```
|
|
||||||
Parse the JSON to understand current state. The response includes:
|
|
||||||
- `schemaName`: The workflow schema being used (e.g., "spec-driven")
|
|
||||||
- `artifacts`: Array of artifacts with their status ("done", "ready", "blocked")
|
|
||||||
- `isComplete`: Boolean indicating if all artifacts are complete
|
|
||||||
|
|
||||||
3. **Act based on status**:
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
**If all artifacts are complete (`isComplete: true`)**:
|
|
||||||
- Congratulate the user
|
|
||||||
- Show final status including the schema used
|
|
||||||
- Suggest: "All artifacts created! You can now implement this change or archive it."
|
|
||||||
- STOP
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
**If artifacts are ready to create** (status shows artifacts with `status: "ready"`):
|
|
||||||
- Pick the FIRST artifact with `status: "ready"` from the status output
|
|
||||||
- Get its instructions:
|
|
||||||
```bash
|
|
||||||
openspec instructions <artifact-id> --change "<name>" --json
|
|
||||||
```
|
|
||||||
- Parse the JSON. The key fields are:
|
|
||||||
- `context`: Project background (constraints for you - do NOT include in output)
|
|
||||||
- `rules`: Artifact-specific rules (constraints for you - do NOT include in output)
|
|
||||||
- `template`: The structure to use for your output file
|
|
||||||
- `instruction`: Schema-specific guidance
|
|
||||||
- `outputPath`: Where to write the artifact
|
|
||||||
- `dependencies`: Completed artifacts to read for context
|
|
||||||
- **Create the artifact file**:
|
|
||||||
- Read any completed dependency files for context
|
|
||||||
- Use `template` as the structure - fill in its sections
|
|
||||||
- Apply `context` and `rules` as constraints when writing - but do NOT copy them into the file
|
|
||||||
- Write to the output path specified in instructions
|
|
||||||
- Show what was created and what's now unlocked
|
|
||||||
- STOP after creating ONE artifact
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
**If no artifacts are ready (all blocked)**:
|
|
||||||
- This shouldn't happen with a valid schema
|
|
||||||
- Show status and suggest checking for issues
|
|
||||||
|
|
||||||
4. **After creating an artifact, show progress**
|
|
||||||
```bash
|
|
||||||
openspec status --change "<name>"
|
|
||||||
```
|
|
||||||
|
|
||||||
**Output**
|
|
||||||
|
|
||||||
After each invocation, show:
|
|
||||||
- Which artifact was created
|
|
||||||
- Schema workflow being used
|
|
||||||
- Current progress (N/M complete)
|
|
||||||
- What artifacts are now unlocked
|
|
||||||
- Prompt: "Want to continue? Just ask me to continue or tell me what to do next."
|
|
||||||
|
|
||||||
**Artifact Creation Guidelines**
|
|
||||||
|
|
||||||
The artifact types and their purpose depend on the schema. Use the `instruction` field from the instructions output to understand what to create.
|
|
||||||
|
|
||||||
Common artifact patterns:
|
|
||||||
|
|
||||||
**spec-driven schema** (proposal → specs → design → tasks):
|
|
||||||
- **proposal.md**: Ask user about the change if not clear. Fill in Why, What Changes, Capabilities, Impact.
|
|
||||||
- The Capabilities section is critical - each capability listed will need a spec file.
|
|
||||||
- **specs/<capability>/spec.md**: Create one spec per capability listed in the proposal's Capabilities section (use the capability name, not the change name).
|
|
||||||
- **design.md**: Document technical decisions, architecture, and implementation approach.
|
|
||||||
- **tasks.md**: Break down implementation into checkboxed tasks.
|
|
||||||
|
|
||||||
For other schemas, follow the `instruction` field from the CLI output.
|
|
||||||
|
|
||||||
**Guardrails**
|
|
||||||
- Create ONE artifact per invocation
|
|
||||||
- Always read dependency artifacts before creating a new one
|
|
||||||
- Never skip artifacts or create out of order
|
|
||||||
- If context is unclear, ask the user before creating
|
|
||||||
- Verify the artifact file exists after writing before marking progress
|
|
||||||
- Use the schema's artifact sequence, don't assume specific artifact names
|
|
||||||
- **IMPORTANT**: `context` and `rules` are constraints for YOU, not content for the file
|
|
||||||
- Do NOT copy `<context>`, `<rules>`, `<project_context>` blocks into the artifact
|
|
||||||
- These guide what you write, but should never appear in the output
|
|
||||||
@@ -1,290 +0,0 @@
|
|||||||
---
|
|
||||||
name: openspec-explore
|
|
||||||
description: Enter explore mode - a thinking partner for exploring ideas, investigating problems, and clarifying requirements. Use when the user wants to think through something before or during a change.
|
|
||||||
license: MIT
|
|
||||||
compatibility: Requires openspec CLI.
|
|
||||||
metadata:
|
|
||||||
author: openspec
|
|
||||||
version: "1.0"
|
|
||||||
generatedBy: "1.1.1"
|
|
||||||
---
|
|
||||||
|
|
||||||
Enter explore mode. Think deeply. Visualize freely. Follow the conversation wherever it goes.
|
|
||||||
|
|
||||||
**IMPORTANT: Explore mode is for thinking, not implementing.** You may read files, search code, and investigate the codebase, but you must NEVER write code or implement features. If the user asks you to implement something, remind them to exit explore mode first (e.g., start a change with `/opsx:new` or `/opsx:ff`). You MAY create OpenSpec artifacts (proposals, designs, specs) if the user asks—that's capturing thinking, not implementing.
|
|
||||||
|
|
||||||
**This is a stance, not a workflow.** There are no fixed steps, no required sequence, no mandatory outputs. You're a thinking partner helping the user explore.
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## The Stance
|
|
||||||
|
|
||||||
- **Curious, not prescriptive** - Ask questions that emerge naturally, don't follow a script
|
|
||||||
- **Open threads, not interrogations** - Surface multiple interesting directions and let the user follow what resonates. Don't funnel them through a single path of questions.
|
|
||||||
- **Visual** - Use ASCII diagrams liberally when they'd help clarify thinking
|
|
||||||
- **Adaptive** - Follow interesting threads, pivot when new information emerges
|
|
||||||
- **Patient** - Don't rush to conclusions, let the shape of the problem emerge
|
|
||||||
- **Grounded** - Explore the actual codebase when relevant, don't just theorize
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## What You Might Do
|
|
||||||
|
|
||||||
Depending on what the user brings, you might:
|
|
||||||
|
|
||||||
**Explore the problem space**
|
|
||||||
- Ask clarifying questions that emerge from what they said
|
|
||||||
- Challenge assumptions
|
|
||||||
- Reframe the problem
|
|
||||||
- Find analogies
|
|
||||||
|
|
||||||
**Investigate the codebase**
|
|
||||||
- Map existing architecture relevant to the discussion
|
|
||||||
- Find integration points
|
|
||||||
- Identify patterns already in use
|
|
||||||
- Surface hidden complexity
|
|
||||||
|
|
||||||
**Compare options**
|
|
||||||
- Brainstorm multiple approaches
|
|
||||||
- Build comparison tables
|
|
||||||
- Sketch tradeoffs
|
|
||||||
- Recommend a path (if asked)
|
|
||||||
|
|
||||||
**Visualize**
|
|
||||||
```
|
|
||||||
┌─────────────────────────────────────────┐
|
|
||||||
│ Use ASCII diagrams liberally │
|
|
||||||
├─────────────────────────────────────────┤
|
|
||||||
│ │
|
|
||||||
│ ┌────────┐ ┌────────┐ │
|
|
||||||
│ │ State │────────▶│ State │ │
|
|
||||||
│ │ A │ │ B │ │
|
|
||||||
│ └────────┘ └────────┘ │
|
|
||||||
│ │
|
|
||||||
│ System diagrams, state machines, │
|
|
||||||
│ data flows, architecture sketches, │
|
|
||||||
│ dependency graphs, comparison tables │
|
|
||||||
│ │
|
|
||||||
└─────────────────────────────────────────┘
|
|
||||||
```
|
|
||||||
|
|
||||||
**Surface risks and unknowns**
|
|
||||||
- Identify what could go wrong
|
|
||||||
- Find gaps in understanding
|
|
||||||
- Suggest spikes or investigations
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## OpenSpec Awareness
|
|
||||||
|
|
||||||
You have full context of the OpenSpec system. Use it naturally, don't force it.
|
|
||||||
|
|
||||||
### Check for context
|
|
||||||
|
|
||||||
At the start, quickly check what exists:
|
|
||||||
```bash
|
|
||||||
openspec list --json
|
|
||||||
```
|
|
||||||
|
|
||||||
This tells you:
|
|
||||||
- If there are active changes
|
|
||||||
- Their names, schemas, and status
|
|
||||||
- What the user might be working on
|
|
||||||
|
|
||||||
### When no change exists
|
|
||||||
|
|
||||||
Think freely. When insights crystallize, you might offer:
|
|
||||||
|
|
||||||
- "This feels solid enough to start a change. Want me to create one?"
|
|
||||||
→ Can transition to `/opsx:new` or `/opsx:ff`
|
|
||||||
- Or keep exploring - no pressure to formalize
|
|
||||||
|
|
||||||
### When a change exists
|
|
||||||
|
|
||||||
If the user mentions a change or you detect one is relevant:
|
|
||||||
|
|
||||||
1. **Read existing artifacts for context**
|
|
||||||
- `openspec/changes/<name>/proposal.md`
|
|
||||||
- `openspec/changes/<name>/design.md`
|
|
||||||
- `openspec/changes/<name>/tasks.md`
|
|
||||||
- etc.
|
|
||||||
|
|
||||||
2. **Reference them naturally in conversation**
|
|
||||||
- "Your design mentions using Redis, but we just realized SQLite fits better..."
|
|
||||||
- "The proposal scopes this to premium users, but we're now thinking everyone..."
|
|
||||||
|
|
||||||
3. **Offer to capture when decisions are made**
|
|
||||||
|
|
||||||
| Insight Type | Where to Capture |
|
|
||||||
|--------------|------------------|
|
|
||||||
| New requirement discovered | `specs/<capability>/spec.md` |
|
|
||||||
| Requirement changed | `specs/<capability>/spec.md` |
|
|
||||||
| Design decision made | `design.md` |
|
|
||||||
| Scope changed | `proposal.md` |
|
|
||||||
| New work identified | `tasks.md` |
|
|
||||||
| Assumption invalidated | Relevant artifact |
|
|
||||||
|
|
||||||
Example offers:
|
|
||||||
- "That's a design decision. Capture it in design.md?"
|
|
||||||
- "This is a new requirement. Add it to specs?"
|
|
||||||
- "This changes scope. Update the proposal?"
|
|
||||||
|
|
||||||
4. **The user decides** - Offer and move on. Don't pressure. Don't auto-capture.
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## What You Don't Have To Do
|
|
||||||
|
|
||||||
- Follow a script
|
|
||||||
- Ask the same questions every time
|
|
||||||
- Produce a specific artifact
|
|
||||||
- Reach a conclusion
|
|
||||||
- Stay on topic if a tangent is valuable
|
|
||||||
- Be brief (this is thinking time)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Handling Different Entry Points
|
|
||||||
|
|
||||||
**User brings a vague idea:**
|
|
||||||
```
|
|
||||||
User: I'm thinking about adding real-time collaboration
|
|
||||||
|
|
||||||
You: Real-time collab is a big space. Let me think about this...
|
|
||||||
|
|
||||||
COLLABORATION SPECTRUM
|
|
||||||
════════════════════════════════════════════
|
|
||||||
|
|
||||||
Awareness Coordination Sync
|
|
||||||
│ │ │
|
|
||||||
▼ ▼ ▼
|
|
||||||
┌────────┐ ┌────────┐ ┌────────┐
|
|
||||||
│Presence│ │Cursors │ │ CRDT │
|
|
||||||
│ "3 │ │ Multi │ │Conflict│
|
|
||||||
│online" │ │ select │ │ free │
|
|
||||||
└────────┘ └────────┘ └────────┘
|
|
||||||
│ │ │
|
|
||||||
trivial moderate complex
|
|
||||||
|
|
||||||
Where's your head at?
|
|
||||||
```
|
|
||||||
|
|
||||||
**User brings a specific problem:**
|
|
||||||
```
|
|
||||||
User: The auth system is a mess
|
|
||||||
|
|
||||||
You: [reads codebase]
|
|
||||||
|
|
||||||
┌─────────────────────────────────────────────┐
|
|
||||||
│ CURRENT AUTH FLOW │
|
|
||||||
└─────────────────────────────────────────────┘
|
|
||||||
│
|
|
||||||
┌─────────────┼─────────────┐
|
|
||||||
▼ ▼ ▼
|
|
||||||
┌─────────┐ ┌─────────┐ ┌─────────┐
|
|
||||||
│ Google │ │ GitHub │ │ Email │
|
|
||||||
│ OAuth │ │ OAuth │ │ Magic │
|
|
||||||
└────┬────┘ └────┬────┘ └────┬────┘
|
|
||||||
│ │ │
|
|
||||||
└─────────────┼─────────────┘
|
|
||||||
▼
|
|
||||||
┌───────────┐
|
|
||||||
│ Session │
|
|
||||||
└─────┬─────┘
|
|
||||||
│
|
|
||||||
▼
|
|
||||||
┌───────────┐
|
|
||||||
│ Perms │
|
|
||||||
└───────────┘
|
|
||||||
|
|
||||||
I see three tangles. Which one's burning?
|
|
||||||
```
|
|
||||||
|
|
||||||
**User is stuck mid-implementation:**
|
|
||||||
```
|
|
||||||
User: /opsx:explore add-auth-system
|
|
||||||
The OAuth integration is more complex than expected
|
|
||||||
|
|
||||||
You: [reads change artifacts]
|
|
||||||
|
|
||||||
You're on task 4: "Implement OAuth flow"
|
|
||||||
|
|
||||||
Let me trace what's involved...
|
|
||||||
|
|
||||||
[draws diagram, explores options, suggests paths]
|
|
||||||
|
|
||||||
Want to update the design to reflect this?
|
|
||||||
Or add a spike task to investigate?
|
|
||||||
```
|
|
||||||
|
|
||||||
**User wants to compare options:**
|
|
||||||
```
|
|
||||||
User: Should we use Postgres or SQLite?
|
|
||||||
|
|
||||||
You: Generic answer is boring. What's the context?
|
|
||||||
|
|
||||||
User: A CLI tool that tracks local dev environments
|
|
||||||
|
|
||||||
You: That changes everything.
|
|
||||||
|
|
||||||
┌─────────────────────────────────────────────────┐
|
|
||||||
│ CLI TOOL DATA STORAGE │
|
|
||||||
└─────────────────────────────────────────────────┘
|
|
||||||
|
|
||||||
Key constraints:
|
|
||||||
• No daemon running
|
|
||||||
• Must work offline
|
|
||||||
• Single user
|
|
||||||
|
|
||||||
SQLite Postgres
|
|
||||||
Deployment embedded ✓ needs server ✗
|
|
||||||
Offline yes ✓ no ✗
|
|
||||||
Single file yes ✓ no ✗
|
|
||||||
|
|
||||||
SQLite. Not even close.
|
|
||||||
|
|
||||||
Unless... is there a sync component?
|
|
||||||
```
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Ending Discovery
|
|
||||||
|
|
||||||
There's no required ending. Discovery might:
|
|
||||||
|
|
||||||
- **Flow into action**: "Ready to start? /opsx:new or /opsx:ff"
|
|
||||||
- **Result in artifact updates**: "Updated design.md with these decisions"
|
|
||||||
- **Just provide clarity**: User has what they need, moves on
|
|
||||||
- **Continue later**: "We can pick this up anytime"
|
|
||||||
|
|
||||||
When it feels like things are crystallizing, you might summarize:
|
|
||||||
|
|
||||||
```
|
|
||||||
## What We Figured Out
|
|
||||||
|
|
||||||
**The problem**: [crystallized understanding]
|
|
||||||
|
|
||||||
**The approach**: [if one emerged]
|
|
||||||
|
|
||||||
**Open questions**: [if any remain]
|
|
||||||
|
|
||||||
**Next steps** (if ready):
|
|
||||||
- Create a change: /opsx:new <name>
|
|
||||||
- Fast-forward to tasks: /opsx:ff <name>
|
|
||||||
- Keep exploring: just keep talking
|
|
||||||
```
|
|
||||||
|
|
||||||
But this summary is optional. Sometimes the thinking IS the value.
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Guardrails
|
|
||||||
|
|
||||||
- **Don't implement** - Never write code or implement features. Creating OpenSpec artifacts is fine, writing application code is not.
|
|
||||||
- **Don't fake understanding** - If something is unclear, dig deeper
|
|
||||||
- **Don't rush** - Discovery is thinking time, not task time
|
|
||||||
- **Don't force structure** - Let patterns emerge naturally
|
|
||||||
- **Don't auto-capture** - Offer to save insights, don't just do it
|
|
||||||
- **Do visualize** - A good diagram is worth many paragraphs
|
|
||||||
- **Do explore the codebase** - Ground discussions in reality
|
|
||||||
- **Do question assumptions** - Including the user's and your own
|
|
||||||
@@ -1,101 +0,0 @@
|
|||||||
---
|
|
||||||
name: openspec-ff-change
|
|
||||||
description: Fast-forward through OpenSpec artifact creation. Use when the user wants to quickly create all artifacts needed for implementation without stepping through each one individually.
|
|
||||||
license: MIT
|
|
||||||
compatibility: Requires openspec CLI.
|
|
||||||
metadata:
|
|
||||||
author: openspec
|
|
||||||
version: "1.0"
|
|
||||||
generatedBy: "1.1.1"
|
|
||||||
---
|
|
||||||
|
|
||||||
Fast-forward through artifact creation - generate everything needed to start implementation in one go.
|
|
||||||
|
|
||||||
**Input**: The user's request should include a change name (kebab-case) OR a description of what they want to build.
|
|
||||||
|
|
||||||
**Steps**
|
|
||||||
|
|
||||||
1. **If no clear input provided, ask what they want to build**
|
|
||||||
|
|
||||||
Use the **AskUserQuestion tool** (open-ended, no preset options) to ask:
|
|
||||||
> "What change do you want to work on? Describe what you want to build or fix."
|
|
||||||
|
|
||||||
From their description, derive a kebab-case name (e.g., "add user authentication" → `add-user-auth`).
|
|
||||||
|
|
||||||
**IMPORTANT**: Do NOT proceed without understanding what the user wants to build.
|
|
||||||
|
|
||||||
2. **Create the change directory**
|
|
||||||
```bash
|
|
||||||
openspec new change "<name>"
|
|
||||||
```
|
|
||||||
This creates a scaffolded change at `openspec/changes/<name>/`.
|
|
||||||
|
|
||||||
3. **Get the artifact build order**
|
|
||||||
```bash
|
|
||||||
openspec status --change "<name>" --json
|
|
||||||
```
|
|
||||||
Parse the JSON to get:
|
|
||||||
- `applyRequires`: array of artifact IDs needed before implementation (e.g., `["tasks"]`)
|
|
||||||
- `artifacts`: list of all artifacts with their status and dependencies
|
|
||||||
|
|
||||||
4. **Create artifacts in sequence until apply-ready**
|
|
||||||
|
|
||||||
Use the **TodoWrite tool** to track progress through the artifacts.
|
|
||||||
|
|
||||||
Loop through artifacts in dependency order (artifacts with no pending dependencies first):
|
|
||||||
|
|
||||||
a. **For each artifact that is `ready` (dependencies satisfied)**:
|
|
||||||
- Get instructions:
|
|
||||||
```bash
|
|
||||||
openspec instructions <artifact-id> --change "<name>" --json
|
|
||||||
```
|
|
||||||
- The instructions JSON includes:
|
|
||||||
- `context`: Project background (constraints for you - do NOT include in output)
|
|
||||||
- `rules`: Artifact-specific rules (constraints for you - do NOT include in output)
|
|
||||||
- `template`: The structure to use for your output file
|
|
||||||
- `instruction`: Schema-specific guidance for this artifact type
|
|
||||||
- `outputPath`: Where to write the artifact
|
|
||||||
- `dependencies`: Completed artifacts to read for context
|
|
||||||
- Read any completed dependency files for context
|
|
||||||
- Create the artifact file using `template` as the structure
|
|
||||||
- Apply `context` and `rules` as constraints - but do NOT copy them into the file
|
|
||||||
- Show brief progress: "✓ Created <artifact-id>"
|
|
||||||
|
|
||||||
b. **Continue until all `applyRequires` artifacts are complete**
|
|
||||||
- After creating each artifact, re-run `openspec status --change "<name>" --json`
|
|
||||||
- Check if every artifact ID in `applyRequires` has `status: "done"` in the artifacts array
|
|
||||||
- Stop when all `applyRequires` artifacts are done
|
|
||||||
|
|
||||||
c. **If an artifact requires user input** (unclear context):
|
|
||||||
- Use **AskUserQuestion tool** to clarify
|
|
||||||
- Then continue with creation
|
|
||||||
|
|
||||||
5. **Show final status**
|
|
||||||
```bash
|
|
||||||
openspec status --change "<name>"
|
|
||||||
```
|
|
||||||
|
|
||||||
**Output**
|
|
||||||
|
|
||||||
After completing all artifacts, summarize:
|
|
||||||
- Change name and location
|
|
||||||
- List of artifacts created with brief descriptions
|
|
||||||
- What's ready: "All artifacts created! Ready for implementation."
|
|
||||||
- Prompt: "Run `/opsx:apply` or ask me to implement to start working on the tasks."
|
|
||||||
|
|
||||||
**Artifact Creation Guidelines**
|
|
||||||
|
|
||||||
- Follow the `instruction` field from `openspec instructions` for each artifact type
|
|
||||||
- The schema defines what each artifact should contain - follow it
|
|
||||||
- Read dependency artifacts for context before creating new ones
|
|
||||||
- Use `template` as the structure for your output file - fill in its sections
|
|
||||||
- **IMPORTANT**: `context` and `rules` are constraints for YOU, not content for the file
|
|
||||||
- Do NOT copy `<context>`, `<rules>`, `<project_context>` blocks into the artifact
|
|
||||||
- These guide what you write, but should never appear in the output
|
|
||||||
|
|
||||||
**Guardrails**
|
|
||||||
- Create ALL artifacts needed for implementation (as defined by schema's `apply.requires`)
|
|
||||||
- Always read dependency artifacts before creating a new one
|
|
||||||
- If context is critically unclear, ask the user - but prefer making reasonable decisions to keep momentum
|
|
||||||
- If a change with that name already exists, suggest continuing that change instead
|
|
||||||
- Verify each artifact file exists after writing before proceeding to next
|
|
||||||
@@ -1,74 +0,0 @@
|
|||||||
---
|
|
||||||
name: openspec-new-change
|
|
||||||
description: Start a new OpenSpec change using the experimental artifact workflow. Use when the user wants to create a new feature, fix, or modification with a structured step-by-step approach.
|
|
||||||
license: MIT
|
|
||||||
compatibility: Requires openspec CLI.
|
|
||||||
metadata:
|
|
||||||
author: openspec
|
|
||||||
version: "1.0"
|
|
||||||
generatedBy: "1.1.1"
|
|
||||||
---
|
|
||||||
|
|
||||||
Start a new change using the experimental artifact-driven approach.
|
|
||||||
|
|
||||||
**Input**: The user's request should include a change name (kebab-case) OR a description of what they want to build.
|
|
||||||
|
|
||||||
**Steps**
|
|
||||||
|
|
||||||
1. **If no clear input provided, ask what they want to build**
|
|
||||||
|
|
||||||
Use the **AskUserQuestion tool** (open-ended, no preset options) to ask:
|
|
||||||
> "What change do you want to work on? Describe what you want to build or fix."
|
|
||||||
|
|
||||||
From their description, derive a kebab-case name (e.g., "add user authentication" → `add-user-auth`).
|
|
||||||
|
|
||||||
**IMPORTANT**: Do NOT proceed without understanding what the user wants to build.
|
|
||||||
|
|
||||||
2. **Determine the workflow schema**
|
|
||||||
|
|
||||||
Use the default schema (omit `--schema`) unless the user explicitly requests a different workflow.
|
|
||||||
|
|
||||||
**Use a different schema only if the user mentions:**
|
|
||||||
- A specific schema name → use `--schema <name>`
|
|
||||||
- "show workflows" or "what workflows" → run `openspec schemas --json` and let them choose
|
|
||||||
|
|
||||||
**Otherwise**: Omit `--schema` to use the default.
|
|
||||||
|
|
||||||
3. **Create the change directory**
|
|
||||||
```bash
|
|
||||||
openspec new change "<name>"
|
|
||||||
```
|
|
||||||
Add `--schema <name>` only if the user requested a specific workflow.
|
|
||||||
This creates a scaffolded change at `openspec/changes/<name>/` with the selected schema.
|
|
||||||
|
|
||||||
4. **Show the artifact status**
|
|
||||||
```bash
|
|
||||||
openspec status --change "<name>"
|
|
||||||
```
|
|
||||||
This shows which artifacts need to be created and which are ready (dependencies satisfied).
|
|
||||||
|
|
||||||
5. **Get instructions for the first artifact**
|
|
||||||
The first artifact depends on the schema (e.g., `proposal` for spec-driven).
|
|
||||||
Check the status output to find the first artifact with status "ready".
|
|
||||||
```bash
|
|
||||||
openspec instructions <first-artifact-id> --change "<name>"
|
|
||||||
```
|
|
||||||
This outputs the template and context for creating the first artifact.
|
|
||||||
|
|
||||||
6. **STOP and wait for user direction**
|
|
||||||
|
|
||||||
**Output**
|
|
||||||
|
|
||||||
After completing the steps, summarize:
|
|
||||||
- Change name and location
|
|
||||||
- Schema/workflow being used and its artifact sequence
|
|
||||||
- Current status (0/N artifacts complete)
|
|
||||||
- The template for the first artifact
|
|
||||||
- Prompt: "Ready to create the first artifact? Just describe what this change is about and I'll draft it, or ask me to continue."
|
|
||||||
|
|
||||||
**Guardrails**
|
|
||||||
- Do NOT create any artifacts yet - just show the instructions
|
|
||||||
- Do NOT advance beyond showing the first artifact template
|
|
||||||
- If the name is invalid (not kebab-case), ask for a valid name
|
|
||||||
- If a change with that name already exists, suggest continuing that change instead
|
|
||||||
- Pass --schema if using a non-default workflow
|
|
||||||
@@ -1,529 +0,0 @@
|
|||||||
---
|
|
||||||
name: openspec-onboard
|
|
||||||
description: Guided onboarding for OpenSpec - walk through a complete workflow cycle with narration and real codebase work.
|
|
||||||
license: MIT
|
|
||||||
compatibility: Requires openspec CLI.
|
|
||||||
metadata:
|
|
||||||
author: openspec
|
|
||||||
version: "1.0"
|
|
||||||
generatedBy: "1.1.1"
|
|
||||||
---
|
|
||||||
|
|
||||||
Guide the user through their first complete OpenSpec workflow cycle. This is a teaching experience—you'll do real work in their codebase while explaining each step.
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Preflight
|
|
||||||
|
|
||||||
Before starting, check if OpenSpec is initialized:
|
|
||||||
|
|
||||||
```bash
|
|
||||||
openspec status --json 2>&1 || echo "NOT_INITIALIZED"
|
|
||||||
```
|
|
||||||
|
|
||||||
**If not initialized:**
|
|
||||||
> OpenSpec isn't set up in this project yet. Run `openspec init` first, then come back to `/opsx:onboard`.
|
|
||||||
|
|
||||||
Stop here if not initialized.
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Phase 1: Welcome
|
|
||||||
|
|
||||||
Display:
|
|
||||||
|
|
||||||
```
|
|
||||||
## Welcome to OpenSpec!
|
|
||||||
|
|
||||||
I'll walk you through a complete change cycle—from idea to implementation—using a real task in your codebase. Along the way, you'll learn the workflow by doing it.
|
|
||||||
|
|
||||||
**What we'll do:**
|
|
||||||
1. Pick a small, real task in your codebase
|
|
||||||
2. Explore the problem briefly
|
|
||||||
3. Create a change (the container for our work)
|
|
||||||
4. Build the artifacts: proposal → specs → design → tasks
|
|
||||||
5. Implement the tasks
|
|
||||||
6. Archive the completed change
|
|
||||||
|
|
||||||
**Time:** ~15-20 minutes
|
|
||||||
|
|
||||||
Let's start by finding something to work on.
|
|
||||||
```
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Phase 2: Task Selection
|
|
||||||
|
|
||||||
### Codebase Analysis
|
|
||||||
|
|
||||||
Scan the codebase for small improvement opportunities. Look for:
|
|
||||||
|
|
||||||
1. **TODO/FIXME comments** - Search for `TODO`, `FIXME`, `HACK`, `XXX` in code files
|
|
||||||
2. **Missing error handling** - `catch` blocks that swallow errors, risky operations without try-catch
|
|
||||||
3. **Functions without tests** - Cross-reference `src/` with test directories
|
|
||||||
4. **Type issues** - `any` types in TypeScript files (`: any`, `as any`)
|
|
||||||
5. **Debug artifacts** - `console.log`, `console.debug`, `debugger` statements in non-debug code
|
|
||||||
6. **Missing validation** - User input handlers without validation
|
|
||||||
|
|
||||||
Also check recent git activity:
|
|
||||||
```bash
|
|
||||||
git log --oneline -10 2>/dev/null || echo "No git history"
|
|
||||||
```
|
|
||||||
|
|
||||||
### Present Suggestions
|
|
||||||
|
|
||||||
From your analysis, present 3-4 specific suggestions:
|
|
||||||
|
|
||||||
```
|
|
||||||
## Task Suggestions
|
|
||||||
|
|
||||||
Based on scanning your codebase, here are some good starter tasks:
|
|
||||||
|
|
||||||
**1. [Most promising task]**
|
|
||||||
Location: `src/path/to/file.ts:42`
|
|
||||||
Scope: ~1-2 files, ~20-30 lines
|
|
||||||
Why it's good: [brief reason]
|
|
||||||
|
|
||||||
**2. [Second task]**
|
|
||||||
Location: `src/another/file.ts`
|
|
||||||
Scope: ~1 file, ~15 lines
|
|
||||||
Why it's good: [brief reason]
|
|
||||||
|
|
||||||
**3. [Third task]**
|
|
||||||
Location: [location]
|
|
||||||
Scope: [estimate]
|
|
||||||
Why it's good: [brief reason]
|
|
||||||
|
|
||||||
**4. Something else?**
|
|
||||||
Tell me what you'd like to work on.
|
|
||||||
|
|
||||||
Which task interests you? (Pick a number or describe your own)
|
|
||||||
```
|
|
||||||
|
|
||||||
**If nothing found:** Fall back to asking what the user wants to build:
|
|
||||||
> I didn't find obvious quick wins in your codebase. What's something small you've been meaning to add or fix?
|
|
||||||
|
|
||||||
### Scope Guardrail
|
|
||||||
|
|
||||||
If the user picks or describes something too large (major feature, multi-day work):
|
|
||||||
|
|
||||||
```
|
|
||||||
That's a valuable task, but it's probably larger than ideal for your first OpenSpec run-through.
|
|
||||||
|
|
||||||
For learning the workflow, smaller is better—it lets you see the full cycle without getting stuck in implementation details.
|
|
||||||
|
|
||||||
**Options:**
|
|
||||||
1. **Slice it smaller** - What's the smallest useful piece of [their task]? Maybe just [specific slice]?
|
|
||||||
2. **Pick something else** - One of the other suggestions, or a different small task?
|
|
||||||
3. **Do it anyway** - If you really want to tackle this, we can. Just know it'll take longer.
|
|
||||||
|
|
||||||
What would you prefer?
|
|
||||||
```
|
|
||||||
|
|
||||||
Let the user override if they insist—this is a soft guardrail.
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Phase 3: Explore Demo
|
|
||||||
|
|
||||||
Once a task is selected, briefly demonstrate explore mode:
|
|
||||||
|
|
||||||
```
|
|
||||||
Before we create a change, let me quickly show you **explore mode**—it's how you think through problems before committing to a direction.
|
|
||||||
```
|
|
||||||
|
|
||||||
Spend 1-2 minutes investigating the relevant code:
|
|
||||||
- Read the file(s) involved
|
|
||||||
- Draw a quick ASCII diagram if it helps
|
|
||||||
- Note any considerations
|
|
||||||
|
|
||||||
```
|
|
||||||
## Quick Exploration
|
|
||||||
|
|
||||||
[Your brief analysis—what you found, any considerations]
|
|
||||||
|
|
||||||
┌─────────────────────────────────────────┐
|
|
||||||
│ [Optional: ASCII diagram if helpful] │
|
|
||||||
└─────────────────────────────────────────┘
|
|
||||||
|
|
||||||
Explore mode (`/opsx:explore`) is for this kind of thinking—investigating before implementing. You can use it anytime you need to think through a problem.
|
|
||||||
|
|
||||||
Now let's create a change to hold our work.
|
|
||||||
```
|
|
||||||
|
|
||||||
**PAUSE** - Wait for user acknowledgment before proceeding.
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Phase 4: Create the Change
|
|
||||||
|
|
||||||
**EXPLAIN:**
|
|
||||||
```
|
|
||||||
## Creating a Change
|
|
||||||
|
|
||||||
A "change" in OpenSpec is a container for all the thinking and planning around a piece of work. It lives in `openspec/changes/<name>/` and holds your artifacts—proposal, specs, design, tasks.
|
|
||||||
|
|
||||||
Let me create one for our task.
|
|
||||||
```
|
|
||||||
|
|
||||||
**DO:** Create the change with a derived kebab-case name:
|
|
||||||
```bash
|
|
||||||
openspec new change "<derived-name>"
|
|
||||||
```
|
|
||||||
|
|
||||||
**SHOW:**
|
|
||||||
```
|
|
||||||
Created: `openspec/changes/<name>/`
|
|
||||||
|
|
||||||
The folder structure:
|
|
||||||
```
|
|
||||||
openspec/changes/<name>/
|
|
||||||
├── proposal.md ← Why we're doing this (empty, we'll fill it)
|
|
||||||
├── design.md ← How we'll build it (empty)
|
|
||||||
├── specs/ ← Detailed requirements (empty)
|
|
||||||
└── tasks.md ← Implementation checklist (empty)
|
|
||||||
```
|
|
||||||
|
|
||||||
Now let's fill in the first artifact—the proposal.
|
|
||||||
```
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Phase 5: Proposal
|
|
||||||
|
|
||||||
**EXPLAIN:**
|
|
||||||
```
|
|
||||||
## The Proposal
|
|
||||||
|
|
||||||
The proposal captures **why** we're making this change and **what** it involves at a high level. It's the "elevator pitch" for the work.
|
|
||||||
|
|
||||||
I'll draft one based on our task.
|
|
||||||
```
|
|
||||||
|
|
||||||
**DO:** Draft the proposal content (don't save yet):
|
|
||||||
|
|
||||||
```
|
|
||||||
Here's a draft proposal:
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Why
|
|
||||||
|
|
||||||
[1-2 sentences explaining the problem/opportunity]
|
|
||||||
|
|
||||||
## What Changes
|
|
||||||
|
|
||||||
[Bullet points of what will be different]
|
|
||||||
|
|
||||||
## Capabilities
|
|
||||||
|
|
||||||
### New Capabilities
|
|
||||||
- `<capability-name>`: [brief description]
|
|
||||||
|
|
||||||
### Modified Capabilities
|
|
||||||
<!-- If modifying existing behavior -->
|
|
||||||
|
|
||||||
## Impact
|
|
||||||
|
|
||||||
- `src/path/to/file.ts`: [what changes]
|
|
||||||
- [other files if applicable]
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
Does this capture the intent? I can adjust before we save it.
|
|
||||||
```
|
|
||||||
|
|
||||||
**PAUSE** - Wait for user approval/feedback.
|
|
||||||
|
|
||||||
After approval, save the proposal:
|
|
||||||
```bash
|
|
||||||
openspec instructions proposal --change "<name>" --json
|
|
||||||
```
|
|
||||||
Then write the content to `openspec/changes/<name>/proposal.md`.
|
|
||||||
|
|
||||||
```
|
|
||||||
Proposal saved. This is your "why" document—you can always come back and refine it as understanding evolves.
|
|
||||||
|
|
||||||
Next up: specs.
|
|
||||||
```
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Phase 6: Specs
|
|
||||||
|
|
||||||
**EXPLAIN:**
|
|
||||||
```
|
|
||||||
## Specs
|
|
||||||
|
|
||||||
Specs define **what** we're building in precise, testable terms. They use a requirement/scenario format that makes expected behavior crystal clear.
|
|
||||||
|
|
||||||
For a small task like this, we might only need one spec file.
|
|
||||||
```
|
|
||||||
|
|
||||||
**DO:** Create the spec file:
|
|
||||||
```bash
|
|
||||||
mkdir -p openspec/changes/<name>/specs/<capability-name>
|
|
||||||
```
|
|
||||||
|
|
||||||
Draft the spec content:
|
|
||||||
|
|
||||||
```
|
|
||||||
Here's the spec:
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## ADDED Requirements
|
|
||||||
|
|
||||||
### Requirement: <Name>
|
|
||||||
|
|
||||||
<Description of what the system should do>
|
|
||||||
|
|
||||||
#### Scenario: <Scenario name>
|
|
||||||
|
|
||||||
- **WHEN** <trigger condition>
|
|
||||||
- **THEN** <expected outcome>
|
|
||||||
- **AND** <additional outcome if needed>
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
This format—WHEN/THEN/AND—makes requirements testable. You can literally read them as test cases.
|
|
||||||
```
|
|
||||||
|
|
||||||
Save to `openspec/changes/<name>/specs/<capability>/spec.md`.
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Phase 7: Design
|
|
||||||
|
|
||||||
**EXPLAIN:**
|
|
||||||
```
|
|
||||||
## Design
|
|
||||||
|
|
||||||
The design captures **how** we'll build it—technical decisions, tradeoffs, approach.
|
|
||||||
|
|
||||||
For small changes, this might be brief. That's fine—not every change needs deep design discussion.
|
|
||||||
```
|
|
||||||
|
|
||||||
**DO:** Draft design.md:
|
|
||||||
|
|
||||||
```
|
|
||||||
Here's the design:
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Context
|
|
||||||
|
|
||||||
[Brief context about the current state]
|
|
||||||
|
|
||||||
## Goals / Non-Goals
|
|
||||||
|
|
||||||
**Goals:**
|
|
||||||
- [What we're trying to achieve]
|
|
||||||
|
|
||||||
**Non-Goals:**
|
|
||||||
- [What's explicitly out of scope]
|
|
||||||
|
|
||||||
## Decisions
|
|
||||||
|
|
||||||
### Decision 1: [Key decision]
|
|
||||||
|
|
||||||
[Explanation of approach and rationale]
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
For a small task, this captures the key decisions without over-engineering.
|
|
||||||
```
|
|
||||||
|
|
||||||
Save to `openspec/changes/<name>/design.md`.
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Phase 8: Tasks
|
|
||||||
|
|
||||||
**EXPLAIN:**
|
|
||||||
```
|
|
||||||
## Tasks
|
|
||||||
|
|
||||||
Finally, we break the work into implementation tasks—checkboxes that drive the apply phase.
|
|
||||||
|
|
||||||
These should be small, clear, and in logical order.
|
|
||||||
```
|
|
||||||
|
|
||||||
**DO:** Generate tasks based on specs and design:
|
|
||||||
|
|
||||||
```
|
|
||||||
Here are the implementation tasks:
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## 1. [Category or file]
|
|
||||||
|
|
||||||
- [ ] 1.1 [Specific task]
|
|
||||||
- [ ] 1.2 [Specific task]
|
|
||||||
|
|
||||||
## 2. Verify
|
|
||||||
|
|
||||||
- [ ] 2.1 [Verification step]
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
Each checkbox becomes a unit of work in the apply phase. Ready to implement?
|
|
||||||
```
|
|
||||||
|
|
||||||
**PAUSE** - Wait for user to confirm they're ready to implement.
|
|
||||||
|
|
||||||
Save to `openspec/changes/<name>/tasks.md`.
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Phase 9: Apply (Implementation)
|
|
||||||
|
|
||||||
**EXPLAIN:**
|
|
||||||
```
|
|
||||||
## Implementation
|
|
||||||
|
|
||||||
Now we implement each task, checking them off as we go. I'll announce each one and occasionally note how the specs/design informed the approach.
|
|
||||||
```
|
|
||||||
|
|
||||||
**DO:** For each task:
|
|
||||||
|
|
||||||
1. Announce: "Working on task N: [description]"
|
|
||||||
2. Implement the change in the codebase
|
|
||||||
3. Reference specs/design naturally: "The spec says X, so I'm doing Y"
|
|
||||||
4. Mark complete in tasks.md: `- [ ]` → `- [x]`
|
|
||||||
5. Brief status: "✓ Task N complete"
|
|
||||||
|
|
||||||
Keep narration light—don't over-explain every line of code.
|
|
||||||
|
|
||||||
After all tasks:
|
|
||||||
|
|
||||||
```
|
|
||||||
## Implementation Complete
|
|
||||||
|
|
||||||
All tasks done:
|
|
||||||
- [x] Task 1
|
|
||||||
- [x] Task 2
|
|
||||||
- [x] ...
|
|
||||||
|
|
||||||
The change is implemented! One more step—let's archive it.
|
|
||||||
```
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Phase 10: Archive
|
|
||||||
|
|
||||||
**EXPLAIN:**
|
|
||||||
```
|
|
||||||
## Archiving
|
|
||||||
|
|
||||||
When a change is complete, we archive it. This moves it from `openspec/changes/` to `openspec/changes/archive/YYYY-MM-DD-<name>/`.
|
|
||||||
|
|
||||||
Archived changes become your project's decision history—you can always find them later to understand why something was built a certain way.
|
|
||||||
```
|
|
||||||
|
|
||||||
**DO:**
|
|
||||||
```bash
|
|
||||||
openspec archive "<name>"
|
|
||||||
```
|
|
||||||
|
|
||||||
**SHOW:**
|
|
||||||
```
|
|
||||||
Archived to: `openspec/changes/archive/YYYY-MM-DD-<name>/`
|
|
||||||
|
|
||||||
The change is now part of your project's history. The code is in your codebase, the decision record is preserved.
|
|
||||||
```
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Phase 11: Recap & Next Steps
|
|
||||||
|
|
||||||
```
|
|
||||||
## Congratulations!
|
|
||||||
|
|
||||||
You just completed a full OpenSpec cycle:
|
|
||||||
|
|
||||||
1. **Explore** - Thought through the problem
|
|
||||||
2. **New** - Created a change container
|
|
||||||
3. **Proposal** - Captured WHY
|
|
||||||
4. **Specs** - Defined WHAT in detail
|
|
||||||
5. **Design** - Decided HOW
|
|
||||||
6. **Tasks** - Broke it into steps
|
|
||||||
7. **Apply** - Implemented the work
|
|
||||||
8. **Archive** - Preserved the record
|
|
||||||
|
|
||||||
This same rhythm works for any size change—a small fix or a major feature.
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Command Reference
|
|
||||||
|
|
||||||
| Command | What it does |
|
|
||||||
|---------|--------------|
|
|
||||||
| `/opsx:explore` | Think through problems before/during work |
|
|
||||||
| `/opsx:new` | Start a new change, step through artifacts |
|
|
||||||
| `/opsx:ff` | Fast-forward: create all artifacts at once |
|
|
||||||
| `/opsx:continue` | Continue working on an existing change |
|
|
||||||
| `/opsx:apply` | Implement tasks from a change |
|
|
||||||
| `/opsx:verify` | Verify implementation matches artifacts |
|
|
||||||
| `/opsx:archive` | Archive a completed change |
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## What's Next?
|
|
||||||
|
|
||||||
Try `/opsx:new` or `/opsx:ff` on something you actually want to build. You've got the rhythm now!
|
|
||||||
```
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Graceful Exit Handling
|
|
||||||
|
|
||||||
### User wants to stop mid-way
|
|
||||||
|
|
||||||
If the user says they need to stop, want to pause, or seem disengaged:
|
|
||||||
|
|
||||||
```
|
|
||||||
No problem! Your change is saved at `openspec/changes/<name>/`.
|
|
||||||
|
|
||||||
To pick up where we left off later:
|
|
||||||
- `/opsx:continue <name>` - Resume artifact creation
|
|
||||||
- `/opsx:apply <name>` - Jump to implementation (if tasks exist)
|
|
||||||
|
|
||||||
The work won't be lost. Come back whenever you're ready.
|
|
||||||
```
|
|
||||||
|
|
||||||
Exit gracefully without pressure.
|
|
||||||
|
|
||||||
### User just wants command reference
|
|
||||||
|
|
||||||
If the user says they just want to see the commands or skip the tutorial:
|
|
||||||
|
|
||||||
```
|
|
||||||
## OpenSpec Quick Reference
|
|
||||||
|
|
||||||
| Command | What it does |
|
|
||||||
|---------|--------------|
|
|
||||||
| `/opsx:explore` | Think through problems (no code changes) |
|
|
||||||
| `/opsx:new <name>` | Start a new change, step by step |
|
|
||||||
| `/opsx:ff <name>` | Fast-forward: all artifacts at once |
|
|
||||||
| `/opsx:continue <name>` | Continue an existing change |
|
|
||||||
| `/opsx:apply <name>` | Implement tasks |
|
|
||||||
| `/opsx:verify <name>` | Verify implementation |
|
|
||||||
| `/opsx:archive <name>` | Archive when done |
|
|
||||||
|
|
||||||
Try `/opsx:new` to start your first change, or `/opsx:ff` if you want to move fast.
|
|
||||||
```
|
|
||||||
|
|
||||||
Exit gracefully.
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Guardrails
|
|
||||||
|
|
||||||
- **Follow the EXPLAIN → DO → SHOW → PAUSE pattern** at key transitions (after explore, after proposal draft, after tasks, after archive)
|
|
||||||
- **Keep narration light** during implementation—teach without lecturing
|
|
||||||
- **Don't skip phases** even if the change is small—the goal is teaching the workflow
|
|
||||||
- **Pause for acknowledgment** at marked points, but don't over-pause
|
|
||||||
- **Handle exits gracefully**—never pressure the user to continue
|
|
||||||
- **Use real codebase tasks**—don't simulate or use fake examples
|
|
||||||
- **Adjust scope gently**—guide toward smaller tasks but respect user choice
|
|
||||||
@@ -1,138 +0,0 @@
|
|||||||
---
|
|
||||||
name: openspec-sync-specs
|
|
||||||
description: Sync delta specs from a change to main specs. Use when the user wants to update main specs with changes from a delta spec, without archiving the change.
|
|
||||||
license: MIT
|
|
||||||
compatibility: Requires openspec CLI.
|
|
||||||
metadata:
|
|
||||||
author: openspec
|
|
||||||
version: "1.0"
|
|
||||||
generatedBy: "1.1.1"
|
|
||||||
---
|
|
||||||
|
|
||||||
Sync delta specs from a change to main specs.
|
|
||||||
|
|
||||||
This is an **agent-driven** operation - you will read delta specs and directly edit main specs to apply the changes. This allows intelligent merging (e.g., adding a scenario without copying the entire requirement).
|
|
||||||
|
|
||||||
**Input**: Optionally specify a change name. If omitted, check if it can be inferred from conversation context. If vague or ambiguous you MUST prompt for available changes.
|
|
||||||
|
|
||||||
**Steps**
|
|
||||||
|
|
||||||
1. **If no change name provided, prompt for selection**
|
|
||||||
|
|
||||||
Run `openspec list --json` to get available changes. Use the **AskUserQuestion tool** to let the user select.
|
|
||||||
|
|
||||||
Show changes that have delta specs (under `specs/` directory).
|
|
||||||
|
|
||||||
**IMPORTANT**: Do NOT guess or auto-select a change. Always let the user choose.
|
|
||||||
|
|
||||||
2. **Find delta specs**
|
|
||||||
|
|
||||||
Look for delta spec files in `openspec/changes/<name>/specs/*/spec.md`.
|
|
||||||
|
|
||||||
Each delta spec file contains sections like:
|
|
||||||
- `## ADDED Requirements` - New requirements to add
|
|
||||||
- `## MODIFIED Requirements` - Changes to existing requirements
|
|
||||||
- `## REMOVED Requirements` - Requirements to remove
|
|
||||||
- `## RENAMED Requirements` - Requirements to rename (FROM:/TO: format)
|
|
||||||
|
|
||||||
If no delta specs found, inform user and stop.
|
|
||||||
|
|
||||||
3. **For each delta spec, apply changes to main specs**
|
|
||||||
|
|
||||||
For each capability with a delta spec at `openspec/changes/<name>/specs/<capability>/spec.md`:
|
|
||||||
|
|
||||||
a. **Read the delta spec** to understand the intended changes
|
|
||||||
|
|
||||||
b. **Read the main spec** at `openspec/specs/<capability>/spec.md` (may not exist yet)
|
|
||||||
|
|
||||||
c. **Apply changes intelligently**:
|
|
||||||
|
|
||||||
**ADDED Requirements:**
|
|
||||||
- If requirement doesn't exist in main spec → add it
|
|
||||||
- If requirement already exists → update it to match (treat as implicit MODIFIED)
|
|
||||||
|
|
||||||
**MODIFIED Requirements:**
|
|
||||||
- Find the requirement in main spec
|
|
||||||
- Apply the changes - this can be:
|
|
||||||
- Adding new scenarios (don't need to copy existing ones)
|
|
||||||
- Modifying existing scenarios
|
|
||||||
- Changing the requirement description
|
|
||||||
- Preserve scenarios/content not mentioned in the delta
|
|
||||||
|
|
||||||
**REMOVED Requirements:**
|
|
||||||
- Remove the entire requirement block from main spec
|
|
||||||
|
|
||||||
**RENAMED Requirements:**
|
|
||||||
- Find the FROM requirement, rename to TO
|
|
||||||
|
|
||||||
d. **Create new main spec** if capability doesn't exist yet:
|
|
||||||
- Create `openspec/specs/<capability>/spec.md`
|
|
||||||
- Add Purpose section (can be brief, mark as TBD)
|
|
||||||
- Add Requirements section with the ADDED requirements
|
|
||||||
|
|
||||||
4. **Show summary**
|
|
||||||
|
|
||||||
After applying all changes, summarize:
|
|
||||||
- Which capabilities were updated
|
|
||||||
- What changes were made (requirements added/modified/removed/renamed)
|
|
||||||
|
|
||||||
**Delta Spec Format Reference**
|
|
||||||
|
|
||||||
```markdown
|
|
||||||
## ADDED Requirements
|
|
||||||
|
|
||||||
### Requirement: New Feature
|
|
||||||
The system SHALL do something new.
|
|
||||||
|
|
||||||
#### Scenario: Basic case
|
|
||||||
- **WHEN** user does X
|
|
||||||
- **THEN** system does Y
|
|
||||||
|
|
||||||
## MODIFIED Requirements
|
|
||||||
|
|
||||||
### Requirement: Existing Feature
|
|
||||||
#### Scenario: New scenario to add
|
|
||||||
- **WHEN** user does A
|
|
||||||
- **THEN** system does B
|
|
||||||
|
|
||||||
## REMOVED Requirements
|
|
||||||
|
|
||||||
### Requirement: Deprecated Feature
|
|
||||||
|
|
||||||
## RENAMED Requirements
|
|
||||||
|
|
||||||
- FROM: `### Requirement: Old Name`
|
|
||||||
- TO: `### Requirement: New Name`
|
|
||||||
```
|
|
||||||
|
|
||||||
**Key Principle: Intelligent Merging**
|
|
||||||
|
|
||||||
Unlike programmatic merging, you can apply **partial updates**:
|
|
||||||
- To add a scenario, just include that scenario under MODIFIED - don't copy existing scenarios
|
|
||||||
- The delta represents *intent*, not a wholesale replacement
|
|
||||||
- Use your judgment to merge changes sensibly
|
|
||||||
|
|
||||||
**Output On Success**
|
|
||||||
|
|
||||||
```
|
|
||||||
## Specs Synced: <change-name>
|
|
||||||
|
|
||||||
Updated main specs:
|
|
||||||
|
|
||||||
**<capability-1>**:
|
|
||||||
- Added requirement: "New Feature"
|
|
||||||
- Modified requirement: "Existing Feature" (added 1 scenario)
|
|
||||||
|
|
||||||
**<capability-2>**:
|
|
||||||
- Created new spec file
|
|
||||||
- Added requirement: "Another Feature"
|
|
||||||
|
|
||||||
Main specs are now updated. The change remains active - archive when implementation is complete.
|
|
||||||
```
|
|
||||||
|
|
||||||
**Guardrails**
|
|
||||||
- Read both delta and main specs before making changes
|
|
||||||
- Preserve existing content not mentioned in delta
|
|
||||||
- If something is unclear, ask for clarification
|
|
||||||
- Show what you're changing as you go
|
|
||||||
- The operation should be idempotent - running twice should give same result
|
|
||||||
@@ -1,168 +0,0 @@
|
|||||||
---
|
|
||||||
name: openspec-verify-change
|
|
||||||
description: Verify implementation matches change artifacts. Use when the user wants to validate that implementation is complete, correct, and coherent before archiving.
|
|
||||||
license: MIT
|
|
||||||
compatibility: Requires openspec CLI.
|
|
||||||
metadata:
|
|
||||||
author: openspec
|
|
||||||
version: "1.0"
|
|
||||||
generatedBy: "1.1.1"
|
|
||||||
---
|
|
||||||
|
|
||||||
Verify that an implementation matches the change artifacts (specs, tasks, design).
|
|
||||||
|
|
||||||
**Input**: Optionally specify a change name. If omitted, check if it can be inferred from conversation context. If vague or ambiguous you MUST prompt for available changes.
|
|
||||||
|
|
||||||
**Steps**
|
|
||||||
|
|
||||||
1. **If no change name provided, prompt for selection**
|
|
||||||
|
|
||||||
Run `openspec list --json` to get available changes. Use the **AskUserQuestion tool** to let the user select.
|
|
||||||
|
|
||||||
Show changes that have implementation tasks (tasks artifact exists).
|
|
||||||
Include the schema used for each change if available.
|
|
||||||
Mark changes with incomplete tasks as "(In Progress)".
|
|
||||||
|
|
||||||
**IMPORTANT**: Do NOT guess or auto-select a change. Always let the user choose.
|
|
||||||
|
|
||||||
2. **Check status to understand the schema**
|
|
||||||
```bash
|
|
||||||
openspec status --change "<name>" --json
|
|
||||||
```
|
|
||||||
Parse the JSON to understand:
|
|
||||||
- `schemaName`: The workflow being used (e.g., "spec-driven")
|
|
||||||
- Which artifacts exist for this change
|
|
||||||
|
|
||||||
3. **Get the change directory and load artifacts**
|
|
||||||
|
|
||||||
```bash
|
|
||||||
openspec instructions apply --change "<name>" --json
|
|
||||||
```
|
|
||||||
|
|
||||||
This returns the change directory and context files. Read all available artifacts from `contextFiles`.
|
|
||||||
|
|
||||||
4. **Initialize verification report structure**
|
|
||||||
|
|
||||||
Create a report structure with three dimensions:
|
|
||||||
- **Completeness**: Track tasks and spec coverage
|
|
||||||
- **Correctness**: Track requirement implementation and scenario coverage
|
|
||||||
- **Coherence**: Track design adherence and pattern consistency
|
|
||||||
|
|
||||||
Each dimension can have CRITICAL, WARNING, or SUGGESTION issues.
|
|
||||||
|
|
||||||
5. **Verify Completeness**
|
|
||||||
|
|
||||||
**Task Completion**:
|
|
||||||
- If tasks.md exists in contextFiles, read it
|
|
||||||
- Parse checkboxes: `- [ ]` (incomplete) vs `- [x]` (complete)
|
|
||||||
- Count complete vs total tasks
|
|
||||||
- If incomplete tasks exist:
|
|
||||||
- Add CRITICAL issue for each incomplete task
|
|
||||||
- Recommendation: "Complete task: <description>" or "Mark as done if already implemented"
|
|
||||||
|
|
||||||
**Spec Coverage**:
|
|
||||||
- If delta specs exist in `openspec/changes/<name>/specs/`:
|
|
||||||
- Extract all requirements (marked with "### Requirement:")
|
|
||||||
- For each requirement:
|
|
||||||
- Search codebase for keywords related to the requirement
|
|
||||||
- Assess if implementation likely exists
|
|
||||||
- If requirements appear unimplemented:
|
|
||||||
- Add CRITICAL issue: "Requirement not found: <requirement name>"
|
|
||||||
- Recommendation: "Implement requirement X: <description>"
|
|
||||||
|
|
||||||
6. **Verify Correctness**
|
|
||||||
|
|
||||||
**Requirement Implementation Mapping**:
|
|
||||||
- For each requirement from delta specs:
|
|
||||||
- Search codebase for implementation evidence
|
|
||||||
- If found, note file paths and line ranges
|
|
||||||
- Assess if implementation matches requirement intent
|
|
||||||
- If divergence detected:
|
|
||||||
- Add WARNING: "Implementation may diverge from spec: <details>"
|
|
||||||
- Recommendation: "Review <file>:<lines> against requirement X"
|
|
||||||
|
|
||||||
**Scenario Coverage**:
|
|
||||||
- For each scenario in delta specs (marked with "#### Scenario:"):
|
|
||||||
- Check if conditions are handled in code
|
|
||||||
- Check if tests exist covering the scenario
|
|
||||||
- If scenario appears uncovered:
|
|
||||||
- Add WARNING: "Scenario not covered: <scenario name>"
|
|
||||||
- Recommendation: "Add test or implementation for scenario: <description>"
|
|
||||||
|
|
||||||
7. **Verify Coherence**
|
|
||||||
|
|
||||||
**Design Adherence**:
|
|
||||||
- If design.md exists in contextFiles:
|
|
||||||
- Extract key decisions (look for sections like "Decision:", "Approach:", "Architecture:")
|
|
||||||
- Verify implementation follows those decisions
|
|
||||||
- If contradiction detected:
|
|
||||||
- Add WARNING: "Design decision not followed: <decision>"
|
|
||||||
- Recommendation: "Update implementation or revise design.md to match reality"
|
|
||||||
- If no design.md: Skip design adherence check, note "No design.md to verify against"
|
|
||||||
|
|
||||||
**Code Pattern Consistency**:
|
|
||||||
- Review new code for consistency with project patterns
|
|
||||||
- Check file naming, directory structure, coding style
|
|
||||||
- If significant deviations found:
|
|
||||||
- Add SUGGESTION: "Code pattern deviation: <details>"
|
|
||||||
- Recommendation: "Consider following project pattern: <example>"
|
|
||||||
|
|
||||||
8. **Generate Verification Report**
|
|
||||||
|
|
||||||
**Summary Scorecard**:
|
|
||||||
```
|
|
||||||
## Verification Report: <change-name>
|
|
||||||
|
|
||||||
### Summary
|
|
||||||
| Dimension | Status |
|
|
||||||
|--------------|------------------|
|
|
||||||
| Completeness | X/Y tasks, N reqs|
|
|
||||||
| Correctness | M/N reqs covered |
|
|
||||||
| Coherence | Followed/Issues |
|
|
||||||
```
|
|
||||||
|
|
||||||
**Issues by Priority**:
|
|
||||||
|
|
||||||
1. **CRITICAL** (Must fix before archive):
|
|
||||||
- Incomplete tasks
|
|
||||||
- Missing requirement implementations
|
|
||||||
- Each with specific, actionable recommendation
|
|
||||||
|
|
||||||
2. **WARNING** (Should fix):
|
|
||||||
- Spec/design divergences
|
|
||||||
- Missing scenario coverage
|
|
||||||
- Each with specific recommendation
|
|
||||||
|
|
||||||
3. **SUGGESTION** (Nice to fix):
|
|
||||||
- Pattern inconsistencies
|
|
||||||
- Minor improvements
|
|
||||||
- Each with specific recommendation
|
|
||||||
|
|
||||||
**Final Assessment**:
|
|
||||||
- If CRITICAL issues: "X critical issue(s) found. Fix before archiving."
|
|
||||||
- If only warnings: "No critical issues. Y warning(s) to consider. Ready for archive (with noted improvements)."
|
|
||||||
- If all clear: "All checks passed. Ready for archive."
|
|
||||||
|
|
||||||
**Verification Heuristics**
|
|
||||||
|
|
||||||
- **Completeness**: Focus on objective checklist items (checkboxes, requirements list)
|
|
||||||
- **Correctness**: Use keyword search, file path analysis, reasonable inference - don't require perfect certainty
|
|
||||||
- **Coherence**: Look for glaring inconsistencies, don't nitpick style
|
|
||||||
- **False Positives**: When uncertain, prefer SUGGESTION over WARNING, WARNING over CRITICAL
|
|
||||||
- **Actionability**: Every issue must have a specific recommendation with file/line references where applicable
|
|
||||||
|
|
||||||
**Graceful Degradation**
|
|
||||||
|
|
||||||
- If only tasks.md exists: verify task completion only, skip spec/design checks
|
|
||||||
- If tasks + specs exist: verify completeness and correctness, skip design
|
|
||||||
- If full artifacts: verify all three dimensions
|
|
||||||
- Always note which checks were skipped and why
|
|
||||||
|
|
||||||
**Output Format**
|
|
||||||
|
|
||||||
Use clear markdown with:
|
|
||||||
- Table for summary scorecard
|
|
||||||
- Grouped lists for issues (CRITICAL/WARNING/SUGGESTION)
|
|
||||||
- Code references in format: `file.ts:123`
|
|
||||||
- Specific, actionable recommendations
|
|
||||||
- No vague suggestions like "consider reviewing"
|
|
||||||
@@ -1,145 +0,0 @@
|
|||||||
Implement tasks from an OpenSpec change.
|
|
||||||
|
|
||||||
**Input**: Optionally specify a change name (e.g., `/opsx:apply add-auth`). If omitted, check if it can be inferred from conversation context. If vague or ambiguous you MUST prompt for available changes.
|
|
||||||
|
|
||||||
**Steps**
|
|
||||||
|
|
||||||
1. **Select the change**
|
|
||||||
|
|
||||||
If a name is provided, use it. Otherwise:
|
|
||||||
- Infer from conversation context if the user mentioned a change
|
|
||||||
- Auto-select if only one active change exists
|
|
||||||
- If ambiguous, run `openspec list --json` to get available changes and use the **AskUserQuestion tool** to let the user select
|
|
||||||
|
|
||||||
Always announce: "Using change: <name>" and how to override (e.g., `/opsx:apply <other>`).
|
|
||||||
|
|
||||||
2. **Check status to understand the schema**
|
|
||||||
```bash
|
|
||||||
openspec status --change "<name>" --json
|
|
||||||
```
|
|
||||||
Parse the JSON to understand:
|
|
||||||
- `schemaName`: The workflow being used (e.g., "spec-driven")
|
|
||||||
- Which artifact contains the tasks (typically "tasks" for spec-driven, check status for others)
|
|
||||||
|
|
||||||
3. **Get apply instructions**
|
|
||||||
|
|
||||||
```bash
|
|
||||||
openspec instructions apply --change "<name>" --json
|
|
||||||
```
|
|
||||||
|
|
||||||
This returns:
|
|
||||||
- Context file paths (varies by schema)
|
|
||||||
- Progress (total, complete, remaining)
|
|
||||||
- Task list with status
|
|
||||||
- Dynamic instruction based on current state
|
|
||||||
|
|
||||||
**Handle states:**
|
|
||||||
- If `state: "blocked"` (missing artifacts): show message, suggest using `/opsx:continue`
|
|
||||||
- If `state: "all_done"`: congratulate, suggest archive
|
|
||||||
- Otherwise: proceed to implementation
|
|
||||||
|
|
||||||
4. **Read context files**
|
|
||||||
|
|
||||||
Read the files listed in `contextFiles` from the apply instructions output.
|
|
||||||
The files depend on the schema being used:
|
|
||||||
- **spec-driven**: proposal, specs, design, tasks
|
|
||||||
- Other schemas: follow the contextFiles from CLI output
|
|
||||||
|
|
||||||
5. **Show current progress**
|
|
||||||
|
|
||||||
Display:
|
|
||||||
- Schema being used
|
|
||||||
- Progress: "N/M tasks complete"
|
|
||||||
- Remaining tasks overview
|
|
||||||
- Dynamic instruction from CLI
|
|
||||||
|
|
||||||
6. **Implement tasks (loop until done or blocked)**
|
|
||||||
|
|
||||||
For each pending task:
|
|
||||||
- Show which task is being worked on
|
|
||||||
- Make the code changes required
|
|
||||||
- Keep changes minimal and focused
|
|
||||||
- Mark task complete in the tasks file: `- [ ]` → `- [x]`
|
|
||||||
- Continue to next task
|
|
||||||
|
|
||||||
**Pause if:**
|
|
||||||
- Task is unclear → ask for clarification
|
|
||||||
- Implementation reveals a design issue → suggest updating artifacts
|
|
||||||
- Error or blocker encountered → report and wait for guidance
|
|
||||||
- User interrupts
|
|
||||||
|
|
||||||
7. **On completion or pause, show status**
|
|
||||||
|
|
||||||
Display:
|
|
||||||
- Tasks completed this session
|
|
||||||
- Overall progress: "N/M tasks complete"
|
|
||||||
- If all done: suggest archive
|
|
||||||
- If paused: explain why and wait for guidance
|
|
||||||
|
|
||||||
**Output During Implementation**
|
|
||||||
|
|
||||||
```
|
|
||||||
## Implementing: <change-name> (schema: <schema-name>)
|
|
||||||
|
|
||||||
Working on task 3/7: <task description>
|
|
||||||
[...implementation happening...]
|
|
||||||
✓ Task complete
|
|
||||||
|
|
||||||
Working on task 4/7: <task description>
|
|
||||||
[...implementation happening...]
|
|
||||||
✓ Task complete
|
|
||||||
```
|
|
||||||
|
|
||||||
**Output On Completion**
|
|
||||||
|
|
||||||
```
|
|
||||||
## Implementation Complete
|
|
||||||
|
|
||||||
**Change:** <change-name>
|
|
||||||
**Schema:** <schema-name>
|
|
||||||
**Progress:** 7/7 tasks complete ✓
|
|
||||||
|
|
||||||
### Completed This Session
|
|
||||||
- [x] Task 1
|
|
||||||
- [x] Task 2
|
|
||||||
...
|
|
||||||
|
|
||||||
All tasks complete! You can archive this change with `/opsx:archive`.
|
|
||||||
```
|
|
||||||
|
|
||||||
**Output On Pause (Issue Encountered)**
|
|
||||||
|
|
||||||
```
|
|
||||||
## Implementation Paused
|
|
||||||
|
|
||||||
**Change:** <change-name>
|
|
||||||
**Schema:** <schema-name>
|
|
||||||
**Progress:** 4/7 tasks complete
|
|
||||||
|
|
||||||
### Issue Encountered
|
|
||||||
<description of the issue>
|
|
||||||
|
|
||||||
**Options:**
|
|
||||||
1. <option 1>
|
|
||||||
2. <option 2>
|
|
||||||
3. Other approach
|
|
||||||
|
|
||||||
What would you like to do?
|
|
||||||
```
|
|
||||||
|
|
||||||
**Guardrails**
|
|
||||||
- Keep going through tasks until done or blocked
|
|
||||||
- Always read context files before starting (from the apply instructions output)
|
|
||||||
- If task is ambiguous, pause and ask before implementing
|
|
||||||
- If implementation reveals issues, pause and suggest artifact updates
|
|
||||||
- Keep code changes minimal and scoped to each task
|
|
||||||
- Update task checkbox immediately after completing each task
|
|
||||||
- Pause on errors, blockers, or unclear requirements - don't guess
|
|
||||||
- Use contextFiles from CLI output, don't assume specific file names
|
|
||||||
|
|
||||||
**Fluid Workflow Integration**
|
|
||||||
|
|
||||||
This skill supports the "actions on a change" model:
|
|
||||||
|
|
||||||
- **Can be invoked anytime**: Before all artifacts are done (if tasks exist), after partial implementation, interleaved with other actions
|
|
||||||
- **Allows artifact updates**: If implementation reveals design issues, suggest updating artifacts - not phase-locked, work fluidly
|
|
||||||
@@ -1,150 +0,0 @@
|
|||||||
Archive a completed change in the experimental workflow.
|
|
||||||
|
|
||||||
**Input**: Optionally specify a change name after `/opsx:archive` (e.g., `/opsx:archive add-auth`). If omitted, check if it can be inferred from conversation context. If vague or ambiguous you MUST prompt for available changes.
|
|
||||||
|
|
||||||
**Steps**
|
|
||||||
|
|
||||||
1. **If no change name provided, prompt for selection**
|
|
||||||
|
|
||||||
Run `openspec list --json` to get available changes. Use the **AskUserQuestion tool** to let the user select.
|
|
||||||
|
|
||||||
Show only active changes (not already archived).
|
|
||||||
Include the schema used for each change if available.
|
|
||||||
|
|
||||||
**IMPORTANT**: Do NOT guess or auto-select a change. Always let the user choose.
|
|
||||||
|
|
||||||
2. **Check artifact completion status**
|
|
||||||
|
|
||||||
Run `openspec status --change "<name>" --json` to check artifact completion.
|
|
||||||
|
|
||||||
Parse the JSON to understand:
|
|
||||||
- `schemaName`: The workflow being used
|
|
||||||
- `artifacts`: List of artifacts with their status (`done` or other)
|
|
||||||
|
|
||||||
**If any artifacts are not `done`:**
|
|
||||||
- Display warning listing incomplete artifacts
|
|
||||||
- Prompt user for confirmation to continue
|
|
||||||
- Proceed if user confirms
|
|
||||||
|
|
||||||
3. **Check task completion status**
|
|
||||||
|
|
||||||
Read the tasks file (typically `tasks.md`) to check for incomplete tasks.
|
|
||||||
|
|
||||||
Count tasks marked with `- [ ]` (incomplete) vs `- [x]` (complete).
|
|
||||||
|
|
||||||
**If incomplete tasks found:**
|
|
||||||
- Display warning showing count of incomplete tasks
|
|
||||||
- Prompt user for confirmation to continue
|
|
||||||
- Proceed if user confirms
|
|
||||||
|
|
||||||
**If no tasks file exists:** Proceed without task-related warning.
|
|
||||||
|
|
||||||
4. **Assess delta spec sync state**
|
|
||||||
|
|
||||||
Check for delta specs at `openspec/changes/<name>/specs/`. If none exist, proceed without sync prompt.
|
|
||||||
|
|
||||||
**If delta specs exist:**
|
|
||||||
- Compare each delta spec with its corresponding main spec at `openspec/specs/<capability>/spec.md`
|
|
||||||
- Determine what changes would be applied (adds, modifications, removals, renames)
|
|
||||||
- Show a combined summary before prompting
|
|
||||||
|
|
||||||
**Prompt options:**
|
|
||||||
- If changes needed: "Sync now (recommended)", "Archive without syncing"
|
|
||||||
- If already synced: "Archive now", "Sync anyway", "Cancel"
|
|
||||||
|
|
||||||
If user chooses sync, execute `/opsx:sync` logic. Proceed to archive regardless of choice.
|
|
||||||
|
|
||||||
5. **Perform the archive**
|
|
||||||
|
|
||||||
Create the archive directory if it doesn't exist:
|
|
||||||
```bash
|
|
||||||
mkdir -p openspec/changes/archive
|
|
||||||
```
|
|
||||||
|
|
||||||
Generate target name using current date: `YYYY-MM-DD-<change-name>`
|
|
||||||
|
|
||||||
**Check if target already exists:**
|
|
||||||
- If yes: Fail with error, suggest renaming existing archive or using different date
|
|
||||||
- If no: Move the change directory to archive
|
|
||||||
|
|
||||||
```bash
|
|
||||||
mv openspec/changes/<name> openspec/changes/archive/YYYY-MM-DD-<name>
|
|
||||||
```
|
|
||||||
|
|
||||||
6. **Display summary**
|
|
||||||
|
|
||||||
Show archive completion summary including:
|
|
||||||
- Change name
|
|
||||||
- Schema that was used
|
|
||||||
- Archive location
|
|
||||||
- Spec sync status (synced / sync skipped / no delta specs)
|
|
||||||
- Note about any warnings (incomplete artifacts/tasks)
|
|
||||||
|
|
||||||
**Output On Success**
|
|
||||||
|
|
||||||
```
|
|
||||||
## Archive Complete
|
|
||||||
|
|
||||||
**Change:** <change-name>
|
|
||||||
**Schema:** <schema-name>
|
|
||||||
**Archived to:** openspec/changes/archive/YYYY-MM-DD-<name>/
|
|
||||||
**Specs:** ✓ Synced to main specs
|
|
||||||
|
|
||||||
All artifacts complete. All tasks complete.
|
|
||||||
```
|
|
||||||
|
|
||||||
**Output On Success (No Delta Specs)**
|
|
||||||
|
|
||||||
```
|
|
||||||
## Archive Complete
|
|
||||||
|
|
||||||
**Change:** <change-name>
|
|
||||||
**Schema:** <schema-name>
|
|
||||||
**Archived to:** openspec/changes/archive/YYYY-MM-DD-<name>/
|
|
||||||
**Specs:** No delta specs
|
|
||||||
|
|
||||||
All artifacts complete. All tasks complete.
|
|
||||||
```
|
|
||||||
|
|
||||||
**Output On Success With Warnings**
|
|
||||||
|
|
||||||
```
|
|
||||||
## Archive Complete (with warnings)
|
|
||||||
|
|
||||||
**Change:** <change-name>
|
|
||||||
**Schema:** <schema-name>
|
|
||||||
**Archived to:** openspec/changes/archive/YYYY-MM-DD-<name>/
|
|
||||||
**Specs:** Sync skipped (user chose to skip)
|
|
||||||
|
|
||||||
**Warnings:**
|
|
||||||
- Archived with 2 incomplete artifacts
|
|
||||||
- Archived with 3 incomplete tasks
|
|
||||||
- Delta spec sync was skipped (user chose to skip)
|
|
||||||
|
|
||||||
Review the archive if this was not intentional.
|
|
||||||
```
|
|
||||||
|
|
||||||
**Output On Error (Archive Exists)**
|
|
||||||
|
|
||||||
```
|
|
||||||
## Archive Failed
|
|
||||||
|
|
||||||
**Change:** <change-name>
|
|
||||||
**Target:** openspec/changes/archive/YYYY-MM-DD-<name>/
|
|
||||||
|
|
||||||
Target archive directory already exists.
|
|
||||||
|
|
||||||
**Options:**
|
|
||||||
1. Rename the existing archive
|
|
||||||
2. Delete the existing archive if it's a duplicate
|
|
||||||
3. Wait until a different date to archive
|
|
||||||
```
|
|
||||||
|
|
||||||
**Guardrails**
|
|
||||||
- Always prompt for change selection if not provided
|
|
||||||
- Use artifact graph (openspec status --json) for completion checking
|
|
||||||
- Don't block archive on warnings - just inform and confirm
|
|
||||||
- Preserve .openspec.yaml when moving to archive (it moves with the directory)
|
|
||||||
- Show clear summary of what happened
|
|
||||||
- If sync is requested, use /opsx:sync approach (agent-driven)
|
|
||||||
- If delta specs exist, always run the sync assessment and show the combined summary before prompting
|
|
||||||
@@ -1,235 +0,0 @@
|
|||||||
Archive multiple completed changes in a single operation.
|
|
||||||
|
|
||||||
This skill allows you to batch-archive changes, handling spec conflicts intelligently by checking the codebase to determine what's actually implemented.
|
|
||||||
|
|
||||||
**Input**: None required (prompts for selection)
|
|
||||||
|
|
||||||
**Steps**
|
|
||||||
|
|
||||||
1. **Get active changes**
|
|
||||||
|
|
||||||
Run `openspec list --json` to get all active changes.
|
|
||||||
|
|
||||||
If no active changes exist, inform user and stop.
|
|
||||||
|
|
||||||
2. **Prompt for change selection**
|
|
||||||
|
|
||||||
Use **AskUserQuestion tool** with multi-select to let user choose changes:
|
|
||||||
- Show each change with its schema
|
|
||||||
- Include an option for "All changes"
|
|
||||||
- Allow any number of selections (1+ works, 2+ is the typical use case)
|
|
||||||
|
|
||||||
**IMPORTANT**: Do NOT auto-select. Always let the user choose.
|
|
||||||
|
|
||||||
3. **Batch validation - gather status for all selected changes**
|
|
||||||
|
|
||||||
For each selected change, collect:
|
|
||||||
|
|
||||||
a. **Artifact status** - Run `openspec status --change "<name>" --json`
|
|
||||||
- Parse `schemaName` and `artifacts` list
|
|
||||||
- Note which artifacts are `done` vs other states
|
|
||||||
|
|
||||||
b. **Task completion** - Read `openspec/changes/<name>/tasks.md`
|
|
||||||
- Count `- [ ]` (incomplete) vs `- [x]` (complete)
|
|
||||||
- If no tasks file exists, note as "No tasks"
|
|
||||||
|
|
||||||
c. **Delta specs** - Check `openspec/changes/<name>/specs/` directory
|
|
||||||
- List which capability specs exist
|
|
||||||
- For each, extract requirement names (lines matching `### Requirement: <name>`)
|
|
||||||
|
|
||||||
4. **Detect spec conflicts**
|
|
||||||
|
|
||||||
Build a map of `capability -> [changes that touch it]`:
|
|
||||||
|
|
||||||
```
|
|
||||||
auth -> [change-a, change-b] <- CONFLICT (2+ changes)
|
|
||||||
api -> [change-c] <- OK (only 1 change)
|
|
||||||
```
|
|
||||||
|
|
||||||
A conflict exists when 2+ selected changes have delta specs for the same capability.
|
|
||||||
|
|
||||||
5. **Resolve conflicts agentically**
|
|
||||||
|
|
||||||
**For each conflict**, investigate the codebase:
|
|
||||||
|
|
||||||
a. **Read the delta specs** from each conflicting change to understand what each claims to add/modify
|
|
||||||
|
|
||||||
b. **Search the codebase** for implementation evidence:
|
|
||||||
- Look for code implementing requirements from each delta spec
|
|
||||||
- Check for related files, functions, or tests
|
|
||||||
|
|
||||||
c. **Determine resolution**:
|
|
||||||
- If only one change is actually implemented -> sync that one's specs
|
|
||||||
- If both implemented -> apply in chronological order (older first, newer overwrites)
|
|
||||||
- If neither implemented -> skip spec sync, warn user
|
|
||||||
|
|
||||||
d. **Record resolution** for each conflict:
|
|
||||||
- Which change's specs to apply
|
|
||||||
- In what order (if both)
|
|
||||||
- Rationale (what was found in codebase)
|
|
||||||
|
|
||||||
6. **Show consolidated status table**
|
|
||||||
|
|
||||||
Display a table summarizing all changes:
|
|
||||||
|
|
||||||
```
|
|
||||||
| Change | Artifacts | Tasks | Specs | Conflicts | Status |
|
|
||||||
|---------------------|-----------|-------|---------|-----------|--------|
|
|
||||||
| schema-management | Done | 5/5 | 2 delta | None | Ready |
|
|
||||||
| project-config | Done | 3/3 | 1 delta | None | Ready |
|
|
||||||
| add-oauth | Done | 4/4 | 1 delta | auth (!) | Ready* |
|
|
||||||
| add-verify-skill | 1 left | 2/5 | None | None | Warn |
|
|
||||||
```
|
|
||||||
|
|
||||||
For conflicts, show the resolution:
|
|
||||||
```
|
|
||||||
* Conflict resolution:
|
|
||||||
- auth spec: Will apply add-oauth then add-jwt (both implemented, chronological order)
|
|
||||||
```
|
|
||||||
|
|
||||||
For incomplete changes, show warnings:
|
|
||||||
```
|
|
||||||
Warnings:
|
|
||||||
- add-verify-skill: 1 incomplete artifact, 3 incomplete tasks
|
|
||||||
```
|
|
||||||
|
|
||||||
7. **Confirm batch operation**
|
|
||||||
|
|
||||||
Use **AskUserQuestion tool** with a single confirmation:
|
|
||||||
|
|
||||||
- "Archive N changes?" with options based on status
|
|
||||||
- Options might include:
|
|
||||||
- "Archive all N changes"
|
|
||||||
- "Archive only N ready changes (skip incomplete)"
|
|
||||||
- "Cancel"
|
|
||||||
|
|
||||||
If there are incomplete changes, make clear they'll be archived with warnings.
|
|
||||||
|
|
||||||
8. **Execute archive for each confirmed change**
|
|
||||||
|
|
||||||
Process changes in the determined order (respecting conflict resolution):
|
|
||||||
|
|
||||||
a. **Sync specs** if delta specs exist:
|
|
||||||
- Use the openspec-sync-specs approach (agent-driven intelligent merge)
|
|
||||||
- For conflicts, apply in resolved order
|
|
||||||
- Track if sync was done
|
|
||||||
|
|
||||||
b. **Perform the archive**:
|
|
||||||
```bash
|
|
||||||
mkdir -p openspec/changes/archive
|
|
||||||
mv openspec/changes/<name> openspec/changes/archive/YYYY-MM-DD-<name>
|
|
||||||
```
|
|
||||||
|
|
||||||
c. **Track outcome** for each change:
|
|
||||||
- Success: archived successfully
|
|
||||||
- Failed: error during archive (record error)
|
|
||||||
- Skipped: user chose not to archive (if applicable)
|
|
||||||
|
|
||||||
9. **Display summary**
|
|
||||||
|
|
||||||
Show final results:
|
|
||||||
|
|
||||||
```
|
|
||||||
## Bulk Archive Complete
|
|
||||||
|
|
||||||
Archived 3 changes:
|
|
||||||
- schema-management-cli -> archive/2026-01-19-schema-management-cli/
|
|
||||||
- project-config -> archive/2026-01-19-project-config/
|
|
||||||
- add-oauth -> archive/2026-01-19-add-oauth/
|
|
||||||
|
|
||||||
Skipped 1 change:
|
|
||||||
- add-verify-skill (user chose not to archive incomplete)
|
|
||||||
|
|
||||||
Spec sync summary:
|
|
||||||
- 4 delta specs synced to main specs
|
|
||||||
- 1 conflict resolved (auth: applied both in chronological order)
|
|
||||||
```
|
|
||||||
|
|
||||||
If any failures:
|
|
||||||
```
|
|
||||||
Failed 1 change:
|
|
||||||
- some-change: Archive directory already exists
|
|
||||||
```
|
|
||||||
|
|
||||||
**Conflict Resolution Examples**
|
|
||||||
|
|
||||||
Example 1: Only one implemented
|
|
||||||
```
|
|
||||||
Conflict: specs/auth/spec.md touched by [add-oauth, add-jwt]
|
|
||||||
|
|
||||||
Checking add-oauth:
|
|
||||||
- Delta adds "OAuth Provider Integration" requirement
|
|
||||||
- Searching codebase... found src/auth/oauth.ts implementing OAuth flow
|
|
||||||
|
|
||||||
Checking add-jwt:
|
|
||||||
- Delta adds "JWT Token Handling" requirement
|
|
||||||
- Searching codebase... no JWT implementation found
|
|
||||||
|
|
||||||
Resolution: Only add-oauth is implemented. Will sync add-oauth specs only.
|
|
||||||
```
|
|
||||||
|
|
||||||
Example 2: Both implemented
|
|
||||||
```
|
|
||||||
Conflict: specs/api/spec.md touched by [add-rest-api, add-graphql]
|
|
||||||
|
|
||||||
Checking add-rest-api (created 2026-01-10):
|
|
||||||
- Delta adds "REST Endpoints" requirement
|
|
||||||
- Searching codebase... found src/api/rest.ts
|
|
||||||
|
|
||||||
Checking add-graphql (created 2026-01-15):
|
|
||||||
- Delta adds "GraphQL Schema" requirement
|
|
||||||
- Searching codebase... found src/api/graphql.ts
|
|
||||||
|
|
||||||
Resolution: Both implemented. Will apply add-rest-api specs first,
|
|
||||||
then add-graphql specs (chronological order, newer takes precedence).
|
|
||||||
```
|
|
||||||
|
|
||||||
**Output On Success**
|
|
||||||
|
|
||||||
```
|
|
||||||
## Bulk Archive Complete
|
|
||||||
|
|
||||||
Archived N changes:
|
|
||||||
- <change-1> -> archive/YYYY-MM-DD-<change-1>/
|
|
||||||
- <change-2> -> archive/YYYY-MM-DD-<change-2>/
|
|
||||||
|
|
||||||
Spec sync summary:
|
|
||||||
- N delta specs synced to main specs
|
|
||||||
- No conflicts (or: M conflicts resolved)
|
|
||||||
```
|
|
||||||
|
|
||||||
**Output On Partial Success**
|
|
||||||
|
|
||||||
```
|
|
||||||
## Bulk Archive Complete (partial)
|
|
||||||
|
|
||||||
Archived N changes:
|
|
||||||
- <change-1> -> archive/YYYY-MM-DD-<change-1>/
|
|
||||||
|
|
||||||
Skipped M changes:
|
|
||||||
- <change-2> (user chose not to archive incomplete)
|
|
||||||
|
|
||||||
Failed K changes:
|
|
||||||
- <change-3>: Archive directory already exists
|
|
||||||
```
|
|
||||||
|
|
||||||
**Output When No Changes**
|
|
||||||
|
|
||||||
```
|
|
||||||
## No Changes to Archive
|
|
||||||
|
|
||||||
No active changes found. Use `/opsx:new` to create a new change.
|
|
||||||
```
|
|
||||||
|
|
||||||
**Guardrails**
|
|
||||||
- Allow any number of changes (1+ is fine, 2+ is the typical use case)
|
|
||||||
- Always prompt for selection, never auto-select
|
|
||||||
- Detect spec conflicts early and resolve by checking codebase
|
|
||||||
- When both changes are implemented, apply specs in chronological order
|
|
||||||
- Skip spec sync only when implementation is missing (warn user)
|
|
||||||
- Show clear per-change status before confirming
|
|
||||||
- Use single confirmation for entire batch
|
|
||||||
- Track and report all outcomes (success/skip/fail)
|
|
||||||
- Preserve .openspec.yaml when moving to archive
|
|
||||||
- Archive directory target uses current date: YYYY-MM-DD-<name>
|
|
||||||
- If archive target exists, fail that change but continue with others
|
|
||||||
@@ -1,107 +0,0 @@
|
|||||||
Continue working on a change by creating the next artifact.
|
|
||||||
|
|
||||||
**Input**: Optionally specify a change name after `/opsx:continue` (e.g., `/opsx:continue add-auth`). If omitted, check if it can be inferred from conversation context. If vague or ambiguous you MUST prompt for available changes.
|
|
||||||
|
|
||||||
**Steps**
|
|
||||||
|
|
||||||
1. **If no change name provided, prompt for selection**
|
|
||||||
|
|
||||||
Run `openspec list --json` to get available changes sorted by most recently modified. Then use the **AskUserQuestion tool** to let the user select which change to work on.
|
|
||||||
|
|
||||||
Present the top 3-4 most recently modified changes as options, showing:
|
|
||||||
- Change name
|
|
||||||
- Schema (from `schema` field if present, otherwise "spec-driven")
|
|
||||||
- Status (e.g., "0/5 tasks", "complete", "no tasks")
|
|
||||||
- How recently it was modified (from `lastModified` field)
|
|
||||||
|
|
||||||
Mark the most recently modified change as "(Recommended)" since it's likely what the user wants to continue.
|
|
||||||
|
|
||||||
**IMPORTANT**: Do NOT guess or auto-select a change. Always let the user choose.
|
|
||||||
|
|
||||||
2. **Check current status**
|
|
||||||
```bash
|
|
||||||
openspec status --change "<name>" --json
|
|
||||||
```
|
|
||||||
Parse the JSON to understand current state. The response includes:
|
|
||||||
- `schemaName`: The workflow schema being used (e.g., "spec-driven")
|
|
||||||
- `artifacts`: Array of artifacts with their status ("done", "ready", "blocked")
|
|
||||||
- `isComplete`: Boolean indicating if all artifacts are complete
|
|
||||||
|
|
||||||
3. **Act based on status**:
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
**If all artifacts are complete (`isComplete: true`)**:
|
|
||||||
- Congratulate the user
|
|
||||||
- Show final status including the schema used
|
|
||||||
- Suggest: "All artifacts created! You can now implement this change with `/opsx:apply` or archive it with `/opsx:archive`."
|
|
||||||
- STOP
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
**If artifacts are ready to create** (status shows artifacts with `status: "ready"`):
|
|
||||||
- Pick the FIRST artifact with `status: "ready"` from the status output
|
|
||||||
- Get its instructions:
|
|
||||||
```bash
|
|
||||||
openspec instructions <artifact-id> --change "<name>" --json
|
|
||||||
```
|
|
||||||
- Parse the JSON. The key fields are:
|
|
||||||
- `context`: Project background (constraints for you - do NOT include in output)
|
|
||||||
- `rules`: Artifact-specific rules (constraints for you - do NOT include in output)
|
|
||||||
- `template`: The structure to use for your output file
|
|
||||||
- `instruction`: Schema-specific guidance
|
|
||||||
- `outputPath`: Where to write the artifact
|
|
||||||
- `dependencies`: Completed artifacts to read for context
|
|
||||||
- **Create the artifact file**:
|
|
||||||
- Read any completed dependency files for context
|
|
||||||
- Use `template` as the structure - fill in its sections
|
|
||||||
- Apply `context` and `rules` as constraints when writing - but do NOT copy them into the file
|
|
||||||
- Write to the output path specified in instructions
|
|
||||||
- Show what was created and what's now unlocked
|
|
||||||
- STOP after creating ONE artifact
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
**If no artifacts are ready (all blocked)**:
|
|
||||||
- This shouldn't happen with a valid schema
|
|
||||||
- Show status and suggest checking for issues
|
|
||||||
|
|
||||||
4. **After creating an artifact, show progress**
|
|
||||||
```bash
|
|
||||||
openspec status --change "<name>"
|
|
||||||
```
|
|
||||||
|
|
||||||
**Output**
|
|
||||||
|
|
||||||
After each invocation, show:
|
|
||||||
- Which artifact was created
|
|
||||||
- Schema workflow being used
|
|
||||||
- Current progress (N/M complete)
|
|
||||||
- What artifacts are now unlocked
|
|
||||||
- Prompt: "Run `/opsx:continue` to create the next artifact"
|
|
||||||
|
|
||||||
**Artifact Creation Guidelines**
|
|
||||||
|
|
||||||
The artifact types and their purpose depend on the schema. Use the `instruction` field from the instructions output to understand what to create.
|
|
||||||
|
|
||||||
Common artifact patterns:
|
|
||||||
|
|
||||||
**spec-driven schema** (proposal → specs → design → tasks):
|
|
||||||
- **proposal.md**: Ask user about the change if not clear. Fill in Why, What Changes, Capabilities, Impact.
|
|
||||||
- The Capabilities section is critical - each capability listed will need a spec file.
|
|
||||||
- **specs/<capability>/spec.md**: Create one spec per capability listed in the proposal's Capabilities section (use the capability name, not the change name).
|
|
||||||
- **design.md**: Document technical decisions, architecture, and implementation approach.
|
|
||||||
- **tasks.md**: Break down implementation into checkboxed tasks.
|
|
||||||
|
|
||||||
For other schemas, follow the `instruction` field from the CLI output.
|
|
||||||
|
|
||||||
**Guardrails**
|
|
||||||
- Create ONE artifact per invocation
|
|
||||||
- Always read dependency artifacts before creating a new one
|
|
||||||
- Never skip artifacts or create out of order
|
|
||||||
- If context is unclear, ask the user before creating
|
|
||||||
- Verify the artifact file exists after writing before marking progress
|
|
||||||
- Use the schema's artifact sequence, don't assume specific artifact names
|
|
||||||
- **IMPORTANT**: `context` and `rules` are constraints for YOU, not content for the file
|
|
||||||
- Do NOT copy `<context>`, `<rules>`, `<project_context>` blocks into the artifact
|
|
||||||
- These guide what you write, but should never appear in the output
|
|
||||||
@@ -1,167 +0,0 @@
|
|||||||
Enter explore mode. Think deeply. Visualize freely. Follow the conversation wherever it goes.
|
|
||||||
|
|
||||||
**IMPORTANT: Explore mode is for thinking, not implementing.** You may read files, search code, and investigate the codebase, but you must NEVER write code or implement features. If the user asks you to implement something, remind them to exit explore mode first (e.g., start a change with `/opsx:new` or `/opsx:ff`). You MAY create OpenSpec artifacts (proposals, designs, specs) if the user asks—that's capturing thinking, not implementing.
|
|
||||||
|
|
||||||
**This is a stance, not a workflow.** There are no fixed steps, no required sequence, no mandatory outputs. You're a thinking partner helping the user explore.
|
|
||||||
|
|
||||||
**Input**: The argument after `/opsx:explore` is whatever the user wants to think about. Could be:
|
|
||||||
- A vague idea: "real-time collaboration"
|
|
||||||
- A specific problem: "the auth system is getting unwieldy"
|
|
||||||
- A change name: "add-dark-mode" (to explore in context of that change)
|
|
||||||
- A comparison: "postgres vs sqlite for this"
|
|
||||||
- Nothing (just enter explore mode)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## The Stance
|
|
||||||
|
|
||||||
- **Curious, not prescriptive** - Ask questions that emerge naturally, don't follow a script
|
|
||||||
- **Open threads, not interrogations** - Surface multiple interesting directions and let the user follow what resonates. Don't funnel them through a single path of questions.
|
|
||||||
- **Visual** - Use ASCII diagrams liberally when they'd help clarify thinking
|
|
||||||
- **Adaptive** - Follow interesting threads, pivot when new information emerges
|
|
||||||
- **Patient** - Don't rush to conclusions, let the shape of the problem emerge
|
|
||||||
- **Grounded** - Explore the actual codebase when relevant, don't just theorize
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## What You Might Do
|
|
||||||
|
|
||||||
Depending on what the user brings, you might:
|
|
||||||
|
|
||||||
**Explore the problem space**
|
|
||||||
- Ask clarifying questions that emerge from what they said
|
|
||||||
- Challenge assumptions
|
|
||||||
- Reframe the problem
|
|
||||||
- Find analogies
|
|
||||||
|
|
||||||
**Investigate the codebase**
|
|
||||||
- Map existing architecture relevant to the discussion
|
|
||||||
- Find integration points
|
|
||||||
- Identify patterns already in use
|
|
||||||
- Surface hidden complexity
|
|
||||||
|
|
||||||
**Compare options**
|
|
||||||
- Brainstorm multiple approaches
|
|
||||||
- Build comparison tables
|
|
||||||
- Sketch tradeoffs
|
|
||||||
- Recommend a path (if asked)
|
|
||||||
|
|
||||||
**Visualize**
|
|
||||||
```
|
|
||||||
┌─────────────────────────────────────────┐
|
|
||||||
│ Use ASCII diagrams liberally │
|
|
||||||
├─────────────────────────────────────────┤
|
|
||||||
│ │
|
|
||||||
│ ┌────────┐ ┌────────┐ │
|
|
||||||
│ │ State │────────▶│ State │ │
|
|
||||||
│ │ A │ │ B │ │
|
|
||||||
│ └────────┘ └────────┘ │
|
|
||||||
│ │
|
|
||||||
│ System diagrams, state machines, │
|
|
||||||
│ data flows, architecture sketches, │
|
|
||||||
│ dependency graphs, comparison tables │
|
|
||||||
│ │
|
|
||||||
└─────────────────────────────────────────┘
|
|
||||||
```
|
|
||||||
|
|
||||||
**Surface risks and unknowns**
|
|
||||||
- Identify what could go wrong
|
|
||||||
- Find gaps in understanding
|
|
||||||
- Suggest spikes or investigations
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## OpenSpec Awareness
|
|
||||||
|
|
||||||
You have full context of the OpenSpec system. Use it naturally, don't force it.
|
|
||||||
|
|
||||||
### Check for context
|
|
||||||
|
|
||||||
At the start, quickly check what exists:
|
|
||||||
```bash
|
|
||||||
openspec list --json
|
|
||||||
```
|
|
||||||
|
|
||||||
This tells you:
|
|
||||||
- If there are active changes
|
|
||||||
- Their names, schemas, and status
|
|
||||||
- What the user might be working on
|
|
||||||
|
|
||||||
If the user mentioned a specific change name, read its artifacts for context.
|
|
||||||
|
|
||||||
### When no change exists
|
|
||||||
|
|
||||||
Think freely. When insights crystallize, you might offer:
|
|
||||||
|
|
||||||
- "This feels solid enough to start a change. Want me to create one?"
|
|
||||||
→ Can transition to `/opsx:new` or `/opsx:ff`
|
|
||||||
- Or keep exploring - no pressure to formalize
|
|
||||||
|
|
||||||
### When a change exists
|
|
||||||
|
|
||||||
If the user mentions a change or you detect one is relevant:
|
|
||||||
|
|
||||||
1. **Read existing artifacts for context**
|
|
||||||
- `openspec/changes/<name>/proposal.md`
|
|
||||||
- `openspec/changes/<name>/design.md`
|
|
||||||
- `openspec/changes/<name>/tasks.md`
|
|
||||||
- etc.
|
|
||||||
|
|
||||||
2. **Reference them naturally in conversation**
|
|
||||||
- "Your design mentions using Redis, but we just realized SQLite fits better..."
|
|
||||||
- "The proposal scopes this to premium users, but we're now thinking everyone..."
|
|
||||||
|
|
||||||
3. **Offer to capture when decisions are made**
|
|
||||||
|
|
||||||
| Insight Type | Where to Capture |
|
|
||||||
|--------------|------------------|
|
|
||||||
| New requirement discovered | `specs/<capability>/spec.md` |
|
|
||||||
| Requirement changed | `specs/<capability>/spec.md` |
|
|
||||||
| Design decision made | `design.md` |
|
|
||||||
| Scope changed | `proposal.md` |
|
|
||||||
| New work identified | `tasks.md` |
|
|
||||||
| Assumption invalidated | Relevant artifact |
|
|
||||||
|
|
||||||
Example offers:
|
|
||||||
- "That's a design decision. Capture it in design.md?"
|
|
||||||
- "This is a new requirement. Add it to specs?"
|
|
||||||
- "This changes scope. Update the proposal?"
|
|
||||||
|
|
||||||
4. **The user decides** - Offer and move on. Don't pressure. Don't auto-capture.
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## What You Don't Have To Do
|
|
||||||
|
|
||||||
- Follow a script
|
|
||||||
- Ask the same questions every time
|
|
||||||
- Produce a specific artifact
|
|
||||||
- Reach a conclusion
|
|
||||||
- Stay on topic if a tangent is valuable
|
|
||||||
- Be brief (this is thinking time)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Ending Discovery
|
|
||||||
|
|
||||||
There's no required ending. Discovery might:
|
|
||||||
|
|
||||||
- **Flow into action**: "Ready to start? `/opsx:new` or `/opsx:ff`"
|
|
||||||
- **Result in artifact updates**: "Updated design.md with these decisions"
|
|
||||||
- **Just provide clarity**: User has what they need, moves on
|
|
||||||
- **Continue later**: "We can pick this up anytime"
|
|
||||||
|
|
||||||
When things crystallize, you might offer a summary - but it's optional. Sometimes the thinking IS the value.
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Guardrails
|
|
||||||
|
|
||||||
- **Don't implement** - Never write code or implement features. Creating OpenSpec artifacts is fine, writing application code is not.
|
|
||||||
- **Don't fake understanding** - If something is unclear, dig deeper
|
|
||||||
- **Don't rush** - Discovery is thinking time, not task time
|
|
||||||
- **Don't force structure** - Let patterns emerge naturally
|
|
||||||
- **Don't auto-capture** - Offer to save insights, don't just do it
|
|
||||||
- **Do visualize** - A good diagram is worth many paragraphs
|
|
||||||
- **Do explore the codebase** - Ground discussions in reality
|
|
||||||
- **Do question assumptions** - Including the user's and your own
|
|
||||||
@@ -1,87 +0,0 @@
|
|||||||
Fast-forward through artifact creation - generate everything needed to start implementation.
|
|
||||||
|
|
||||||
**Input**: The argument after `/opsx:ff` is the change name (kebab-case), OR a description of what the user wants to build.
|
|
||||||
|
|
||||||
**Steps**
|
|
||||||
|
|
||||||
1. **If no input provided, ask what they want to build**
|
|
||||||
|
|
||||||
Use the **AskUserQuestion tool** (open-ended, no preset options) to ask:
|
|
||||||
> "What change do you want to work on? Describe what you want to build or fix."
|
|
||||||
|
|
||||||
From their description, derive a kebab-case name (e.g., "add user authentication" → `add-user-auth`).
|
|
||||||
|
|
||||||
**IMPORTANT**: Do NOT proceed without understanding what the user wants to build.
|
|
||||||
|
|
||||||
2. **Create the change directory**
|
|
||||||
```bash
|
|
||||||
openspec new change "<name>"
|
|
||||||
```
|
|
||||||
This creates a scaffolded change at `openspec/changes/<name>/`.
|
|
||||||
|
|
||||||
3. **Get the artifact build order**
|
|
||||||
```bash
|
|
||||||
openspec status --change "<name>" --json
|
|
||||||
```
|
|
||||||
Parse the JSON to get:
|
|
||||||
- `applyRequires`: array of artifact IDs needed before implementation (e.g., `["tasks"]`)
|
|
||||||
- `artifacts`: list of all artifacts with their status and dependencies
|
|
||||||
|
|
||||||
4. **Create artifacts in sequence until apply-ready**
|
|
||||||
|
|
||||||
Use the **TodoWrite tool** to track progress through the artifacts.
|
|
||||||
|
|
||||||
Loop through artifacts in dependency order (artifacts with no pending dependencies first):
|
|
||||||
|
|
||||||
a. **For each artifact that is `ready` (dependencies satisfied)**:
|
|
||||||
- Get instructions:
|
|
||||||
```bash
|
|
||||||
openspec instructions <artifact-id> --change "<name>" --json
|
|
||||||
```
|
|
||||||
- The instructions JSON includes:
|
|
||||||
- `context`: Project background (constraints for you - do NOT include in output)
|
|
||||||
- `rules`: Artifact-specific rules (constraints for you - do NOT include in output)
|
|
||||||
- `template`: The structure to use for your output file
|
|
||||||
- `instruction`: Schema-specific guidance for this artifact type
|
|
||||||
- `outputPath`: Where to write the artifact
|
|
||||||
- `dependencies`: Completed artifacts to read for context
|
|
||||||
- Read any completed dependency files for context
|
|
||||||
- Create the artifact file using `template` as the structure
|
|
||||||
- Apply `context` and `rules` as constraints - but do NOT copy them into the file
|
|
||||||
- Show brief progress: "✓ Created <artifact-id>"
|
|
||||||
|
|
||||||
b. **Continue until all `applyRequires` artifacts are complete**
|
|
||||||
- After creating each artifact, re-run `openspec status --change "<name>" --json`
|
|
||||||
- Check if every artifact ID in `applyRequires` has `status: "done"` in the artifacts array
|
|
||||||
- Stop when all `applyRequires` artifacts are done
|
|
||||||
|
|
||||||
c. **If an artifact requires user input** (unclear context):
|
|
||||||
- Use **AskUserQuestion tool** to clarify
|
|
||||||
- Then continue with creation
|
|
||||||
|
|
||||||
5. **Show final status**
|
|
||||||
```bash
|
|
||||||
openspec status --change "<name>"
|
|
||||||
```
|
|
||||||
|
|
||||||
**Output**
|
|
||||||
|
|
||||||
After completing all artifacts, summarize:
|
|
||||||
- Change name and location
|
|
||||||
- List of artifacts created with brief descriptions
|
|
||||||
- What's ready: "All artifacts created! Ready for implementation."
|
|
||||||
- Prompt: "Run `/opsx:apply` to start implementing."
|
|
||||||
|
|
||||||
**Artifact Creation Guidelines**
|
|
||||||
|
|
||||||
- Follow the `instruction` field from `openspec instructions` for each artifact type
|
|
||||||
- The schema defines what each artifact should contain - follow it
|
|
||||||
- Read dependency artifacts for context before creating new ones
|
|
||||||
- Use the `template` as a starting point, filling in based on context
|
|
||||||
|
|
||||||
**Guardrails**
|
|
||||||
- Create ALL artifacts needed for implementation (as defined by schema's `apply.requires`)
|
|
||||||
- Always read dependency artifacts before creating a new one
|
|
||||||
- If context is critically unclear, ask the user - but prefer making reasonable decisions to keep momentum
|
|
||||||
- If a change with that name already exists, ask if user wants to continue it or create a new one
|
|
||||||
- Verify each artifact file exists after writing before proceeding to next
|
|
||||||
@@ -1,62 +0,0 @@
|
|||||||
Start a new change using the experimental artifact-driven approach.
|
|
||||||
|
|
||||||
**Input**: The argument after `/opsx:new` is the change name (kebab-case), OR a description of what the user wants to build.
|
|
||||||
|
|
||||||
**Steps**
|
|
||||||
|
|
||||||
1. **If no input provided, ask what they want to build**
|
|
||||||
|
|
||||||
Use the **AskUserQuestion tool** (open-ended, no preset options) to ask:
|
|
||||||
> "What change do you want to work on? Describe what you want to build or fix."
|
|
||||||
|
|
||||||
From their description, derive a kebab-case name (e.g., "add user authentication" → `add-user-auth`).
|
|
||||||
|
|
||||||
**IMPORTANT**: Do NOT proceed without understanding what the user wants to build.
|
|
||||||
|
|
||||||
2. **Determine the workflow schema**
|
|
||||||
|
|
||||||
Use the default schema (omit `--schema`) unless the user explicitly requests a different workflow.
|
|
||||||
|
|
||||||
**Use a different schema only if the user mentions:**
|
|
||||||
- A specific schema name → use `--schema <name>`
|
|
||||||
- "show workflows" or "what workflows" → run `openspec schemas --json` and let them choose
|
|
||||||
|
|
||||||
**Otherwise**: Omit `--schema` to use the default.
|
|
||||||
|
|
||||||
3. **Create the change directory**
|
|
||||||
```bash
|
|
||||||
openspec new change "<name>"
|
|
||||||
```
|
|
||||||
Add `--schema <name>` only if the user requested a specific workflow.
|
|
||||||
This creates a scaffolded change at `openspec/changes/<name>/` with the selected schema.
|
|
||||||
|
|
||||||
4. **Show the artifact status**
|
|
||||||
```bash
|
|
||||||
openspec status --change "<name>"
|
|
||||||
```
|
|
||||||
This shows which artifacts need to be created and which are ready (dependencies satisfied).
|
|
||||||
|
|
||||||
5. **Get instructions for the first artifact**
|
|
||||||
The first artifact depends on the schema. Check the status output to find the first artifact with status "ready".
|
|
||||||
```bash
|
|
||||||
openspec instructions <first-artifact-id> --change "<name>"
|
|
||||||
```
|
|
||||||
This outputs the template and context for creating the first artifact.
|
|
||||||
|
|
||||||
6. **STOP and wait for user direction**
|
|
||||||
|
|
||||||
**Output**
|
|
||||||
|
|
||||||
After completing the steps, summarize:
|
|
||||||
- Change name and location
|
|
||||||
- Schema/workflow being used and its artifact sequence
|
|
||||||
- Current status (0/N artifacts complete)
|
|
||||||
- The template for the first artifact
|
|
||||||
- Prompt: "Ready to create the first artifact? Run `/opsx:continue` or just describe what this change is about and I'll draft it."
|
|
||||||
|
|
||||||
**Guardrails**
|
|
||||||
- Do NOT create any artifacts yet - just show the instructions
|
|
||||||
- Do NOT advance beyond showing the first artifact template
|
|
||||||
- If the name is invalid (not kebab-case), ask for a valid name
|
|
||||||
- If a change with that name already exists, suggest using `/opsx:continue` instead
|
|
||||||
- Pass --schema if using a non-default workflow
|
|
||||||
@@ -1,518 +0,0 @@
|
|||||||
Guide the user through their first complete OpenSpec workflow cycle. This is a teaching experience—you'll do real work in their codebase while explaining each step.
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Preflight
|
|
||||||
|
|
||||||
Before starting, check if OpenSpec is initialized:
|
|
||||||
|
|
||||||
```bash
|
|
||||||
openspec status --json 2>&1 || echo "NOT_INITIALIZED"
|
|
||||||
```
|
|
||||||
|
|
||||||
**If not initialized:**
|
|
||||||
> OpenSpec isn't set up in this project yet. Run `openspec init` first, then come back to `/opsx:onboard`.
|
|
||||||
|
|
||||||
Stop here if not initialized.
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Phase 1: Welcome
|
|
||||||
|
|
||||||
Display:
|
|
||||||
|
|
||||||
```
|
|
||||||
## Welcome to OpenSpec!
|
|
||||||
|
|
||||||
I'll walk you through a complete change cycle—from idea to implementation—using a real task in your codebase. Along the way, you'll learn the workflow by doing it.
|
|
||||||
|
|
||||||
**What we'll do:**
|
|
||||||
1. Pick a small, real task in your codebase
|
|
||||||
2. Explore the problem briefly
|
|
||||||
3. Create a change (the container for our work)
|
|
||||||
4. Build the artifacts: proposal → specs → design → tasks
|
|
||||||
5. Implement the tasks
|
|
||||||
6. Archive the completed change
|
|
||||||
|
|
||||||
**Time:** ~15-20 minutes
|
|
||||||
|
|
||||||
Let's start by finding something to work on.
|
|
||||||
```
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Phase 2: Task Selection
|
|
||||||
|
|
||||||
### Codebase Analysis
|
|
||||||
|
|
||||||
Scan the codebase for small improvement opportunities. Look for:
|
|
||||||
|
|
||||||
1. **TODO/FIXME comments** - Search for `TODO`, `FIXME`, `HACK`, `XXX` in code files
|
|
||||||
2. **Missing error handling** - `catch` blocks that swallow errors, risky operations without try-catch
|
|
||||||
3. **Functions without tests** - Cross-reference `src/` with test directories
|
|
||||||
4. **Type issues** - `any` types in TypeScript files (`: any`, `as any`)
|
|
||||||
5. **Debug artifacts** - `console.log`, `console.debug`, `debugger` statements in non-debug code
|
|
||||||
6. **Missing validation** - User input handlers without validation
|
|
||||||
|
|
||||||
Also check recent git activity:
|
|
||||||
```bash
|
|
||||||
git log --oneline -10 2>/dev/null || echo "No git history"
|
|
||||||
```
|
|
||||||
|
|
||||||
### Present Suggestions
|
|
||||||
|
|
||||||
From your analysis, present 3-4 specific suggestions:
|
|
||||||
|
|
||||||
```
|
|
||||||
## Task Suggestions
|
|
||||||
|
|
||||||
Based on scanning your codebase, here are some good starter tasks:
|
|
||||||
|
|
||||||
**1. [Most promising task]**
|
|
||||||
Location: `src/path/to/file.ts:42`
|
|
||||||
Scope: ~1-2 files, ~20-30 lines
|
|
||||||
Why it's good: [brief reason]
|
|
||||||
|
|
||||||
**2. [Second task]**
|
|
||||||
Location: `src/another/file.ts`
|
|
||||||
Scope: ~1 file, ~15 lines
|
|
||||||
Why it's good: [brief reason]
|
|
||||||
|
|
||||||
**3. [Third task]**
|
|
||||||
Location: [location]
|
|
||||||
Scope: [estimate]
|
|
||||||
Why it's good: [brief reason]
|
|
||||||
|
|
||||||
**4. Something else?**
|
|
||||||
Tell me what you'd like to work on.
|
|
||||||
|
|
||||||
Which task interests you? (Pick a number or describe your own)
|
|
||||||
```
|
|
||||||
|
|
||||||
**If nothing found:** Fall back to asking what the user wants to build:
|
|
||||||
> I didn't find obvious quick wins in your codebase. What's something small you've been meaning to add or fix?
|
|
||||||
|
|
||||||
### Scope Guardrail
|
|
||||||
|
|
||||||
If the user picks or describes something too large (major feature, multi-day work):
|
|
||||||
|
|
||||||
```
|
|
||||||
That's a valuable task, but it's probably larger than ideal for your first OpenSpec run-through.
|
|
||||||
|
|
||||||
For learning the workflow, smaller is better—it lets you see the full cycle without getting stuck in implementation details.
|
|
||||||
|
|
||||||
**Options:**
|
|
||||||
1. **Slice it smaller** - What's the smallest useful piece of [their task]? Maybe just [specific slice]?
|
|
||||||
2. **Pick something else** - One of the other suggestions, or a different small task?
|
|
||||||
3. **Do it anyway** - If you really want to tackle this, we can. Just know it'll take longer.
|
|
||||||
|
|
||||||
What would you prefer?
|
|
||||||
```
|
|
||||||
|
|
||||||
Let the user override if they insist—this is a soft guardrail.
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Phase 3: Explore Demo
|
|
||||||
|
|
||||||
Once a task is selected, briefly demonstrate explore mode:
|
|
||||||
|
|
||||||
```
|
|
||||||
Before we create a change, let me quickly show you **explore mode**—it's how you think through problems before committing to a direction.
|
|
||||||
```
|
|
||||||
|
|
||||||
Spend 1-2 minutes investigating the relevant code:
|
|
||||||
- Read the file(s) involved
|
|
||||||
- Draw a quick ASCII diagram if it helps
|
|
||||||
- Note any considerations
|
|
||||||
|
|
||||||
```
|
|
||||||
## Quick Exploration
|
|
||||||
|
|
||||||
[Your brief analysis—what you found, any considerations]
|
|
||||||
|
|
||||||
┌─────────────────────────────────────────┐
|
|
||||||
│ [Optional: ASCII diagram if helpful] │
|
|
||||||
└─────────────────────────────────────────┘
|
|
||||||
|
|
||||||
Explore mode (`/opsx:explore`) is for this kind of thinking—investigating before implementing. You can use it anytime you need to think through a problem.
|
|
||||||
|
|
||||||
Now let's create a change to hold our work.
|
|
||||||
```
|
|
||||||
|
|
||||||
**PAUSE** - Wait for user acknowledgment before proceeding.
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Phase 4: Create the Change
|
|
||||||
|
|
||||||
**EXPLAIN:**
|
|
||||||
```
|
|
||||||
## Creating a Change
|
|
||||||
|
|
||||||
A "change" in OpenSpec is a container for all the thinking and planning around a piece of work. It lives in `openspec/changes/<name>/` and holds your artifacts—proposal, specs, design, tasks.
|
|
||||||
|
|
||||||
Let me create one for our task.
|
|
||||||
```
|
|
||||||
|
|
||||||
**DO:** Create the change with a derived kebab-case name:
|
|
||||||
```bash
|
|
||||||
openspec new change "<derived-name>"
|
|
||||||
```
|
|
||||||
|
|
||||||
**SHOW:**
|
|
||||||
```
|
|
||||||
Created: `openspec/changes/<name>/`
|
|
||||||
|
|
||||||
The folder structure:
|
|
||||||
```
|
|
||||||
openspec/changes/<name>/
|
|
||||||
├── proposal.md ← Why we're doing this (empty, we'll fill it)
|
|
||||||
├── design.md ← How we'll build it (empty)
|
|
||||||
├── specs/ ← Detailed requirements (empty)
|
|
||||||
└── tasks.md ← Implementation checklist (empty)
|
|
||||||
```
|
|
||||||
|
|
||||||
Now let's fill in the first artifact—the proposal.
|
|
||||||
```
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Phase 5: Proposal
|
|
||||||
|
|
||||||
**EXPLAIN:**
|
|
||||||
```
|
|
||||||
## The Proposal
|
|
||||||
|
|
||||||
The proposal captures **why** we're making this change and **what** it involves at a high level. It's the "elevator pitch" for the work.
|
|
||||||
|
|
||||||
I'll draft one based on our task.
|
|
||||||
```
|
|
||||||
|
|
||||||
**DO:** Draft the proposal content (don't save yet):
|
|
||||||
|
|
||||||
```
|
|
||||||
Here's a draft proposal:
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Why
|
|
||||||
|
|
||||||
[1-2 sentences explaining the problem/opportunity]
|
|
||||||
|
|
||||||
## What Changes
|
|
||||||
|
|
||||||
[Bullet points of what will be different]
|
|
||||||
|
|
||||||
## Capabilities
|
|
||||||
|
|
||||||
### New Capabilities
|
|
||||||
- `<capability-name>`: [brief description]
|
|
||||||
|
|
||||||
### Modified Capabilities
|
|
||||||
<!-- If modifying existing behavior -->
|
|
||||||
|
|
||||||
## Impact
|
|
||||||
|
|
||||||
- `src/path/to/file.ts`: [what changes]
|
|
||||||
- [other files if applicable]
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
Does this capture the intent? I can adjust before we save it.
|
|
||||||
```
|
|
||||||
|
|
||||||
**PAUSE** - Wait for user approval/feedback.
|
|
||||||
|
|
||||||
After approval, save the proposal:
|
|
||||||
```bash
|
|
||||||
openspec instructions proposal --change "<name>" --json
|
|
||||||
```
|
|
||||||
Then write the content to `openspec/changes/<name>/proposal.md`.
|
|
||||||
|
|
||||||
```
|
|
||||||
Proposal saved. This is your "why" document—you can always come back and refine it as understanding evolves.
|
|
||||||
|
|
||||||
Next up: specs.
|
|
||||||
```
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Phase 6: Specs
|
|
||||||
|
|
||||||
**EXPLAIN:**
|
|
||||||
```
|
|
||||||
## Specs
|
|
||||||
|
|
||||||
Specs define **what** we're building in precise, testable terms. They use a requirement/scenario format that makes expected behavior crystal clear.
|
|
||||||
|
|
||||||
For a small task like this, we might only need one spec file.
|
|
||||||
```
|
|
||||||
|
|
||||||
**DO:** Create the spec file:
|
|
||||||
```bash
|
|
||||||
mkdir -p openspec/changes/<name>/specs/<capability-name>
|
|
||||||
```
|
|
||||||
|
|
||||||
Draft the spec content:
|
|
||||||
|
|
||||||
```
|
|
||||||
Here's the spec:
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## ADDED Requirements
|
|
||||||
|
|
||||||
### Requirement: <Name>
|
|
||||||
|
|
||||||
<Description of what the system should do>
|
|
||||||
|
|
||||||
#### Scenario: <Scenario name>
|
|
||||||
|
|
||||||
- **WHEN** <trigger condition>
|
|
||||||
- **THEN** <expected outcome>
|
|
||||||
- **AND** <additional outcome if needed>
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
This format—WHEN/THEN/AND—makes requirements testable. You can literally read them as test cases.
|
|
||||||
```
|
|
||||||
|
|
||||||
Save to `openspec/changes/<name>/specs/<capability>/spec.md`.
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Phase 7: Design
|
|
||||||
|
|
||||||
**EXPLAIN:**
|
|
||||||
```
|
|
||||||
## Design
|
|
||||||
|
|
||||||
The design captures **how** we'll build it—technical decisions, tradeoffs, approach.
|
|
||||||
|
|
||||||
For small changes, this might be brief. That's fine—not every change needs deep design discussion.
|
|
||||||
```
|
|
||||||
|
|
||||||
**DO:** Draft design.md:
|
|
||||||
|
|
||||||
```
|
|
||||||
Here's the design:
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Context
|
|
||||||
|
|
||||||
[Brief context about the current state]
|
|
||||||
|
|
||||||
## Goals / Non-Goals
|
|
||||||
|
|
||||||
**Goals:**
|
|
||||||
- [What we're trying to achieve]
|
|
||||||
|
|
||||||
**Non-Goals:**
|
|
||||||
- [What's explicitly out of scope]
|
|
||||||
|
|
||||||
## Decisions
|
|
||||||
|
|
||||||
### Decision 1: [Key decision]
|
|
||||||
|
|
||||||
[Explanation of approach and rationale]
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
For a small task, this captures the key decisions without over-engineering.
|
|
||||||
```
|
|
||||||
|
|
||||||
Save to `openspec/changes/<name>/design.md`.
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Phase 8: Tasks
|
|
||||||
|
|
||||||
**EXPLAIN:**
|
|
||||||
```
|
|
||||||
## Tasks
|
|
||||||
|
|
||||||
Finally, we break the work into implementation tasks—checkboxes that drive the apply phase.
|
|
||||||
|
|
||||||
These should be small, clear, and in logical order.
|
|
||||||
```
|
|
||||||
|
|
||||||
**DO:** Generate tasks based on specs and design:
|
|
||||||
|
|
||||||
```
|
|
||||||
Here are the implementation tasks:
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## 1. [Category or file]
|
|
||||||
|
|
||||||
- [ ] 1.1 [Specific task]
|
|
||||||
- [ ] 1.2 [Specific task]
|
|
||||||
|
|
||||||
## 2. Verify
|
|
||||||
|
|
||||||
- [ ] 2.1 [Verification step]
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
Each checkbox becomes a unit of work in the apply phase. Ready to implement?
|
|
||||||
```
|
|
||||||
|
|
||||||
**PAUSE** - Wait for user to confirm they're ready to implement.
|
|
||||||
|
|
||||||
Save to `openspec/changes/<name>/tasks.md`.
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Phase 9: Apply (Implementation)
|
|
||||||
|
|
||||||
**EXPLAIN:**
|
|
||||||
```
|
|
||||||
## Implementation
|
|
||||||
|
|
||||||
Now we implement each task, checking them off as we go. I'll announce each one and occasionally note how the specs/design informed the approach.
|
|
||||||
```
|
|
||||||
|
|
||||||
**DO:** For each task:
|
|
||||||
|
|
||||||
1. Announce: "Working on task N: [description]"
|
|
||||||
2. Implement the change in the codebase
|
|
||||||
3. Reference specs/design naturally: "The spec says X, so I'm doing Y"
|
|
||||||
4. Mark complete in tasks.md: `- [ ]` → `- [x]`
|
|
||||||
5. Brief status: "✓ Task N complete"
|
|
||||||
|
|
||||||
Keep narration light—don't over-explain every line of code.
|
|
||||||
|
|
||||||
After all tasks:
|
|
||||||
|
|
||||||
```
|
|
||||||
## Implementation Complete
|
|
||||||
|
|
||||||
All tasks done:
|
|
||||||
- [x] Task 1
|
|
||||||
- [x] Task 2
|
|
||||||
- [x] ...
|
|
||||||
|
|
||||||
The change is implemented! One more step—let's archive it.
|
|
||||||
```
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Phase 10: Archive
|
|
||||||
|
|
||||||
**EXPLAIN:**
|
|
||||||
```
|
|
||||||
## Archiving
|
|
||||||
|
|
||||||
When a change is complete, we archive it. This moves it from `openspec/changes/` to `openspec/changes/archive/YYYY-MM-DD-<name>/`.
|
|
||||||
|
|
||||||
Archived changes become your project's decision history—you can always find them later to understand why something was built a certain way.
|
|
||||||
```
|
|
||||||
|
|
||||||
**DO:**
|
|
||||||
```bash
|
|
||||||
openspec archive "<name>"
|
|
||||||
```
|
|
||||||
|
|
||||||
**SHOW:**
|
|
||||||
```
|
|
||||||
Archived to: `openspec/changes/archive/YYYY-MM-DD-<name>/`
|
|
||||||
|
|
||||||
The change is now part of your project's history. The code is in your codebase, the decision record is preserved.
|
|
||||||
```
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Phase 11: Recap & Next Steps
|
|
||||||
|
|
||||||
```
|
|
||||||
## Congratulations!
|
|
||||||
|
|
||||||
You just completed a full OpenSpec cycle:
|
|
||||||
|
|
||||||
1. **Explore** - Thought through the problem
|
|
||||||
2. **New** - Created a change container
|
|
||||||
3. **Proposal** - Captured WHY
|
|
||||||
4. **Specs** - Defined WHAT in detail
|
|
||||||
5. **Design** - Decided HOW
|
|
||||||
6. **Tasks** - Broke it into steps
|
|
||||||
7. **Apply** - Implemented the work
|
|
||||||
8. **Archive** - Preserved the record
|
|
||||||
|
|
||||||
This same rhythm works for any size change—a small fix or a major feature.
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Command Reference
|
|
||||||
|
|
||||||
| Command | What it does |
|
|
||||||
|---------|--------------|
|
|
||||||
| `/opsx:explore` | Think through problems before/during work |
|
|
||||||
| `/opsx:new` | Start a new change, step through artifacts |
|
|
||||||
| `/opsx:ff` | Fast-forward: create all artifacts at once |
|
|
||||||
| `/opsx:continue` | Continue working on an existing change |
|
|
||||||
| `/opsx:apply` | Implement tasks from a change |
|
|
||||||
| `/opsx:verify` | Verify implementation matches artifacts |
|
|
||||||
| `/opsx:archive` | Archive a completed change |
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## What's Next?
|
|
||||||
|
|
||||||
Try `/opsx:new` or `/opsx:ff` on something you actually want to build. You've got the rhythm now!
|
|
||||||
```
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Graceful Exit Handling
|
|
||||||
|
|
||||||
### User wants to stop mid-way
|
|
||||||
|
|
||||||
If the user says they need to stop, want to pause, or seem disengaged:
|
|
||||||
|
|
||||||
```
|
|
||||||
No problem! Your change is saved at `openspec/changes/<name>/`.
|
|
||||||
|
|
||||||
To pick up where we left off later:
|
|
||||||
- `/opsx:continue <name>` - Resume artifact creation
|
|
||||||
- `/opsx:apply <name>` - Jump to implementation (if tasks exist)
|
|
||||||
|
|
||||||
The work won't be lost. Come back whenever you're ready.
|
|
||||||
```
|
|
||||||
|
|
||||||
Exit gracefully without pressure.
|
|
||||||
|
|
||||||
### User just wants command reference
|
|
||||||
|
|
||||||
If the user says they just want to see the commands or skip the tutorial:
|
|
||||||
|
|
||||||
```
|
|
||||||
## OpenSpec Quick Reference
|
|
||||||
|
|
||||||
| Command | What it does |
|
|
||||||
|---------|--------------|
|
|
||||||
| `/opsx:explore` | Think through problems (no code changes) |
|
|
||||||
| `/opsx:new <name>` | Start a new change, step by step |
|
|
||||||
| `/opsx:ff <name>` | Fast-forward: all artifacts at once |
|
|
||||||
| `/opsx:continue <name>` | Continue an existing change |
|
|
||||||
| `/opsx:apply <name>` | Implement tasks |
|
|
||||||
| `/opsx:verify <name>` | Verify implementation |
|
|
||||||
| `/opsx:archive <name>` | Archive when done |
|
|
||||||
|
|
||||||
Try `/opsx:new` to start your first change, or `/opsx:ff` if you want to move fast.
|
|
||||||
```
|
|
||||||
|
|
||||||
Exit gracefully.
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Guardrails
|
|
||||||
|
|
||||||
- **Follow the EXPLAIN → DO → SHOW → PAUSE pattern** at key transitions (after explore, after proposal draft, after tasks, after archive)
|
|
||||||
- **Keep narration light** during implementation—teach without lecturing
|
|
||||||
- **Don't skip phases** even if the change is small—the goal is teaching the workflow
|
|
||||||
- **Pause for acknowledgment** at marked points, but don't over-pause
|
|
||||||
- **Handle exits gracefully**—never pressure the user to continue
|
|
||||||
- **Use real codebase tasks**—don't simulate or use fake examples
|
|
||||||
- **Adjust scope gently**—guide toward smaller tasks but respect user choice
|
|
||||||
@@ -1,127 +0,0 @@
|
|||||||
Sync delta specs from a change to main specs.
|
|
||||||
|
|
||||||
This is an **agent-driven** operation - you will read delta specs and directly edit main specs to apply the changes. This allows intelligent merging (e.g., adding a scenario without copying the entire requirement).
|
|
||||||
|
|
||||||
**Input**: Optionally specify a change name after `/opsx:sync` (e.g., `/opsx:sync add-auth`). If omitted, check if it can be inferred from conversation context. If vague or ambiguous you MUST prompt for available changes.
|
|
||||||
|
|
||||||
**Steps**
|
|
||||||
|
|
||||||
1. **If no change name provided, prompt for selection**
|
|
||||||
|
|
||||||
Run `openspec list --json` to get available changes. Use the **AskUserQuestion tool** to let the user select.
|
|
||||||
|
|
||||||
Show changes that have delta specs (under `specs/` directory).
|
|
||||||
|
|
||||||
**IMPORTANT**: Do NOT guess or auto-select a change. Always let the user choose.
|
|
||||||
|
|
||||||
2. **Find delta specs**
|
|
||||||
|
|
||||||
Look for delta spec files in `openspec/changes/<name>/specs/*/spec.md`.
|
|
||||||
|
|
||||||
Each delta spec file contains sections like:
|
|
||||||
- `## ADDED Requirements` - New requirements to add
|
|
||||||
- `## MODIFIED Requirements` - Changes to existing requirements
|
|
||||||
- `## REMOVED Requirements` - Requirements to remove
|
|
||||||
- `## RENAMED Requirements` - Requirements to rename (FROM:/TO: format)
|
|
||||||
|
|
||||||
If no delta specs found, inform user and stop.
|
|
||||||
|
|
||||||
3. **For each delta spec, apply changes to main specs**
|
|
||||||
|
|
||||||
For each capability with a delta spec at `openspec/changes/<name>/specs/<capability>/spec.md`:
|
|
||||||
|
|
||||||
a. **Read the delta spec** to understand the intended changes
|
|
||||||
|
|
||||||
b. **Read the main spec** at `openspec/specs/<capability>/spec.md` (may not exist yet)
|
|
||||||
|
|
||||||
c. **Apply changes intelligently**:
|
|
||||||
|
|
||||||
**ADDED Requirements:**
|
|
||||||
- If requirement doesn't exist in main spec → add it
|
|
||||||
- If requirement already exists → update it to match (treat as implicit MODIFIED)
|
|
||||||
|
|
||||||
**MODIFIED Requirements:**
|
|
||||||
- Find the requirement in main spec
|
|
||||||
- Apply the changes - this can be:
|
|
||||||
- Adding new scenarios (don't need to copy existing ones)
|
|
||||||
- Modifying existing scenarios
|
|
||||||
- Changing the requirement description
|
|
||||||
- Preserve scenarios/content not mentioned in the delta
|
|
||||||
|
|
||||||
**REMOVED Requirements:**
|
|
||||||
- Remove the entire requirement block from main spec
|
|
||||||
|
|
||||||
**RENAMED Requirements:**
|
|
||||||
- Find the FROM requirement, rename to TO
|
|
||||||
|
|
||||||
d. **Create new main spec** if capability doesn't exist yet:
|
|
||||||
- Create `openspec/specs/<capability>/spec.md`
|
|
||||||
- Add Purpose section (can be brief, mark as TBD)
|
|
||||||
- Add Requirements section with the ADDED requirements
|
|
||||||
|
|
||||||
4. **Show summary**
|
|
||||||
|
|
||||||
After applying all changes, summarize:
|
|
||||||
- Which capabilities were updated
|
|
||||||
- What changes were made (requirements added/modified/removed/renamed)
|
|
||||||
|
|
||||||
**Delta Spec Format Reference**
|
|
||||||
|
|
||||||
```markdown
|
|
||||||
## ADDED Requirements
|
|
||||||
|
|
||||||
### Requirement: New Feature
|
|
||||||
The system SHALL do something new.
|
|
||||||
|
|
||||||
#### Scenario: Basic case
|
|
||||||
- **WHEN** user does X
|
|
||||||
- **THEN** system does Y
|
|
||||||
|
|
||||||
## MODIFIED Requirements
|
|
||||||
|
|
||||||
### Requirement: Existing Feature
|
|
||||||
#### Scenario: New scenario to add
|
|
||||||
- **WHEN** user does A
|
|
||||||
- **THEN** system does B
|
|
||||||
|
|
||||||
## REMOVED Requirements
|
|
||||||
|
|
||||||
### Requirement: Deprecated Feature
|
|
||||||
|
|
||||||
## RENAMED Requirements
|
|
||||||
|
|
||||||
- FROM: `### Requirement: Old Name`
|
|
||||||
- TO: `### Requirement: New Name`
|
|
||||||
```
|
|
||||||
|
|
||||||
**Key Principle: Intelligent Merging**
|
|
||||||
|
|
||||||
Unlike programmatic merging, you can apply **partial updates**:
|
|
||||||
- To add a scenario, just include that scenario under MODIFIED - don't copy existing scenarios
|
|
||||||
- The delta represents *intent*, not a wholesale replacement
|
|
||||||
- Use your judgment to merge changes sensibly
|
|
||||||
|
|
||||||
**Output On Success**
|
|
||||||
|
|
||||||
```
|
|
||||||
## Specs Synced: <change-name>
|
|
||||||
|
|
||||||
Updated main specs:
|
|
||||||
|
|
||||||
**<capability-1>**:
|
|
||||||
- Added requirement: "New Feature"
|
|
||||||
- Modified requirement: "Existing Feature" (added 1 scenario)
|
|
||||||
|
|
||||||
**<capability-2>**:
|
|
||||||
- Created new spec file
|
|
||||||
- Added requirement: "Another Feature"
|
|
||||||
|
|
||||||
Main specs are now updated. The change remains active - archive when implementation is complete.
|
|
||||||
```
|
|
||||||
|
|
||||||
**Guardrails**
|
|
||||||
- Read both delta and main specs before making changes
|
|
||||||
- Preserve existing content not mentioned in delta
|
|
||||||
- If something is unclear, ask for clarification
|
|
||||||
- Show what you're changing as you go
|
|
||||||
- The operation should be idempotent - running twice should give same result
|
|
||||||
@@ -1,157 +0,0 @@
|
|||||||
Verify that an implementation matches the change artifacts (specs, tasks, design).
|
|
||||||
|
|
||||||
**Input**: Optionally specify a change name after `/opsx:verify` (e.g., `/opsx:verify add-auth`). If omitted, check if it can be inferred from conversation context. If vague or ambiguous you MUST prompt for available changes.
|
|
||||||
|
|
||||||
**Steps**
|
|
||||||
|
|
||||||
1. **If no change name provided, prompt for selection**
|
|
||||||
|
|
||||||
Run `openspec list --json` to get available changes. Use the **AskUserQuestion tool** to let the user select.
|
|
||||||
|
|
||||||
Show changes that have implementation tasks (tasks artifact exists).
|
|
||||||
Include the schema used for each change if available.
|
|
||||||
Mark changes with incomplete tasks as "(In Progress)".
|
|
||||||
|
|
||||||
**IMPORTANT**: Do NOT guess or auto-select a change. Always let the user choose.
|
|
||||||
|
|
||||||
2. **Check status to understand the schema**
|
|
||||||
```bash
|
|
||||||
openspec status --change "<name>" --json
|
|
||||||
```
|
|
||||||
Parse the JSON to understand:
|
|
||||||
- `schemaName`: The workflow being used (e.g., "spec-driven")
|
|
||||||
- Which artifacts exist for this change
|
|
||||||
|
|
||||||
3. **Get the change directory and load artifacts**
|
|
||||||
|
|
||||||
```bash
|
|
||||||
openspec instructions apply --change "<name>" --json
|
|
||||||
```
|
|
||||||
|
|
||||||
This returns the change directory and context files. Read all available artifacts from `contextFiles`.
|
|
||||||
|
|
||||||
4. **Initialize verification report structure**
|
|
||||||
|
|
||||||
Create a report structure with three dimensions:
|
|
||||||
- **Completeness**: Track tasks and spec coverage
|
|
||||||
- **Correctness**: Track requirement implementation and scenario coverage
|
|
||||||
- **Coherence**: Track design adherence and pattern consistency
|
|
||||||
|
|
||||||
Each dimension can have CRITICAL, WARNING, or SUGGESTION issues.
|
|
||||||
|
|
||||||
5. **Verify Completeness**
|
|
||||||
|
|
||||||
**Task Completion**:
|
|
||||||
- If tasks.md exists in contextFiles, read it
|
|
||||||
- Parse checkboxes: `- [ ]` (incomplete) vs `- [x]` (complete)
|
|
||||||
- Count complete vs total tasks
|
|
||||||
- If incomplete tasks exist:
|
|
||||||
- Add CRITICAL issue for each incomplete task
|
|
||||||
- Recommendation: "Complete task: <description>" or "Mark as done if already implemented"
|
|
||||||
|
|
||||||
**Spec Coverage**:
|
|
||||||
- If delta specs exist in `openspec/changes/<name>/specs/`:
|
|
||||||
- Extract all requirements (marked with "### Requirement:")
|
|
||||||
- For each requirement:
|
|
||||||
- Search codebase for keywords related to the requirement
|
|
||||||
- Assess if implementation likely exists
|
|
||||||
- If requirements appear unimplemented:
|
|
||||||
- Add CRITICAL issue: "Requirement not found: <requirement name>"
|
|
||||||
- Recommendation: "Implement requirement X: <description>"
|
|
||||||
|
|
||||||
6. **Verify Correctness**
|
|
||||||
|
|
||||||
**Requirement Implementation Mapping**:
|
|
||||||
- For each requirement from delta specs:
|
|
||||||
- Search codebase for implementation evidence
|
|
||||||
- If found, note file paths and line ranges
|
|
||||||
- Assess if implementation matches requirement intent
|
|
||||||
- If divergence detected:
|
|
||||||
- Add WARNING: "Implementation may diverge from spec: <details>"
|
|
||||||
- Recommendation: "Review <file>:<lines> against requirement X"
|
|
||||||
|
|
||||||
**Scenario Coverage**:
|
|
||||||
- For each scenario in delta specs (marked with "#### Scenario:"):
|
|
||||||
- Check if conditions are handled in code
|
|
||||||
- Check if tests exist covering the scenario
|
|
||||||
- If scenario appears uncovered:
|
|
||||||
- Add WARNING: "Scenario not covered: <scenario name>"
|
|
||||||
- Recommendation: "Add test or implementation for scenario: <description>"
|
|
||||||
|
|
||||||
7. **Verify Coherence**
|
|
||||||
|
|
||||||
**Design Adherence**:
|
|
||||||
- If design.md exists in contextFiles:
|
|
||||||
- Extract key decisions (look for sections like "Decision:", "Approach:", "Architecture:")
|
|
||||||
- Verify implementation follows those decisions
|
|
||||||
- If contradiction detected:
|
|
||||||
- Add WARNING: "Design decision not followed: <decision>"
|
|
||||||
- Recommendation: "Update implementation or revise design.md to match reality"
|
|
||||||
- If no design.md: Skip design adherence check, note "No design.md to verify against"
|
|
||||||
|
|
||||||
**Code Pattern Consistency**:
|
|
||||||
- Review new code for consistency with project patterns
|
|
||||||
- Check file naming, directory structure, coding style
|
|
||||||
- If significant deviations found:
|
|
||||||
- Add SUGGESTION: "Code pattern deviation: <details>"
|
|
||||||
- Recommendation: "Consider following project pattern: <example>"
|
|
||||||
|
|
||||||
8. **Generate Verification Report**
|
|
||||||
|
|
||||||
**Summary Scorecard**:
|
|
||||||
```
|
|
||||||
## Verification Report: <change-name>
|
|
||||||
|
|
||||||
### Summary
|
|
||||||
| Dimension | Status |
|
|
||||||
|--------------|------------------|
|
|
||||||
| Completeness | X/Y tasks, N reqs|
|
|
||||||
| Correctness | M/N reqs covered |
|
|
||||||
| Coherence | Followed/Issues |
|
|
||||||
```
|
|
||||||
|
|
||||||
**Issues by Priority**:
|
|
||||||
|
|
||||||
1. **CRITICAL** (Must fix before archive):
|
|
||||||
- Incomplete tasks
|
|
||||||
- Missing requirement implementations
|
|
||||||
- Each with specific, actionable recommendation
|
|
||||||
|
|
||||||
2. **WARNING** (Should fix):
|
|
||||||
- Spec/design divergences
|
|
||||||
- Missing scenario coverage
|
|
||||||
- Each with specific recommendation
|
|
||||||
|
|
||||||
3. **SUGGESTION** (Nice to fix):
|
|
||||||
- Pattern inconsistencies
|
|
||||||
- Minor improvements
|
|
||||||
- Each with specific recommendation
|
|
||||||
|
|
||||||
**Final Assessment**:
|
|
||||||
- If CRITICAL issues: "X critical issue(s) found. Fix before archiving."
|
|
||||||
- If only warnings: "No critical issues. Y warning(s) to consider. Ready for archive (with noted improvements)."
|
|
||||||
- If all clear: "All checks passed. Ready for archive."
|
|
||||||
|
|
||||||
**Verification Heuristics**
|
|
||||||
|
|
||||||
- **Completeness**: Focus on objective checklist items (checkboxes, requirements list)
|
|
||||||
- **Correctness**: Use keyword search, file path analysis, reasonable inference - don't require perfect certainty
|
|
||||||
- **Coherence**: Look for glaring inconsistencies, don't nitpick style
|
|
||||||
- **False Positives**: When uncertain, prefer SUGGESTION over WARNING, WARNING over CRITICAL
|
|
||||||
- **Actionability**: Every issue must have a specific recommendation with file/line references where applicable
|
|
||||||
|
|
||||||
**Graceful Degradation**
|
|
||||||
|
|
||||||
- If only tasks.md exists: verify task completion only, skip spec/design checks
|
|
||||||
- If tasks + specs exist: verify completeness and correctness, skip design
|
|
||||||
- If full artifacts: verify all three dimensions
|
|
||||||
- Always note which checks were skipped and why
|
|
||||||
|
|
||||||
**Output Format**
|
|
||||||
|
|
||||||
Use clear markdown with:
|
|
||||||
- Table for summary scorecard
|
|
||||||
- Grouped lists for issues (CRITICAL/WARNING/SUGGESTION)
|
|
||||||
- Code references in format: `file.ts:123`
|
|
||||||
- Specific, actionable recommendations
|
|
||||||
- No vague suggestions like "consider reviewing"
|
|
||||||
@@ -0,0 +1,2 @@
|
|||||||
|
schema: spec-driven
|
||||||
|
created: 2026-02-04
|
||||||
234
openspec/changes/archive/2026-02-04-uv-python-runner/design.md
Normal file
234
openspec/changes/archive/2026-02-04-uv-python-runner/design.md
Normal file
@@ -0,0 +1,234 @@
|
|||||||
|
## Context
|
||||||
|
|
||||||
|
当前项目中还没有skill实现，需要创建第一个skill来指导大模型使用uv运行Python脚本。该项目专门用于开发大模型工具技能，所有skill都放在`skills`目录下，每个子目录代表一个skill。
|
||||||
|
|
||||||
|
Python环境管理是一个常见问题：大模型在处理各种任务时经常需要执行Python脚本（数据分析、API测试、文件操作等），传统做法需要在系统Python环境预安装依赖，导致环境污染、版本冲突等问题。
|
||||||
|
|
||||||
|
uv是Astral开发的快速Python包管理器，支持PEP 723内联元数据格式，可以在脚本中声明依赖，并在隔离环境中执行，自动管理虚拟环境和依赖安装。这为解决环境隔离问题提供了标准化的解决方案。
|
||||||
|
|
||||||
|
**约束条件：**
|
||||||
|
- skill文件遵循特定格式：YAML前置元数据 + Markdown内容
|
||||||
|
- skill必须是指导型的，不直接执行代码
|
||||||
|
- 不支持命令行参数或stdin输入
|
||||||
|
- 不支持持久化环境
|
||||||
|
- 严格错误处理模式
|
||||||
|
- 必须支持Windows、macOS、Linux三个平台的临时目录处理
|
||||||
|
|
||||||
|
**利益相关者：**
|
||||||
|
- 大模型：需要清晰的模式指导来生成符合规范的Python脚本
|
||||||
|
- 最终用户：通过大模型获得环境隔离的Python执行能力
|
||||||
|
|
||||||
|
## Goals / Non-Goals
|
||||||
|
|
||||||
|
**Goals:**
|
||||||
|
- 创建指导大模型使用uv执行Python脚本的通用skill
|
||||||
|
- 提供符合PEP 723规范的脚本编写模式
|
||||||
|
- 确保环境隔离，不污染系统Python环境
|
||||||
|
- 严格错误处理，任何错误都停止并给出清晰提示
|
||||||
|
- 临时文件使用系统目录，系统自动清理
|
||||||
|
- 适用于任何Python可处理的任务（数据处理、API交互、文件操作等）
|
||||||
|
- 支持Windows、macOS、Linux跨平台自动适配临时目录
|
||||||
|
|
||||||
|
**Non-Goals:**
|
||||||
|
- 不直接执行用户提供的Python代码（只指导大模型）
|
||||||
|
- 不支持命令行参数传递给脚本
|
||||||
|
- 不支持从stdin读取输入
|
||||||
|
- 不支持持久化虚拟环境（每次都是临时隔离环境）
|
||||||
|
- 不支持自定义Python版本约束（使用uv默认版本）
|
||||||
|
- 不支持复杂的依赖版本约束解析
|
||||||
|
- 不处理动态import语句
|
||||||
|
|
||||||
|
## Decisions
|
||||||
|
|
||||||
|
### Decision 1: 技能定位为指导型而非执行型
|
||||||
|
|
||||||
|
**决策：** skill提供指导模式和最佳实践，不直接执行Python代码。
|
||||||
|
|
||||||
|
**理由：**
|
||||||
|
- skill的主要用户是大模型，而不是最终用户
|
||||||
|
- 大模型需要理解"如何用uv执行"的模式和规范
|
||||||
|
- 保持skill的通用性，可以适应各种任务场景
|
||||||
|
|
||||||
|
**替代方案考虑：**
|
||||||
|
- 执行型skill：直接接收Python代码并执行
|
||||||
|
- ❌ 需要处理更多边界情况（代码注入、安全性等）
|
||||||
|
- ❌ 限制了灵活性（无法指导大模型编写更复杂的脚本）
|
||||||
|
- ❌ 增加了复杂度
|
||||||
|
|
||||||
|
### Decision 2: 使用辅助脚本实现跨平台临时目录
|
||||||
|
|
||||||
|
**决策：** 创建`skills/uv-python-runner/script/get_temp_path.py`辅助脚本，使用Python标准库的`tempfile`模块在系统临时目录中创建空的Python脚本文件，并返回脚本文件路径。**辅助脚本本身也使用uv run执行，保持一致性。**
|
||||||
|
|
||||||
|
**理由：**
|
||||||
|
- `tempfile.gettempdir()`自动适配所有平台（Windows/macOS/Linux）
|
||||||
|
- 避免了大模型需要检测平台和记住不同路径的复杂度
|
||||||
|
- 辅助脚本直接创建临时Python脚本文件，大模型直接得到脚本文件路径
|
||||||
|
- 简化大模型工作流：无需拼接路径，直接使用返回的文件路径写入内容
|
||||||
|
- 使用Python标准库，保证跨平台兼容性
|
||||||
|
- 辅助脚本可以复用，逻辑集中管理
|
||||||
|
- **使用uv run执行辅助脚本，保持skill内所有Python脚本使用统一方式**
|
||||||
|
|
||||||
|
**辅助脚本设计：**
|
||||||
|
- **功能**：在系统临时目录创建空的Python脚本文件，返回文件路径
|
||||||
|
- **无注释**：脚本只包含必要代码，没有文档字符串或注释
|
||||||
|
- **PEP 723格式**：包含空的依赖声明`# dependencies = []`
|
||||||
|
- **执行方式**：`uv run skills/uv-python-runner/script/get_temp_path.py`
|
||||||
|
- **输出**：直接在stdout输出临时Python脚本文件的完整路径
|
||||||
|
- Linux/macOS: `/tmp/uv_script_xxx.py`
|
||||||
|
- Windows: `C:\Users\<username>\AppData\Local\Temp\uv_script_xxx.py`
|
||||||
|
|
||||||
|
**大模型使用流程：**
|
||||||
|
1. 调用辅助脚本获取临时脚本文件路径（使用相对路径`./script/get_temp_path.py`，相对于SKILL.md所在目录）
|
||||||
|
```bash
|
||||||
|
temp_file_path=$(uv run ./script/get_temp_path.py)
|
||||||
|
```
|
||||||
|
2. 在返回的脚本文件路径中直接写入PEP 723脚本内容：
|
||||||
|
```python
|
||||||
|
# 使用大模型的Write工具
|
||||||
|
with open(temp_file_path, 'w') as f:
|
||||||
|
f.write(script_content)
|
||||||
|
```
|
||||||
|
3. 使用`uv run`执行脚本：
|
||||||
|
```bash
|
||||||
|
uv run $temp_file_path
|
||||||
|
```
|
||||||
|
4. 系统自动清理临时文件，无需手动管理
|
||||||
|
|
||||||
|
**替代方案考虑：**
|
||||||
|
- 在辅助脚本中导出函数供导入：
|
||||||
|
- ❌ 需要大模型导入模块并调用函数，增加了复杂度
|
||||||
|
- ❌ 辅助脚本需要更多代码（函数定义、文档等）
|
||||||
|
- ❌ 不符合"简单直接"的设计原则
|
||||||
|
- 在skill文档中说明平台差异：
|
||||||
|
- ❌ 大模型需要检测平台，容易出错
|
||||||
|
- ❌ 文档冗长，增加了复杂度
|
||||||
|
- ❌ 不符合"简化使用模式"的设计目标
|
||||||
|
|
||||||
|
### Decision 3: 依赖声明使用无版本约束的包名
|
||||||
|
|
||||||
|
**决策：** 在PEP 723元数据块中只声明包名，不指定版本约束，让uv自动选择兼容的最新版本。
|
||||||
|
|
||||||
|
**理由：**
|
||||||
|
- 简化依赖声明，降低大模型的认知负担
|
||||||
|
- uv的依赖解析器会自动选择兼容版本
|
||||||
|
- 使用最新版本通常更安全（包含安全修复）
|
||||||
|
- 避免版本固定带来的兼容性问题
|
||||||
|
|
||||||
|
**替代方案考虑：**
|
||||||
|
- 固定版本号（如`pandas==2.1.0`）：
|
||||||
|
- ❌ 需要大模型了解每个包的最新版本
|
||||||
|
- ❌ 版本过时可能引入安全漏洞
|
||||||
|
- ❌ 可能与其他包产生版本冲突
|
||||||
|
- ❌ 增加维护成本
|
||||||
|
|
||||||
|
### Decision 4: 严格错误处理模式
|
||||||
|
|
||||||
|
**决策：** 任何错误条件都停止任务并显示清晰错误消息。错误类型包括：uv未安装、Python语法错误、依赖解析失败、脚本运行时错误。
|
||||||
|
|
||||||
|
**理由：**
|
||||||
|
- 严格模式符合skill作为工具的定位（可靠、可预测）
|
||||||
|
- 避免错误传播导致难以调试的问题
|
||||||
|
- 清晰的错误消息帮助大模型和用户快速定位问题
|
||||||
|
- 保留失败的临时文件便于调试
|
||||||
|
|
||||||
|
**替代方案考虑：**
|
||||||
|
- 宽松模式（跳过错误包继续执行）：
|
||||||
|
- ❌ 可能导致部分依赖缺失的脚本执行
|
||||||
|
- ❌ 错误难以定位和调试
|
||||||
|
- ❌ 不符合"可靠工具"的设计目标
|
||||||
|
|
||||||
|
### Decision 5: 无外部输入支持
|
||||||
|
|
||||||
|
**决策：** 所有输入、参数和数据源都嵌入在Python脚本内部。不支持命令行参数和stdin输入。
|
||||||
|
|
||||||
|
**理由：**
|
||||||
|
- 简化skill的使用模型
|
||||||
|
- 符合大模型生成脚本的使用模式（大模型知道所有参数）
|
||||||
|
- 避免参数传递的复杂度和安全风险
|
||||||
|
- 保持脚本的完整性和可移植性
|
||||||
|
|
||||||
|
**替代方案考虑：**
|
||||||
|
- 支持命令行参数：
|
||||||
|
- ❌ 增加skill复杂度（需要参数传递机制）
|
||||||
|
- ❌ 脚本可能依赖外部输入而不可移植
|
||||||
|
- ❌ 不符合"所有逻辑嵌入脚本"的设计目标
|
||||||
|
|
||||||
|
### Decision 6: 通用任务适用性
|
||||||
|
|
||||||
|
**决策：** skill不限制在特定领域，适用于任何Python可处理的任务。在文档中提供常见用例示例（数据分析、API交互、文件操作等），但不硬编码限制。
|
||||||
|
|
||||||
|
**理由：**
|
||||||
|
- 最大化skill的复用性
|
||||||
|
- Python的适用范围很广，不应预先限制
|
||||||
|
- 通过示例而非硬编码来引导使用
|
||||||
|
|
||||||
|
**替代方案考虑：**
|
||||||
|
- 针对特定领域（如只支持数据分析）：
|
||||||
|
- ❌ 限制了skill的通用性
|
||||||
|
- ❌ 可能需要多个类似skill覆盖不同场景
|
||||||
|
- ❌ 违反"通用工具"的设计目标
|
||||||
|
|
||||||
|
## Risks / Trade-offs
|
||||||
|
|
||||||
|
### Risk 1: uv依赖外部可用性
|
||||||
|
|
||||||
|
**风险：** 技能依赖uv包管理器，如果系统未安装uv，skill无法工作。
|
||||||
|
|
||||||
|
**缓解措施：**
|
||||||
|
- 错误消息中提供清晰的uv安装链接
|
||||||
|
- 在skill文档中明确说明uv是必需依赖
|
||||||
|
- 提供uv安装指南（https://docs.astral.sh/uv/getting-started/installation/）
|
||||||
|
|
||||||
|
### Risk 2: 临时文件
|
||||||
|
|
||||||
|
**风险：** 临时文件存储在系统临时目录（/tmp 或 Windows Temp），磁盘空间占用。
|
||||||
|
|
||||||
|
**缓解措施：**
|
||||||
|
- 临时文件使用系统标准临时目录，系统会自动定期清理
|
||||||
|
- 文件名包含时间戳，便于识别
|
||||||
|
- 在失败时显示文件路径，方便用户手动删除
|
||||||
|
|
||||||
|
### Risk 3: 依赖解析时间
|
||||||
|
|
||||||
|
**风险：** 首次执行某个脚本时，uv需要下载和安装依赖，可能需要较长时间，影响用户体验。
|
||||||
|
|
||||||
|
**缓解措施：**
|
||||||
|
- 在文档中说明首次执行可能较慢
|
||||||
|
- uv的依赖解析和安装速度很快（比传统pip快10-100倍）
|
||||||
|
- 使用最新版本通常减少兼容性问题，加快解析速度
|
||||||
|
|
||||||
|
### Risk 4: PyPI包可用性
|
||||||
|
|
||||||
|
**风险：** 如果声明的依赖包在PyPI上不存在或名称错误，依赖解析会失败。
|
||||||
|
|
||||||
|
**缓解措施：**
|
||||||
|
- 严格错误处理模式会显示uv的完整错误输出
|
||||||
|
- 大模型在编写脚本时已经知道依赖的包名
|
||||||
|
- 保留失败的临时文件便于检查依赖声明
|
||||||
|
|
||||||
|
### Risk 5: 大模型理解复杂度
|
||||||
|
|
||||||
|
**风险：** PEP 723元数据格式对大模型来说可能不熟悉，可能生成不符合规范的脚本。
|
||||||
|
|
||||||
|
**缓解措施：**
|
||||||
|
- skill文档提供清晰的示例和模板
|
||||||
|
- 严格错误处理会在语法或格式错误时立即停止并提示
|
||||||
|
- 文档中说明常见的格式错误和修正方法
|
||||||
|
|
||||||
|
## Migration Plan
|
||||||
|
|
||||||
|
这是新skill的首次实现，不存在迁移问题。
|
||||||
|
|
||||||
|
**部署步骤：**
|
||||||
|
1. 创建skill目录：`skills/uv-python-runner/`
|
||||||
|
2. 创建skill文件：`skills/uv-python-runner/SKILL.md`
|
||||||
|
3. 编写skill内容（YAML元数据 + Markdown文档）
|
||||||
|
4. 测试skill是否可以被正确加载和触发
|
||||||
|
|
||||||
|
**回滚策略：**
|
||||||
|
- 如有问题，直接删除`skills/uv-python-runner/`目录即可
|
||||||
|
- skill文件不影响系统或现有代码
|
||||||
|
|
||||||
|
## Open Questions
|
||||||
|
|
||||||
|
无。所有设计决策已在上述章节明确说明。
|
||||||
@@ -0,0 +1,41 @@
|
|||||||
|
## Why
|
||||||
|
|
||||||
|
大模型在处理任务时经常需要执行Python脚本（数据分析、API测试、文件处理等），传统的做法需要在系统Python环境中预安装依赖包，这会导致：
|
||||||
|
- 环境污染：不同任务的依赖可能冲突
|
||||||
|
- 版本混乱：无法确保依赖版本一致性
|
||||||
|
- 系统依赖：必须在操作系统级别安装所有可能的包
|
||||||
|
|
||||||
|
使用uv的PEP 723内联元数据格式，可以让每个脚本自带依赖声明，并在隔离环境中执行，从根本上解决这些问题。
|
||||||
|
|
||||||
|
## What Changes
|
||||||
|
|
||||||
|
- 创建新的skill：`uv-python-runner`
|
||||||
|
- 指导大模型按照PEP 723规范编写Python脚本
|
||||||
|
- 提供临时文件创建和uv run执行的标准流程
|
||||||
|
- 严格错误处理模式
|
||||||
|
- 临时文件使用系统目录，系统自动清理
|
||||||
|
|
||||||
|
- 技能特性：
|
||||||
|
- 通用型工具，适用于任何Python可处理的任务
|
||||||
|
- 无需预安装依赖，uv自动管理隔离环境
|
||||||
|
- 使用临时文件，系统自动清理
|
||||||
|
- 简单返回值（stdout/stderr）
|
||||||
|
- 不支持命令行参数或stdin输入
|
||||||
|
|
||||||
|
## Capabilities
|
||||||
|
|
||||||
|
### New Capabilities
|
||||||
|
|
||||||
|
- `uv-python-runner`: 通用Python脚本执行工具，指导大模型使用uv的隔离环境特性来执行临时Python脚本，无需在系统环境预安装依赖。适用于数据处理、API交互、文件操作、科学计算等各种任务。
|
||||||
|
|
||||||
|
### Modified Capabilities
|
||||||
|
|
||||||
|
无
|
||||||
|
|
||||||
|
## Impact
|
||||||
|
|
||||||
|
- **代码影响**：新增skill文件 `skills/uv-python-runner/SKILL.md`
|
||||||
|
- **依赖影响**：要求系统安装uv（https://docs.astral.sh/uv/）
|
||||||
|
- **系统影响**：无（skill只提供指导，不直接修改系统）
|
||||||
|
- **API影响**：无
|
||||||
|
- **用户影响**：大模型在需要执行Python脚本时，会使用此skill生成符合PEP 723规范的代码并使用uv执行，提升环境隔离和依赖管理的可靠性
|
||||||
@@ -0,0 +1,119 @@
|
|||||||
|
## 新增需求
|
||||||
|
|
||||||
|
### 需求：生成符合PEP 723规范的Python脚本
|
||||||
|
|
||||||
|
Skill SHALL指导LLM生成符合PEP 723内联元数据规范的Python脚本。脚本SHALL在顶部包含`# /// script`块，使用`dependencies`字段声明所有外部依赖。依赖SHALL使用不带版本约束的包名，允许uv选择兼容的最新版本。没有依赖的脚本SHALL声明空的依赖列表。
|
||||||
|
|
||||||
|
#### 场景：包含外部依赖的脚本
|
||||||
|
- **WHEN** LLM需要执行需要外部包的Python代码（例如：pandas、requests、numpy）
|
||||||
|
- **THEN** skill SHALL指导LLM包含列出所有必需包的PEP 723元数据块
|
||||||
|
- **THEN** 依赖列表SHALL只包含包名，不带版本约束
|
||||||
|
- **THEN** 脚本SHALL是有效的Python代码，顶部包含元数据块
|
||||||
|
|
||||||
|
#### 场景：仅使用标准库的脚本
|
||||||
|
- **WHEN** LLM需要执行只使用标准库模块的Python代码
|
||||||
|
- **THEN** skill SHALL指导LLM包含空依赖的PEP 723元数据块：`# dependencies = []`
|
||||||
|
- **THEN** 脚本SHALL是有效的Python代码，顶部包含元数据块
|
||||||
|
|
||||||
|
### 需求：在隔离的uv环境中执行脚本
|
||||||
|
|
||||||
|
Skill SHALL指导LLM在系统临时目录中创建临时Python文件，并使用`uv run`命令执行它们。临时文件SHALL使用包含时间戳和随机标识符的唯一名称创建。Skill SHALL确保所有脚本参数和逻辑都嵌入在脚本本身中，没有命令行参数或stdin输入。
|
||||||
|
|
||||||
|
#### 场景：成功执行脚本
|
||||||
|
- **WHEN** LLM生成符合PEP 723的有效Python脚本
|
||||||
|
- **THEN** skill SHALL指导LLM在`/tmp/uv_script_<timestamp>_<random>.py`创建临时文件
|
||||||
|
- **THEN** skill SHALL指导LLM使用`uv run /tmp/uv_script_XXX.py`执行脚本
|
||||||
|
- **THEN** uv SHALL自动创建隔离的虚拟环境，安装依赖，并执行脚本
|
||||||
|
- **THEN** skill SHALL捕获并返回stdout/stderr输出
|
||||||
|
- **THEN** 临时文件使用系统目录，系统自动清理
|
||||||
|
|
||||||
|
#### 场景：脚本执行失败
|
||||||
|
- **WHEN** 脚本执行失败（运行时错误、依赖解析失败等）
|
||||||
|
- **THEN** skill SHALL保留临时文件用于调试
|
||||||
|
- **THEN** skill SHALL显示包含traceback的完整错误消息
|
||||||
|
- **THEN** skill SHALL显示保留的临时文件路径
|
||||||
|
- **THEN** skill SHALL停止任务（严格错误处理模式）
|
||||||
|
|
||||||
|
### 需求：跨平台临时目录支持
|
||||||
|
|
||||||
|
Skill SHALL使用`skills/uv-python-runner/script/get_temp_path.py`辅助脚本来获取平台特定的临时目录。Skill SHALL在创建临时Python文件之前，先调用此辅助脚本获取临时目录路径。Skill SHALL支持Windows、macOS、Linux三个平台。
|
||||||
|
|
||||||
|
#### 场景：获取临时目录路径
|
||||||
|
- **WHEN** LLM需要为Python脚本创建临时文件
|
||||||
|
- **THEN** skill SHALL指导LLM先调用辅助脚本获取临时目录
|
||||||
|
- **THEN** skill SHALL指导LLM导入并使用`get_temp_dir()`函数
|
||||||
|
- **THEN** skill SHALL指导LLM使用`get_temp_file_path()`函数生成唯一文件路径（可选）
|
||||||
|
- **THEN** 辅助脚本SHALL使用`tempfile.gettempdir()`自动返回平台特定的路径
|
||||||
|
|
||||||
|
#### 场景：Windows平台
|
||||||
|
- **WHEN** 辅助脚本在Windows平台运行
|
||||||
|
- **THEN** skill SHALL指导LLM调用辅助脚本会返回Windows临时目录（例如：`C:\Users\<username>\AppData\Local\Temp`）
|
||||||
|
- **THEN** skill SHALL确保大模型不需要检测或硬编码Windows路径
|
||||||
|
|
||||||
|
#### 场景：macOS/Linux平台
|
||||||
|
- **WHEN** 辅助脚本在macOS或Linux平台运行
|
||||||
|
- **THEN** skill SHALL指导LLM调用辅助脚本会返回`/tmp`路径
|
||||||
|
- **THEN** skill SHALL确保大模型不需要检测或硬编码Unix路径
|
||||||
|
|
||||||
|
### 需求：严格错误处理
|
||||||
|
|
||||||
|
Skill SHALL强制执行严格错误处理模式。任何错误条件SHALL导致任务停止并显示清晰错误消息。错误条件SHALL包括：uv未安装、生成的脚本中的Python语法错误、uv的依赖解析失败、以及脚本运行时错误。
|
||||||
|
|
||||||
|
#### 场景：uv未安装
|
||||||
|
- **WHEN** LLM尝试执行脚本但系统中未找到uv命令
|
||||||
|
- **THEN** skill SHALL显示清晰错误消息："uv not found"
|
||||||
|
- **THEN** skill SHALL提供uv安装链接：https://docs.astral.sh/uv/getting-started/installation/
|
||||||
|
- **THEN** skill SHALL停止任务
|
||||||
|
|
||||||
|
#### 场景：Python语法错误
|
||||||
|
- **WHEN** LLM生成包含语法错误的Python代码
|
||||||
|
- **THEN** skill SHALL在创建临时文件之前检测语法错误
|
||||||
|
- **THEN** skill SHALL显示包含行号和Python错误描述的错误消息
|
||||||
|
- **THEN** skill SHALL停止任务而不创建临时文件
|
||||||
|
|
||||||
|
#### 场景：依赖解析失败
|
||||||
|
- **WHEN** uv无法解析或安装声明的依赖
|
||||||
|
- **THEN** skill SHALL显示完整的uv错误输出
|
||||||
|
- **THEN** skill SHALL显示临时文件路径，用户可手动删除调试
|
||||||
|
- **THEN** skill SHALL停止任务
|
||||||
|
|
||||||
|
#### 场景：脚本运行时错误
|
||||||
|
- **WHEN** Python脚本执行但在运行时抛出异常
|
||||||
|
- **THEN** skill SHALL显示完整的Python traceback
|
||||||
|
- **THEN** skill SHALL显示临时文件路径，用户可手动删除调试
|
||||||
|
- **THEN** skill SHALL停止任务
|
||||||
|
|
||||||
|
### 需求：无外部输入或参数
|
||||||
|
|
||||||
|
Skill SHALL要求所有输入、参数和数据源都直接嵌入在Python脚本中。Skill SHALL不支持传递给脚本的命令行参数。Skill SHALL不支持从stdin读取输入。所有必要的数据SHALL硬编码或从脚本引用的文件中读取。
|
||||||
|
|
||||||
|
#### 场景：数据处理任务
|
||||||
|
- **WHEN** LLM需要处理数据（例如：CSV文件分析）
|
||||||
|
- **THEN** skill SHALL指导LLM将文件路径作为字符串字面量包含在脚本中
|
||||||
|
- **THEN** skill SHALL不接受文件路径或参数的外部命令行参数
|
||||||
|
- **THEN** 所有数据处理逻辑SHALL嵌入在脚本中
|
||||||
|
|
||||||
|
#### 场景：API交互任务
|
||||||
|
- **WHEN** LLM需要与API交互（例如：对特定URL的GET请求）
|
||||||
|
- **THEN** skill SHALL指导LLM将URL和参数作为字符串字面量包含在脚本中
|
||||||
|
- **THEN** skill SHALL不接受作为命令行参数的API端点或身份验证令牌
|
||||||
|
- **THEN** 所有API交互逻辑SHALL嵌入在脚本中
|
||||||
|
|
||||||
|
### 需求：通用任务适用性
|
||||||
|
|
||||||
|
Skill SHALL适用于任何可以用Python脚本完成的任务。Skill SHALL不限于特定领域，但SHALL为常见用例提供指导，包括数据处理（pandas、numpy）、API交互（requests、httpx）、文件操作（pathlib、shutil）、科学计算（scipy、sympy）和数据转换（json、yaml、csv）。
|
||||||
|
|
||||||
|
#### 场景：数据分析任务
|
||||||
|
- **WHEN** 用户请求数据分析或统计计算
|
||||||
|
- **THEN** skill SHALL提供生成具有适当依赖（例如：pandas）的脚本的指导
|
||||||
|
- **THEN** skill SHALL不基于任务领域进行限制或过滤
|
||||||
|
|
||||||
|
#### 场景：文件操作任务
|
||||||
|
- **WHEN** 用户请求文件操作（重命名、转换、格式化）
|
||||||
|
- **THEN** skill SHALL提供生成具有适当标准库或外部模块的脚本的指导
|
||||||
|
- **THEN** skill SHALL不基于任务领域进行限制或过滤
|
||||||
|
|
||||||
|
#### 场景：API测试任务
|
||||||
|
- **WHEN** 用户请求API测试或数据检索
|
||||||
|
- **THEN** skill SHALL提供生成具有适当HTTP客户端库的脚本的指导
|
||||||
|
- **THEN** skill SHALL不基于任务领域进行限制或过滤
|
||||||
@@ -0,0 +1,99 @@
|
|||||||
|
## 1. Skill结构设置
|
||||||
|
|
||||||
|
- [x] 1.1 创建skill目录：`skills/uv-python-runner/`
|
||||||
|
- [x] 1.2 创建script子目录：`skills/uv-python-runner/script/`
|
||||||
|
- [x] 1.3 创建辅助脚本：`skills/uv-python-runner/script/get_temp_path.py`
|
||||||
|
- [x] 1.3.1 添加PEP 723元数据块（`# dependencies = []`）
|
||||||
|
- [x] 1.3.2 在系统临时目录创建空的Python脚本文件并返回路径
|
||||||
|
- [x] 1.3.3 直接在stdout输出脚本文件完整路径
|
||||||
|
- [x] 1.3.4 添加命令行支持，直接运行脚本
|
||||||
|
- [x] 1.4 创建skill文件：`skills/uv-python-runner/SKILL.md`
|
||||||
|
|
||||||
|
## 2. 编写YAML前置元数据
|
||||||
|
|
||||||
|
- [x] 2.1 添加skill名称：`uv-python-runner`
|
||||||
|
- [x] 2.2 添加英文skill描述
|
||||||
|
- [x] 2.3 添加参数提示（不适用，此skill无参数）
|
||||||
|
|
||||||
|
## 3. 编写Skill内容 - 概览
|
||||||
|
|
||||||
|
- [x] 3.1 编写skill目的和定位
|
||||||
|
- [x] 3.2 说明为什么uv是有益的（环境隔离、依赖管理）
|
||||||
|
- [x] 3.3 列出何时使用此skill
|
||||||
|
|
||||||
|
## 4. 编写Skill内容 - 何时使用章节
|
||||||
|
|
||||||
|
- [x] 4.1 记录典型用例（数据处理、API交互、文件操作等）
|
||||||
|
- [x] 4.2 记录此skill不适用的场景（交互式输入、持久化环境等）
|
||||||
|
|
||||||
|
## 5. 编写Skill内容 - 工作流程章节
|
||||||
|
|
||||||
|
- [x] 5.1 记录步骤1：生成符合PEP 723的Python脚本
|
||||||
|
- [x] 5.1.1 说明元数据块格式
|
||||||
|
- [x] 5.1.2 提供包含外部依赖的示例
|
||||||
|
- [x] 5.1.3 提供仅使用标准库的示例
|
||||||
|
- [x] 5.2 记录步骤2：获取临时目录
|
||||||
|
- [x] 5.2.1 说明调用辅助脚本：`uv run skills/uv-python-runner/script/get_temp_path.py`
|
||||||
|
- [x] 5.2.2 说明辅助脚本直接在stdout输出临时目录路径
|
||||||
|
- [x] 5.2.3 说明大模型捕获stdout输出得到临时目录
|
||||||
|
- [x] 5.2.4 说明根据临时目录构造脚本文件路径：`<temp_dir>/uv_script_<timestamp>_<random>.py`
|
||||||
|
- [x] 5.2.5 提供简化的工作流示例
|
||||||
|
- [x] 5.3 记录步骤3：使用uv执行
|
||||||
|
- [x] 5.3.1 说明`uv run`命令的用法
|
||||||
|
- [x] 5.3.2 描述uv自动做什么（隔离、依赖安装）
|
||||||
|
|
||||||
|
## 6. 编写Skill内容 - 错误处理章节
|
||||||
|
|
||||||
|
- [x] 6.1 记录uv未安装场景
|
||||||
|
- [x] 6.1.1 提供清晰错误消息
|
||||||
|
- [x] 6.1.2 包含uv安装链接
|
||||||
|
- [x] 6.2 记录Python语法错误场景
|
||||||
|
- [x] 6.2.1 说明文件创建前的检测
|
||||||
|
- [x] 6.2.2 提供错误消息格式
|
||||||
|
- [x] 6.3 记录依赖解析失败场景
|
||||||
|
- [x] 6.3.1 说明显示uv错误输出
|
||||||
|
- [x] 6.3.2 说明文件保留
|
||||||
|
- [x] 6.4 记录脚本运行时错误场景
|
||||||
|
- [x] 6.4.1 说明显示完整traceback
|
||||||
|
- [x] 6.4.2 说明文件保留和路径显示
|
||||||
|
|
||||||
|
## 7. 编写Skill内容 - 示例章节
|
||||||
|
|
||||||
|
- [x] 7.1 提供示例1：数据分析（pandas）
|
||||||
|
- [x] 7.1.1 显示完整的PEP 723脚本
|
||||||
|
- [x] 7.1.2 说明场景
|
||||||
|
- [x] 7.2 提供示例2：API交互（requests）
|
||||||
|
- [x] 7.2.1 显示完整的PEP 723脚本
|
||||||
|
- [x] 7.2.2 说明场景
|
||||||
|
- [x] 7.3 提供示例3：文件操作（标准库）
|
||||||
|
- [x] 7.3.1 显示完整的PEP 723脚本
|
||||||
|
- [x] 7.3.2 说明场景
|
||||||
|
|
||||||
|
## 8. 编写Skill内容 - 注意事项章节
|
||||||
|
|
||||||
|
- [x] 8.1 创建"为什么使用uv？"对比表
|
||||||
|
- [x] 8.2 记录最佳实践
|
||||||
|
- [x] 8.2.1 总是使用内联元数据
|
||||||
|
- [x] 8.2.2 使用最新版本
|
||||||
|
- [x] 8.2.3 错误处理指南
|
||||||
|
- [x] 8.3 记录限制
|
||||||
|
- [x] 8.3.1 无命令行参数
|
||||||
|
- [x] 8.3.2 无stdin输入
|
||||||
|
- [x] 8.3.3 无持久化环境
|
||||||
|
- [x] 8.3.4 无自定义Python版本
|
||||||
|
- [x] 8.3.5 无复杂依赖约束
|
||||||
|
|
||||||
|
## 9. 编写Skill内容 - 依赖章节
|
||||||
|
|
||||||
|
- [x] 9.1 列出必需依赖：uv
|
||||||
|
- [x] 9.2 包含uv文档链接
|
||||||
|
- [x] 9.3 标记可选依赖（此skill无）
|
||||||
|
|
||||||
|
## 10. 验证和测试
|
||||||
|
|
||||||
|
- [x] 10.1 验证YAML前置元数据格式有效
|
||||||
|
- [x] 10.2 检查所有Markdown章节格式正确
|
||||||
|
- [x] 10.3 确保所有示例在语法上是正确的Python
|
||||||
|
- [x] 10.4 验证所有PEP 723元数据块符合规范
|
||||||
|
- [x] 10.5 确认所有链接（uv安装）正确
|
||||||
|
- [x] 10.6 审查skill内容的清晰性和完整性
|
||||||
@@ -1,10 +1,6 @@
|
|||||||
schema: spec-driven
|
schema: spec-driven
|
||||||
|
|
||||||
# Project context (optional)
|
context: |
|
||||||
# This is shown to AI when creating artifacts.
|
忽略项目目录下的「.opencode」和「opencode」两个目录，与开发的skill无关；
|
||||||
# Add your tech stack, conventions, style guides, domain knowledge, etc.
|
这个项目是专门用于开发用于大模型工具的 skill；
|
||||||
# Example:
|
所有开发的 skill 都放在「skills」目录下，每个子目录都代表一个 skill，目录名为 skill 的名称；
|
||||||
# context: |
|
|
||||||
# Tech stack: TypeScript, React, Node.js
|
|
||||||
# We use conventional commits
|
|
||||||
# Domain: e-commerce platform
|
|
||||||
|
|||||||
372
skills/uv-python-runner/SKILL.md
Normal file
372
skills/uv-python-runner/SKILL.md
Normal file
@@ -0,0 +1,372 @@
|
|||||||
|
---
|
||||||
|
name: uv-python-runner
|
||||||
|
description: Any task that want to execute python scripts to solute.
|
||||||
|
---
|
||||||
|
|
||||||
|
# UV Python Runner Skill
|
||||||
|
|
||||||
|
通用型工具skill，指导大模型使用uv运行Python脚本来处理各种任务，无需预安装依赖，保持系统环境整洁。
|
||||||
|
|
||||||
|
## Purpose
|
||||||
|
|
||||||
|
指导大模型在需要执行Python脚本时，利用uv的隔离环境特性来：
|
||||||
|
|
||||||
|
- 自动管理虚拟环境和依赖
|
||||||
|
- 避免在系统Python环境安装依赖包
|
||||||
|
- 使用临时文件，执行完成后立即清理
|
||||||
|
- 保持跨平台兼容性（Windows/macOS/Linux）
|
||||||
|
|
||||||
|
## When to Use
|
||||||
|
|
||||||
|
大模型**任何需要用Python处理的任务**都应该使用此skill。
|
||||||
|
|
||||||
|
### 典型场景
|
||||||
|
|
||||||
|
**数据处理**
|
||||||
|
|
||||||
|
- pandas, numpy, scipy等数据分析
|
||||||
|
- CSV, JSON, YAML文件转换和处理
|
||||||
|
- 数据清洗、统计分析、可视化
|
||||||
|
|
||||||
|
**API交互**
|
||||||
|
|
||||||
|
- HTTP请求和测试（requests, httpx, aiohttp）
|
||||||
|
- API数据检索和验证
|
||||||
|
- 身份验证和会话管理
|
||||||
|
|
||||||
|
**文件操作**
|
||||||
|
|
||||||
|
- 文件重命名、批量处理
|
||||||
|
- 路径操作（pathlib, shutil, os）
|
||||||
|
- 文件格式转换、内容替换
|
||||||
|
|
||||||
|
**科学计算**
|
||||||
|
|
||||||
|
- 数学计算（numpy, scipy）
|
||||||
|
- 符号计算（sympy）
|
||||||
|
- 数据可视化（matplotlib, plotly）
|
||||||
|
|
||||||
|
**系统工具**
|
||||||
|
|
||||||
|
- 日志处理（logging）
|
||||||
|
- 配置管理（configparser）
|
||||||
|
- 进度跟踪（tqdm, rich）
|
||||||
|
|
||||||
|
### 不适用场景
|
||||||
|
|
||||||
|
- ✗ 需要用户交互的脚本（input(), input()等）
|
||||||
|
- ✗ 需要持久化环境（每次都是新的隔离环境）
|
||||||
|
- ✗ 需要传递命令行参数（所有参数嵌入脚本）
|
||||||
|
- ✗ 需要从stdin读取输入
|
||||||
|
|
||||||
|
## Workflow
|
||||||
|
|
||||||
|
### 步骤1：生成符合PEP 723的Python脚本
|
||||||
|
|
||||||
|
在脚本顶部添加内联元数据块：
|
||||||
|
|
||||||
|
```python
|
||||||
|
# /// script
|
||||||
|
# dependencies = [
|
||||||
|
# "package-name-1",
|
||||||
|
# "package-name-2",
|
||||||
|
# ]
|
||||||
|
# ///
|
||||||
|
|
||||||
|
import package1
|
||||||
|
import package2
|
||||||
|
|
||||||
|
# 你的代码...
|
||||||
|
```
|
||||||
|
|
||||||
|
**规则：**
|
||||||
|
|
||||||
|
- ✓ 总是包含`# /// script`块
|
||||||
|
- ✓ 列出所有**外部**依赖
|
||||||
|
- ✓ 如果没有依赖：`# dependencies = []`
|
||||||
|
- ✓ 不指定版本（让uv使用最新）
|
||||||
|
- ✓ 不指定Python版本（使用uv默认）
|
||||||
|
|
||||||
|
**示例：**
|
||||||
|
|
||||||
|
有外部依赖：
|
||||||
|
|
||||||
|
```python
|
||||||
|
# /// script
|
||||||
|
# dependencies = [
|
||||||
|
# "pandas",
|
||||||
|
# "numpy",
|
||||||
|
# ]
|
||||||
|
# ///
|
||||||
|
|
||||||
|
import pandas as pd
|
||||||
|
import numpy as np
|
||||||
|
|
||||||
|
data = pd.read_csv('data.csv')
|
||||||
|
print(data.describe())
|
||||||
|
```
|
||||||
|
|
||||||
|
仅使用标准库：
|
||||||
|
|
||||||
|
```python
|
||||||
|
# /// script
|
||||||
|
# dependencies = []
|
||||||
|
# ///
|
||||||
|
|
||||||
|
import os
|
||||||
|
import json
|
||||||
|
|
||||||
|
with open('data.json') as f:
|
||||||
|
data = json.load(f)
|
||||||
|
print(f"Keys: {list(data.keys())}")
|
||||||
|
```
|
||||||
|
|
||||||
|
### 步骤2：获取临时脚本文件路径
|
||||||
|
|
||||||
|
调用辅助脚本创建临时Python脚本文件并获取文件路径（使用相对路径）：
|
||||||
|
|
||||||
|
```bash
|
||||||
|
temp_file_path=$(uv run ./script/get_temp_path.py)
|
||||||
|
```
|
||||||
|
|
||||||
|
**输出：**
|
||||||
|
|
||||||
|
- 临时Python脚本文件的完整路径
|
||||||
|
- Linux/macOS: `/tmp/uv_script_xxx.py`
|
||||||
|
- Windows: `C:\Users\<username>\AppData\Local\Temp\uv_script_xxx.py`
|
||||||
|
|
||||||
|
**说明：**
|
||||||
|
|
||||||
|
- 辅助脚本已在临时目录创建了空的Python脚本文件
|
||||||
|
- 大模型直接得到脚本文件路径
|
||||||
|
- 无需拼接路径，直接使用返回的文件路径
|
||||||
|
|
||||||
|
### 步骤3：写入PEP 723脚本内容
|
||||||
|
|
||||||
|
使用大模型的文件创建工具（Write等）在步骤2返回的脚本文件路径中写入PEP 723脚本内容。
|
||||||
|
|
||||||
|
### 步骤4：使用uv执行
|
||||||
|
|
||||||
|
```bash
|
||||||
|
uv run <temp_file_path>
|
||||||
|
```
|
||||||
|
|
||||||
|
## Error Handling
|
||||||
|
|
||||||
|
### 场景1：uv未安装
|
||||||
|
|
||||||
|
**错误消息：**
|
||||||
|
|
||||||
|
```
|
||||||
|
uv not found
|
||||||
|
|
||||||
|
无法找到uv命令。请先安装uv：
|
||||||
|
https://docs.astral.sh/uv/getting-started/installation/
|
||||||
|
```
|
||||||
|
|
||||||
|
**操作：** 停止任务
|
||||||
|
|
||||||
|
### 场景2：Python语法错误
|
||||||
|
|
||||||
|
**检测：** 在创建临时文件之前检测语法错误
|
||||||
|
|
||||||
|
**错误消息：**
|
||||||
|
|
||||||
|
```
|
||||||
|
Python语法错误：[错误描述]
|
||||||
|
文件：<script_path>
|
||||||
|
行号：<line_number>
|
||||||
|
错误：<python_error_message>
|
||||||
|
|
||||||
|
请检查Python代码的语法正确性。
|
||||||
|
```
|
||||||
|
|
||||||
|
### 场景3：依赖解析失败
|
||||||
|
|
||||||
|
**错误消息：**
|
||||||
|
|
||||||
|
```
|
||||||
|
依赖解析失败
|
||||||
|
|
||||||
|
uv错误输出：
|
||||||
|
[完整的uv错误信息]
|
||||||
|
|
||||||
|
临时文件保留用于调试：<temp_file_path>
|
||||||
|
```
|
||||||
|
|
||||||
|
### 场景4：脚本运行时错误
|
||||||
|
|
||||||
|
**错误消息：**
|
||||||
|
|
||||||
|
```
|
||||||
|
脚本执行失败
|
||||||
|
|
||||||
|
Traceback (most recent call last):
|
||||||
|
[完整的Python traceback]
|
||||||
|
|
||||||
|
临时文件保留用于调试：<temp_file_path>
|
||||||
|
```
|
||||||
|
|
||||||
|
## Examples
|
||||||
|
|
||||||
|
### 示例1：数据分析
|
||||||
|
|
||||||
|
**场景：** 分析CSV文件的统计信息
|
||||||
|
|
||||||
|
```python
|
||||||
|
# /// script
|
||||||
|
# dependencies = [
|
||||||
|
# "pandas",
|
||||||
|
# ]
|
||||||
|
# ///
|
||||||
|
|
||||||
|
import pandas as pd
|
||||||
|
|
||||||
|
df = pd.read_csv('data.csv')
|
||||||
|
print(f"数据形状: {df.shape}")
|
||||||
|
print(f"描述统计:\n{df.describe()}")
|
||||||
|
```
|
||||||
|
|
||||||
|
**执行流程：**
|
||||||
|
|
||||||
|
1. 调用辅助脚本获取临时目录
|
||||||
|
2. 构造临时文件路径
|
||||||
|
3. 创建文件并写入上述内容
|
||||||
|
4. 执行：`uv run <temp_file_path>`
|
||||||
|
5. 捕获输出
|
||||||
|
|
||||||
|
### 示例2：API交互
|
||||||
|
|
||||||
|
**场景：** 从GitHub API获取仓库信息
|
||||||
|
|
||||||
|
```python
|
||||||
|
# /// script
|
||||||
|
# dependencies = [
|
||||||
|
# "requests",
|
||||||
|
# ]
|
||||||
|
# ///
|
||||||
|
|
||||||
|
import requests
|
||||||
|
|
||||||
|
resp = requests.get('https://api.github.com/repos/python/cpython')
|
||||||
|
data = resp.json()
|
||||||
|
|
||||||
|
print(f"仓库: {data['full_name']}")
|
||||||
|
print(f"Star数: {data['stargazers_count']}")
|
||||||
|
print(f"描述: {data['description'][:100]}...")
|
||||||
|
```
|
||||||
|
|
||||||
|
### 示例3：文件操作
|
||||||
|
|
||||||
|
**场景：** 批量重命名文件
|
||||||
|
|
||||||
|
```python
|
||||||
|
# /// script
|
||||||
|
# dependencies = []
|
||||||
|
# ///
|
||||||
|
|
||||||
|
import os
|
||||||
|
import glob
|
||||||
|
from pathlib import Path
|
||||||
|
|
||||||
|
for i, file in enumerate(glob.glob('*.txt')):
|
||||||
|
new_name = f"file_{i:03d}.txt"
|
||||||
|
os.rename(file, new_name)
|
||||||
|
print(f"✓ {file} → {new_name}")
|
||||||
|
```
|
||||||
|
|
||||||
|
## Notes
|
||||||
|
|
||||||
|
### 为什么使用uv？
|
||||||
|
|
||||||
|
| 特性 | 优势 |
|
||||||
|
| ------------ | ------------------------------------------------ |
|
||||||
|
| 环境隔离 | 不污染系统Python环境，每个脚本都有独立的虚拟环境 |
|
||||||
|
| 自动依赖管理 | 无需手动pip install，uv自动解析和安装依赖 |
|
||||||
|
| 快速启动 | 比传统venv快10-100倍，快速创建和销毁环境 |
|
||||||
|
| 标准兼容 | 支持PEP 723格式，官方Python规范 |
|
||||||
|
| 零配置 | 开箱即用，无需额外配置或初始化 |
|
||||||
|
|
||||||
|
### 最佳实践
|
||||||
|
|
||||||
|
1. **总使用内联元数据**
|
||||||
|
|
||||||
|
```python
|
||||||
|
# 即使没有依赖也要声明
|
||||||
|
# dependencies = []
|
||||||
|
```
|
||||||
|
|
||||||
|
2. **使用最新版本**
|
||||||
|
- 不指定版本约束
|
||||||
|
- 让uv自动选择
|
||||||
|
- 保持依赖更新和安全
|
||||||
|
|
||||||
|
3. **错误处理**
|
||||||
|
- 脚本内部处理预期的错误（try-except）
|
||||||
|
- 严格模式处理意外的错误（立即停止）
|
||||||
|
|
||||||
|
4. **清理资源**
|
||||||
|
- 临时文件使用系统临时目录（/tmp 或 Windows Temp）
|
||||||
|
- 系统会自动清理临时文件，无需手动管理
|
||||||
|
- 失败时可手动删除临时文件调试
|
||||||
|
|
||||||
|
### 限制
|
||||||
|
|
||||||
|
- ✗ 不支持命令行参数
|
||||||
|
- 所有参数必须嵌入在脚本中
|
||||||
|
- 不支持`uv run script.py arg1 arg2`
|
||||||
|
|
||||||
|
- ✗ 不支持stdin输入
|
||||||
|
- 不支持`echo "code" | uv run -`
|
||||||
|
- 所有数据必须硬编码或从文件读取
|
||||||
|
|
||||||
|
- ✗ 不支持持久化环境
|
||||||
|
- 每次执行都是新的临时环境
|
||||||
|
- 不缓存或保留虚拟环境
|
||||||
|
|
||||||
|
- ✗ 不支持自定义Python版本
|
||||||
|
- 使用uv的默认Python版本
|
||||||
|
- 不在元数据中指定`requires-python`
|
||||||
|
|
||||||
|
- ✗ 不支持复杂的依赖约束
|
||||||
|
- 只支持简单的包名
|
||||||
|
- 不支持版本范围（`>=1.0,<2.0`）
|
||||||
|
- 不支持Git URL或本地包
|
||||||
|
|
||||||
|
## Dependencies
|
||||||
|
|
||||||
|
### 必需依赖
|
||||||
|
|
||||||
|
- **uv** (https://docs.astral.sh/uv/)
|
||||||
|
- Python包管理器和运行器
|
||||||
|
- 支持PEP 723内联元数据格式
|
||||||
|
- 提供环境隔离和自动依赖管理
|
||||||
|
|
||||||
|
### 可选依赖
|
||||||
|
|
||||||
|
无
|
||||||
|
|
||||||
|
## Workflow Summary
|
||||||
|
|
||||||
|
完整的典型工作流：
|
||||||
|
|
||||||
|
```bash
|
||||||
|
# 1. 获取临时脚本文件路径
|
||||||
|
temp_file_path=$(uv run skills/uv-python-runner/script/get_temp_path.py)
|
||||||
|
|
||||||
|
# 2. 写入PEP 723脚本内容
|
||||||
|
# 使用大模型的Write工具在 temp_file_path 中写入...
|
||||||
|
|
||||||
|
# 3. 执行脚本
|
||||||
|
uv run $temp_file_path
|
||||||
|
|
||||||
|
# 4. 系统自动清理临时文件
|
||||||
|
```
|
||||||
|
|
||||||
|
**关键特点：**
|
||||||
|
|
||||||
|
- 跨平台自动适配
|
||||||
|
- 环境隔离
|
||||||
|
- 自动依赖管理
|
||||||
|
- 临时文件直接返回路径，无需手动拼接
|
||||||
|
- 系统自动清理临时文件，无需手动管理
|
||||||
12
skills/uv-python-runner/script/get_temp_path.py
Normal file
12
skills/uv-python-runner/script/get_temp_path.py
Normal file
@@ -0,0 +1,12 @@
|
|||||||
|
# /// script
|
||||||
|
# dependencies = []
|
||||||
|
# ///
|
||||||
|
|
||||||
|
import tempfile
|
||||||
|
|
||||||
|
temp_dir = tempfile.gettempdir()
|
||||||
|
temp_file_path = tempfile.NamedTemporaryFile(
|
||||||
|
mode="w", suffix=".py", prefix="uv_script_", dir=temp_dir, delete=False
|
||||||
|
).name
|
||||||
|
|
||||||
|
print(temp_file_path)
|
||||||
Reference in New Issue
Block a user