dan/skills
1
0
Fork 0
Code Issues Pull requests Actions Packages Projects Releases Wiki Activity

Initial commit: Agentic coding skills repository

Browse source 
- Add comprehensive documentation (README, WORKFLOW, DEPLOYMENT)
- Add skill template for creating new skills
- Port worklog skill from dotfiles (org-mode session documentation)
- Port update-spec-kit skill from dotfiles (ecosystem updates)
- Include spec-kit framework for structured development
- Add OpenCode commands for spec-kit workflow integration

Repository provides unified skill development for both Claude Code and OpenCode agents.
This commit is contained in:
dan 2025-11-08 10:55:15 -08:00
commit d8c2e92f0a
37 changed files with 5922 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

184
.opencode/command/speckit.analyze.md Normal file
View file

@ -0,0 +1,184 @@
---
description: Perform a non-destructive cross-artifact consistency and quality analysis across spec.md, plan.md, and tasks.md after task generation.
---
## User Input
```text
$ARGUMENTS
```
You **MUST** consider the user input before proceeding (if not empty).
## Goal
Identify inconsistencies, duplications, ambiguities, and underspecified items across the three core artifacts (`spec.md`, `plan.md`, `tasks.md`) before implementation. This command MUST run only after `/speckit.tasks` has successfully produced a complete `tasks.md`.
## Operating Constraints
**STRICTLY READ-ONLY**: Do **not** modify any files. Output a structured analysis report. Offer an optional remediation plan (user must explicitly approve before any follow-up editing commands would be invoked manually).
**Constitution Authority**: The project constitution (`.specify/memory/constitution.md`) is **non-negotiable** within this analysis scope. Constitution conflicts are automatically CRITICAL and require adjustment of the spec, plan, or tasks—not dilution, reinterpretation, or silent ignoring of the principle. If a principle itself needs to change, that must occur in a separate, explicit constitution update outside `/speckit.analyze`.
## Execution Steps
### 1. Initialize Analysis Context
Run `.specify/scripts/bash/check-prerequisites.sh --json --require-tasks --include-tasks` once from repo root and parse JSON for FEATURE_DIR and AVAILABLE_DOCS. Derive absolute paths:
- SPEC = FEATURE_DIR/spec.md
- PLAN = FEATURE_DIR/plan.md
- TASKS = FEATURE_DIR/tasks.md
Abort with an error message if any required file is missing (instruct the user to run missing prerequisite command).
For single quotes in args like "I'm Groot", use escape syntax: e.g 'I'\''m Groot' (or double-quote if possible: "I'm Groot").
### 2. Load Artifacts (Progressive Disclosure)
Load only the minimal necessary context from each artifact:
**From spec.md:**
- Overview/Context
- Functional Requirements
- Non-Functional Requirements
- User Stories
- Edge Cases (if present)
**From plan.md:**
- Architecture/stack choices
- Data Model references
- Phases
- Technical constraints
**From tasks.md:**
- Task IDs
- Descriptions
- Phase grouping
- Parallel markers [P]
- Referenced file paths
**From constitution:**
- Load `.specify/memory/constitution.md` for principle validation
### 3. Build Semantic Models
Create internal representations (do not include raw artifacts in output):
- **Requirements inventory**: Each functional + non-functional requirement with a stable key (derive slug based on imperative phrase; e.g., "User can upload file" → `user-can-upload-file`)
- **User story/action inventory**: Discrete user actions with acceptance criteria
- **Task coverage mapping**: Map each task to one or more requirements or stories (inference by keyword / explicit reference patterns like IDs or key phrases)
- **Constitution rule set**: Extract principle names and MUST/SHOULD normative statements
### 4. Detection Passes (Token-Efficient Analysis)
Focus on high-signal findings. Limit to 50 findings total; aggregate remainder in overflow summary.
#### A. Duplication Detection
- Identify near-duplicate requirements
- Mark lower-quality phrasing for consolidation
#### B. Ambiguity Detection
- Flag vague adjectives (fast, scalable, secure, intuitive, robust) lacking measurable criteria
- Flag unresolved placeholders (TODO, TKTK, ???, `<placeholder>`, etc.)
#### C. Underspecification
- Requirements with verbs but missing object or measurable outcome
- User stories missing acceptance criteria alignment
- Tasks referencing files or components not defined in spec/plan
#### D. Constitution Alignment
- Any requirement or plan element conflicting with a MUST principle
- Missing mandated sections or quality gates from constitution
#### E. Coverage Gaps
- Requirements with zero associated tasks
- Tasks with no mapped requirement/story
- Non-functional requirements not reflected in tasks (e.g., performance, security)
#### F. Inconsistency
- Terminology drift (same concept named differently across files)
- Data entities referenced in plan but absent in spec (or vice versa)
- Task ordering contradictions (e.g., integration tasks before foundational setup tasks without dependency note)
- Conflicting requirements (e.g., one requires Next.js while other specifies Vue)
### 5. Severity Assignment
Use this heuristic to prioritize findings:
- **CRITICAL**: Violates constitution MUST, missing core spec artifact, or requirement with zero coverage that blocks baseline functionality
- **HIGH**: Duplicate or conflicting requirement, ambiguous security/performance attribute, untestable acceptance criterion
- **MEDIUM**: Terminology drift, missing non-functional task coverage, underspecified edge case
- **LOW**: Style/wording improvements, minor redundancy not affecting execution order
### 6. Produce Compact Analysis Report
Output a Markdown report (no file writes) with the following structure:
## Specification Analysis Report
| ID | Category | Severity | Location(s) | Summary | Recommendation |
|----|----------|----------|-------------|---------|----------------|
| A1 | Duplication | HIGH | spec.md:L120-134 | Two similar requirements ... | Merge phrasing; keep clearer version |
(Add one row per finding; generate stable IDs prefixed by category initial.)
**Coverage Summary Table:**
| Requirement Key | Has Task? | Task IDs | Notes |
|-----------------|-----------|----------|-------|
**Constitution Alignment Issues:** (if any)
**Unmapped Tasks:** (if any)
**Metrics:**
- Total Requirements
- Total Tasks
- Coverage % (requirements with >=1 task)
- Ambiguity Count
- Duplication Count
- Critical Issues Count
### 7. Provide Next Actions
At end of report, output a concise Next Actions block:
- If CRITICAL issues exist: Recommend resolving before `/speckit.implement`
- If only LOW/MEDIUM: User may proceed, but provide improvement suggestions
- Provide explicit command suggestions: e.g., "Run /speckit.specify with refinement", "Run /speckit.plan to adjust architecture", "Manually edit tasks.md to add coverage for 'performance-metrics'"
### 8. Offer Remediation
Ask the user: "Would you like me to suggest concrete remediation edits for the top N issues?" (Do NOT apply them automatically.)
## Operating Principles
### Context Efficiency
- **Minimal high-signal tokens**: Focus on actionable findings, not exhaustive documentation
- **Progressive disclosure**: Load artifacts incrementally; don't dump all content into analysis
- **Token-efficient output**: Limit findings table to 50 rows; summarize overflow
- **Deterministic results**: Rerunning without changes should produce consistent IDs and counts
### Analysis Guidelines
- **NEVER modify files** (this is read-only analysis)
- **NEVER hallucinate missing sections** (if absent, report them accurately)
- **Prioritize constitution violations** (these are always CRITICAL)
- **Use examples over exhaustive rules** (cite specific instances, not generic patterns)
- **Report zero issues gracefully** (emit success report with coverage statistics)
## Context
$ARGUMENTS

294
.opencode/command/speckit.checklist.md Normal file
View file

@ -0,0 +1,294 @@
---
description: Generate a custom checklist for the current feature based on user requirements.
---
## Checklist Purpose: "Unit Tests for English"
**CRITICAL CONCEPT**: Checklists are **UNIT TESTS FOR REQUIREMENTS WRITING** - they validate the quality, clarity, and completeness of requirements in a given domain.
**NOT for verification/testing**:
- ❌ NOT "Verify the button clicks correctly"
- ❌ NOT "Test error handling works"
- ❌ NOT "Confirm the API returns 200"
- ❌ NOT checking if code/implementation matches the spec
**FOR requirements quality validation**:
- ✅ "Are visual hierarchy requirements defined for all card types?" (completeness)
- ✅ "Is 'prominent display' quantified with specific sizing/positioning?" (clarity)
- ✅ "Are hover state requirements consistent across all interactive elements?" (consistency)
- ✅ "Are accessibility requirements defined for keyboard navigation?" (coverage)
- ✅ "Does the spec define what happens when logo image fails to load?" (edge cases)
**Metaphor**: If your spec is code written in English, the checklist is its unit test suite. You're testing whether the requirements are well-written, complete, unambiguous, and ready for implementation - NOT whether the implementation works.
## User Input
```text
$ARGUMENTS
```
You **MUST** consider the user input before proceeding (if not empty).
## Execution Steps
1. **Setup**: Run `.specify/scripts/bash/check-prerequisites.sh --json` from repo root and parse JSON for FEATURE_DIR and AVAILABLE_DOCS list.
- All file paths must be absolute.
- For single quotes in args like "I'm Groot", use escape syntax: e.g 'I'\''m Groot' (or double-quote if possible: "I'm Groot").
2. **Clarify intent (dynamic)**: Derive up to THREE initial contextual clarifying questions (no pre-baked catalog). They MUST:
- Be generated from the user's phrasing + extracted signals from spec/plan/tasks
- Only ask about information that materially changes checklist content
- Be skipped individually if already unambiguous in `$ARGUMENTS`
- Prefer precision over breadth
Generation algorithm:
1. Extract signals: feature domain keywords (e.g., auth, latency, UX, API), risk indicators ("critical", "must", "compliance"), stakeholder hints ("QA", "review", "security team"), and explicit deliverables ("a11y", "rollback", "contracts").
2. Cluster signals into candidate focus areas (max 4) ranked by relevance.
3. Identify probable audience & timing (author, reviewer, QA, release) if not explicit.
4. Detect missing dimensions: scope breadth, depth/rigor, risk emphasis, exclusion boundaries, measurable acceptance criteria.
5. Formulate questions chosen from these archetypes:
- Scope refinement (e.g., "Should this include integration touchpoints with X and Y or stay limited to local module correctness?")
- Risk prioritization (e.g., "Which of these potential risk areas should receive mandatory gating checks?")
- Depth calibration (e.g., "Is this a lightweight pre-commit sanity list or a formal release gate?")
- Audience framing (e.g., "Will this be used by the author only or peers during PR review?")
- Boundary exclusion (e.g., "Should we explicitly exclude performance tuning items this round?")
- Scenario class gap (e.g., "No recovery flows detected—are rollback / partial failure paths in scope?")
Question formatting rules:
- If presenting options, generate a compact table with columns: Option | Candidate | Why It Matters
- Limit to A–E options maximum; omit table if a free-form answer is clearer
- Never ask the user to restate what they already said
- Avoid speculative categories (no hallucination). If uncertain, ask explicitly: "Confirm whether X belongs in scope."
Defaults when interaction impossible:
- Depth: Standard
- Audience: Reviewer (PR) if code-related; Author otherwise
- Focus: Top 2 relevance clusters
Output the questions (label Q1/Q2/Q3). After answers: if ≥2 scenario classes (Alternate / Exception / Recovery / Non-Functional domain) remain unclear, you MAY ask up to TWO more targeted follow‑ups (Q4/Q5) with a one-line justification each (e.g., "Unresolved recovery path risk"). Do not exceed five total questions. Skip escalation if user explicitly declines more.
3. **Understand user request**: Combine `$ARGUMENTS` + clarifying answers:
- Derive checklist theme (e.g., security, review, deploy, ux)
- Consolidate explicit must-have items mentioned by user
- Map focus selections to category scaffolding
- Infer any missing context from spec/plan/tasks (do NOT hallucinate)
4. **Load feature context**: Read from FEATURE_DIR:
- spec.md: Feature requirements and scope
- plan.md (if exists): Technical details, dependencies
- tasks.md (if exists): Implementation tasks
**Context Loading Strategy**:
- Load only necessary portions relevant to active focus areas (avoid full-file dumping)
- Prefer summarizing long sections into concise scenario/requirement bullets
- Use progressive disclosure: add follow-on retrieval only if gaps detected
- If source docs are large, generate interim summary items instead of embedding raw text
5. **Generate checklist** - Create "Unit Tests for Requirements":
- Create `FEATURE_DIR/checklists/` directory if it doesn't exist
- Generate unique checklist filename:
- Use short, descriptive name based on domain (e.g., `ux.md`, `api.md`, `security.md`)
- Format: `[domain].md`
- If file exists, append to existing file
- Number items sequentially starting from CHK001
- Each `/speckit.checklist` run creates a NEW file (never overwrites existing checklists)
**CORE PRINCIPLE - Test the Requirements, Not the Implementation**:
Every checklist item MUST evaluate the REQUIREMENTS THEMSELVES for:
- **Completeness**: Are all necessary requirements present?
- **Clarity**: Are requirements unambiguous and specific?
- **Consistency**: Do requirements align with each other?
- **Measurability**: Can requirements be objectively verified?
- **Coverage**: Are all scenarios/edge cases addressed?
**Category Structure** - Group items by requirement quality dimensions:
- **Requirement Completeness** (Are all necessary requirements documented?)
- **Requirement Clarity** (Are requirements specific and unambiguous?)
- **Requirement Consistency** (Do requirements align without conflicts?)
- **Acceptance Criteria Quality** (Are success criteria measurable?)
- **Scenario Coverage** (Are all flows/cases addressed?)
- **Edge Case Coverage** (Are boundary conditions defined?)
- **Non-Functional Requirements** (Performance, Security, Accessibility, etc. - are they specified?)
- **Dependencies & Assumptions** (Are they documented and validated?)
- **Ambiguities & Conflicts** (What needs clarification?)
**HOW TO WRITE CHECKLIST ITEMS - "Unit Tests for English"**:
❌ **WRONG** (Testing implementation):
- "Verify landing page displays 3 episode cards"
- "Test hover states work on desktop"
- "Confirm logo click navigates home"
✅ **CORRECT** (Testing requirements quality):
- "Are the exact number and layout of featured episodes specified?" [Completeness]
- "Is 'prominent display' quantified with specific sizing/positioning?" [Clarity]
- "Are hover state requirements consistent across all interactive elements?" [Consistency]
- "Are keyboard navigation requirements defined for all interactive UI?" [Coverage]
- "Is the fallback behavior specified when logo image fails to load?" [Edge Cases]
- "Are loading states defined for asynchronous episode data?" [Completeness]
- "Does the spec define visual hierarchy for competing UI elements?" [Clarity]
**ITEM STRUCTURE**:
Each item should follow this pattern:
- Question format asking about requirement quality
- Focus on what's WRITTEN (or not written) in the spec/plan
- Include quality dimension in brackets [Completeness/Clarity/Consistency/etc.]
- Reference spec section `[Spec §X.Y]` when checking existing requirements
- Use `[Gap]` marker when checking for missing requirements
**EXAMPLES BY QUALITY DIMENSION**:
Completeness:
- "Are error handling requirements defined for all API failure modes? [Gap]"
- "Are accessibility requirements specified for all interactive elements? [Completeness]"
- "Are mobile breakpoint requirements defined for responsive layouts? [Gap]"
Clarity:
- "Is 'fast loading' quantified with specific timing thresholds? [Clarity, Spec §NFR-2]"
- "Are 'related episodes' selection criteria explicitly defined? [Clarity, Spec §FR-5]"
- "Is 'prominent' defined with measurable visual properties? [Ambiguity, Spec §FR-4]"
Consistency:
- "Do navigation requirements align across all pages? [Consistency, Spec §FR-10]"
- "Are card component requirements consistent between landing and detail pages? [Consistency]"
Coverage:
- "Are requirements defined for zero-state scenarios (no episodes)? [Coverage, Edge Case]"
- "Are concurrent user interaction scenarios addressed? [Coverage, Gap]"
- "Are requirements specified for partial data loading failures? [Coverage, Exception Flow]"
Measurability:
- "Are visual hierarchy requirements measurable/testable? [Acceptance Criteria, Spec §FR-1]"
- "Can 'balanced visual weight' be objectively verified? [Measurability, Spec §FR-2]"
**Scenario Classification & Coverage** (Requirements Quality Focus):
- Check if requirements exist for: Primary, Alternate, Exception/Error, Recovery, Non-Functional scenarios
- For each scenario class, ask: "Are [scenario type] requirements complete, clear, and consistent?"
- If scenario class missing: "Are [scenario type] requirements intentionally excluded or missing? [Gap]"
- Include resilience/rollback when state mutation occurs: "Are rollback requirements defined for migration failures? [Gap]"
**Traceability Requirements**:
- MINIMUM: ≥80% of items MUST include at least one traceability reference
- Each item should reference: spec section `[Spec §X.Y]`, or use markers: `[Gap]`, `[Ambiguity]`, `[Conflict]`, `[Assumption]`
- If no ID system exists: "Is a requirement & acceptance criteria ID scheme established? [Traceability]"
**Surface & Resolve Issues** (Requirements Quality Problems):
Ask questions about the requirements themselves:
- Ambiguities: "Is the term 'fast' quantified with specific metrics? [Ambiguity, Spec §NFR-1]"
- Conflicts: "Do navigation requirements conflict between §FR-10 and §FR-10a? [Conflict]"
- Assumptions: "Is the assumption of 'always available podcast API' validated? [Assumption]"
- Dependencies: "Are external podcast API requirements documented? [Dependency, Gap]"
- Missing definitions: "Is 'visual hierarchy' defined with measurable criteria? [Gap]"
**Content Consolidation**:
- Soft cap: If raw candidate items > 40, prioritize by risk/impact
- Merge near-duplicates checking the same requirement aspect
- If >5 low-impact edge cases, create one item: "Are edge cases X, Y, Z addressed in requirements? [Coverage]"
**🚫 ABSOLUTELY PROHIBITED** - These make it an implementation test, not a requirements test:
- ❌ Any item starting with "Verify", "Test", "Confirm", "Check" + implementation behavior
- ❌ References to code execution, user actions, system behavior
- ❌ "Displays correctly", "works properly", "functions as expected"
- ❌ "Click", "navigate", "render", "load", "execute"
- ❌ Test cases, test plans, QA procedures
- ❌ Implementation details (frameworks, APIs, algorithms)
**✅ REQUIRED PATTERNS** - These test requirements quality:
- ✅ "Are [requirement type] defined/specified/documented for [scenario]?"
- ✅ "Is [vague term] quantified/clarified with specific criteria?"
- ✅ "Are requirements consistent between [section A] and [section B]?"
- ✅ "Can [requirement] be objectively measured/verified?"
- ✅ "Are [edge cases/scenarios] addressed in requirements?"
- ✅ "Does the spec define [missing aspect]?"
6. **Structure Reference**: Generate the checklist following the canonical template in `.specify/templates/checklist-template.md` for title, meta section, category headings, and ID formatting. If template is unavailable, use: H1 title, purpose/created meta lines, `##` category sections containing `- [ ] CHK### <requirement item>` lines with globally incrementing IDs starting at CHK001.
7. **Report**: Output full path to created checklist, item count, and remind user that each run creates a new file. Summarize:
- Focus areas selected
- Depth level
- Actor/timing
- Any explicit user-specified must-have items incorporated
**Important**: Each `/speckit.checklist` command invocation creates a checklist file using short, descriptive names unless file already exists. This allows:
- Multiple checklists of different types (e.g., `ux.md`, `test.md`, `security.md`)
- Simple, memorable filenames that indicate checklist purpose
- Easy identification and navigation in the `checklists/` folder
To avoid clutter, use descriptive types and clean up obsolete checklists when done.
## Example Checklist Types & Sample Items
**UX Requirements Quality:** `ux.md`
Sample items (testing the requirements, NOT the implementation):
- "Are visual hierarchy requirements defined with measurable criteria? [Clarity, Spec §FR-1]"
- "Is the number and positioning of UI elements explicitly specified? [Completeness, Spec §FR-1]"
- "Are interaction state requirements (hover, focus, active) consistently defined? [Consistency]"
- "Are accessibility requirements specified for all interactive elements? [Coverage, Gap]"
- "Is fallback behavior defined when images fail to load? [Edge Case, Gap]"
- "Can 'prominent display' be objectively measured? [Measurability, Spec §FR-4]"
**API Requirements Quality:** `api.md`
Sample items:
- "Are error response formats specified for all failure scenarios? [Completeness]"
- "Are rate limiting requirements quantified with specific thresholds? [Clarity]"
- "Are authentication requirements consistent across all endpoints? [Consistency]"
- "Are retry/timeout requirements defined for external dependencies? [Coverage, Gap]"
- "Is versioning strategy documented in requirements? [Gap]"
**Performance Requirements Quality:** `performance.md`
Sample items:
- "Are performance requirements quantified with specific metrics? [Clarity]"
- "Are performance targets defined for all critical user journeys? [Coverage]"
- "Are performance requirements under different load conditions specified? [Completeness]"
- "Can performance requirements be objectively measured? [Measurability]"
- "Are degradation requirements defined for high-load scenarios? [Edge Case, Gap]"
**Security Requirements Quality:** `security.md`
Sample items:
- "Are authentication requirements specified for all protected resources? [Coverage]"
- "Are data protection requirements defined for sensitive information? [Completeness]"
- "Is the threat model documented and requirements aligned to it? [Traceability]"
- "Are security requirements consistent with compliance obligations? [Consistency]"
- "Are security failure/breach response requirements defined? [Gap, Exception Flow]"
## Anti-Examples: What NOT To Do
**❌ WRONG - These test implementation, not requirements:**
```markdown
- [ ] CHK001 - Verify landing page displays 3 episode cards [Spec §FR-001]
- [ ] CHK002 - Test hover states work correctly on desktop [Spec §FR-003]
- [ ] CHK003 - Confirm logo click navigates to home page [Spec §FR-010]
- [ ] CHK004 - Check that related episodes section shows 3-5 items [Spec §FR-005]
```
**✅ CORRECT - These test requirements quality:**
```markdown
- [ ] CHK001 - Are the number and layout of featured episodes explicitly specified? [Completeness, Spec §FR-001]
- [ ] CHK002 - Are hover state requirements consistently defined for all interactive elements? [Consistency, Spec §FR-003]
- [ ] CHK003 - Are navigation requirements clear for all clickable brand elements? [Clarity, Spec §FR-010]
- [ ] CHK004 - Is the selection criteria for related episodes documented? [Gap, Spec §FR-005]
- [ ] CHK005 - Are loading state requirements defined for asynchronous episode data? [Gap]
- [ ] CHK006 - Can "visual hierarchy" requirements be objectively measured? [Measurability, Spec §FR-001]
```
**Key Differences:**
- Wrong: Tests if the system works correctly
- Correct: Tests if the requirements are written correctly
- Wrong: Verification of behavior
- Correct: Validation of requirement quality
- Wrong: "Does it do X?"
- Correct: "Is X clearly specified?"

177
.opencode/command/speckit.clarify.md Normal file
View file

@ -0,0 +1,177 @@
---
description: Identify underspecified areas in the current feature spec by asking up to 5 highly targeted clarification questions and encoding answers back into the spec.
---
## User Input
```text
$ARGUMENTS
```
You **MUST** consider the user input before proceeding (if not empty).
## Outline
Goal: Detect and reduce ambiguity or missing decision points in the active feature specification and record the clarifications directly in the spec file.
Note: This clarification workflow is expected to run (and be completed) BEFORE invoking `/speckit.plan`. If the user explicitly states they are skipping clarification (e.g., exploratory spike), you may proceed, but must warn that downstream rework risk increases.
Execution steps:
1. Run `.specify/scripts/bash/check-prerequisites.sh --json --paths-only` from repo root **once** (combined `--json --paths-only` mode / `-Json -PathsOnly`). Parse minimal JSON payload fields:
- `FEATURE_DIR`
- `FEATURE_SPEC`
- (Optionally capture `IMPL_PLAN`, `TASKS` for future chained flows.)
- If JSON parsing fails, abort and instruct user to re-run `/speckit.specify` or verify feature branch environment.
- For single quotes in args like "I'm Groot", use escape syntax: e.g 'I'\''m Groot' (or double-quote if possible: "I'm Groot").
2. Load the current spec file. Perform a structured ambiguity & coverage scan using this taxonomy. For each category, mark status: Clear / Partial / Missing. Produce an internal coverage map used for prioritization (do not output raw map unless no questions will be asked).
Functional Scope & Behavior:
- Core user goals & success criteria
- Explicit out-of-scope declarations
- User roles / personas differentiation
Domain & Data Model:
- Entities, attributes, relationships
- Identity & uniqueness rules
- Lifecycle/state transitions
- Data volume / scale assumptions
Interaction & UX Flow:
- Critical user journeys / sequences
- Error/empty/loading states
- Accessibility or localization notes
Non-Functional Quality Attributes:
- Performance (latency, throughput targets)
- Scalability (horizontal/vertical, limits)
- Reliability & availability (uptime, recovery expectations)
- Observability (logging, metrics, tracing signals)
- Security & privacy (authN/Z, data protection, threat assumptions)
- Compliance / regulatory constraints (if any)
Integration & External Dependencies:
- External services/APIs and failure modes
- Data import/export formats
- Protocol/versioning assumptions
Edge Cases & Failure Handling:
- Negative scenarios
- Rate limiting / throttling
- Conflict resolution (e.g., concurrent edits)
Constraints & Tradeoffs:
- Technical constraints (language, storage, hosting)
- Explicit tradeoffs or rejected alternatives
Terminology & Consistency:
- Canonical glossary terms
- Avoided synonyms / deprecated terms
Completion Signals:
- Acceptance criteria testability
- Measurable Definition of Done style indicators
Misc / Placeholders:
- TODO markers / unresolved decisions
- Ambiguous adjectives ("robust", "intuitive") lacking quantification
For each category with Partial or Missing status, add a candidate question opportunity unless:
- Clarification would not materially change implementation or validation strategy
- Information is better deferred to planning phase (note internally)
3. Generate (internally) a prioritized queue of candidate clarification questions (maximum 5). Do NOT output them all at once. Apply these constraints:
- Maximum of 10 total questions across the whole session.
- Each question must be answerable with EITHER:
- A short multiple‑choice selection (2–5 distinct, mutually exclusive options), OR
- A one-word / short‑phrase answer (explicitly constrain: "Answer in <=5 words").
- Only include questions whose answers materially impact architecture, data modeling, task decomposition, test design, UX behavior, operational readiness, or compliance validation.
- Ensure category coverage balance: attempt to cover the highest impact unresolved categories first; avoid asking two low-impact questions when a single high-impact area (e.g., security posture) is unresolved.
- Exclude questions already answered, trivial stylistic preferences, or plan-level execution details (unless blocking correctness).
- Favor clarifications that reduce downstream rework risk or prevent misaligned acceptance tests.
- If more than 5 categories remain unresolved, select the top 5 by (Impact * Uncertainty) heuristic.
4. Sequential questioning loop (interactive):
- Present EXACTLY ONE question at a time.
- For multiple‑choice questions:
- **Analyze all options** and determine the **most suitable option** based on:
- Best practices for the project type
- Common patterns in similar implementations
- Risk reduction (security, performance, maintainability)
- Alignment with any explicit project goals or constraints visible in the spec
- Present your **recommended option prominently** at the top with clear reasoning (1-2 sentences explaining why this is the best choice).
- Format as: `**Recommended:** Option [X] - <reasoning>`
- Then render all options as a Markdown table:
| Option | Description |
|--------|-------------|
| A | <Option A description> |
| B | <Option B description> |
| C | <Option C description> (add D/E as needed up to 5) |
| Short | Provide a different short answer (<=5 words) (Include only if free-form alternative is appropriate) |
- After the table, add: `You can reply with the option letter (e.g., "A"), accept the recommendation by saying "yes" or "recommended", or provide your own short answer.`
- For short‑answer style (no meaningful discrete options):
- Provide your **suggested answer** based on best practices and context.
- Format as: `**Suggested:** <your proposed answer> - <brief reasoning>`
- Then output: `Format: Short answer (<=5 words). You can accept the suggestion by saying "yes" or "suggested", or provide your own answer.`
- After the user answers:
- If the user replies with "yes", "recommended", or "suggested", use your previously stated recommendation/suggestion as the answer.
- Otherwise, validate the answer maps to one option or fits the <=5 word constraint.
- If ambiguous, ask for a quick disambiguation (count still belongs to same question; do not advance).
- Once satisfactory, record it in working memory (do not yet write to disk) and move to the next queued question.
- Stop asking further questions when:
- All critical ambiguities resolved early (remaining queued items become unnecessary), OR
- User signals completion ("done", "good", "no more"), OR
- You reach 5 asked questions.
- Never reveal future queued questions in advance.
- If no valid questions exist at start, immediately report no critical ambiguities.
5. Integration after EACH accepted answer (incremental update approach):
- Maintain in-memory representation of the spec (loaded once at start) plus the raw file contents.
- For the first integrated answer in this session:
- Ensure a `## Clarifications` section exists (create it just after the highest-level contextual/overview section per the spec template if missing).
- Under it, create (if not present) a `### Session YYYY-MM-DD` subheading for today.
- Append a bullet line immediately after acceptance: `- Q: <question> → A: <final answer>`.
- Then immediately apply the clarification to the most appropriate section(s):
- Functional ambiguity → Update or add a bullet in Functional Requirements.
- User interaction / actor distinction → Update User Stories or Actors subsection (if present) with clarified role, constraint, or scenario.
- Data shape / entities → Update Data Model (add fields, types, relationships) preserving ordering; note added constraints succinctly.
- Non-functional constraint → Add/modify measurable criteria in Non-Functional / Quality Attributes section (convert vague adjective to metric or explicit target).
- Edge case / negative flow → Add a new bullet under Edge Cases / Error Handling (or create such subsection if template provides placeholder for it).
- Terminology conflict → Normalize term across spec; retain original only if necessary by adding `(formerly referred to as "X")` once.
- If the clarification invalidates an earlier ambiguous statement, replace that statement instead of duplicating; leave no obsolete contradictory text.
- Save the spec file AFTER each integration to minimize risk of context loss (atomic overwrite).
- Preserve formatting: do not reorder unrelated sections; keep heading hierarchy intact.
- Keep each inserted clarification minimal and testable (avoid narrative drift).
6. Validation (performed after EACH write plus final pass):
- Clarifications session contains exactly one bullet per accepted answer (no duplicates).
- Total asked (accepted) questions ≤ 5.
- Updated sections contain no lingering vague placeholders the new answer was meant to resolve.
- No contradictory earlier statement remains (scan for now-invalid alternative choices removed).
- Markdown structure valid; only allowed new headings: `## Clarifications`, `### Session YYYY-MM-DD`.
- Terminology consistency: same canonical term used across all updated sections.
7. Write the updated spec back to `FEATURE_SPEC`.
8. Report completion (after questioning loop ends or early termination):
- Number of questions asked & answered.
- Path to updated spec.
- Sections touched (list names).
- Coverage summary table listing each taxonomy category with Status: Resolved (was Partial/Missing and addressed), Deferred (exceeds question quota or better suited for planning), Clear (already sufficient), Outstanding (still Partial/Missing but low impact).
- If any Outstanding or Deferred remain, recommend whether to proceed to `/speckit.plan` or run `/speckit.clarify` again later post-plan.
- Suggested next command.
Behavior rules:
- If no meaningful ambiguities found (or all potential questions would be low-impact), respond: "No critical ambiguities detected worth formal clarification." and suggest proceeding.
- If spec file missing, instruct user to run `/speckit.specify` first (do not create a new spec here).
- Never exceed 5 total asked questions (clarification retries for a single question do not count as new questions).
- Avoid speculative tech stack questions unless the absence blocks functional clarity.
- Respect user early termination signals ("stop", "done", "proceed").
- If no questions asked due to full coverage, output a compact coverage summary (all categories Clear) then suggest advancing.
- If quota reached with unresolved high-impact categories remaining, explicitly flag them under Deferred with rationale.
Context for prioritization: $ARGUMENTS

78
.opencode/command/speckit.constitution.md Normal file
View file

@ -0,0 +1,78 @@
---
description: Create or update the project constitution from interactive or provided principle inputs, ensuring all dependent templates stay in sync
---
## User Input
```text
$ARGUMENTS
```
You **MUST** consider the user input before proceeding (if not empty).
## Outline
You are updating the project constitution at `.specify/memory/constitution.md`. This file is a TEMPLATE containing placeholder tokens in square brackets (e.g. `[PROJECT_NAME]`, `[PRINCIPLE_1_NAME]`). Your job is to (a) collect/derive concrete values, (b) fill the template precisely, and (c) propagate any amendments across dependent artifacts.
Follow this execution flow:
1. Load the existing constitution template at `.specify/memory/constitution.md`.
- Identify every placeholder token of the form `[ALL_CAPS_IDENTIFIER]`.
**IMPORTANT**: The user might require less or more principles than the ones used in the template. If a number is specified, respect that - follow the general template. You will update the doc accordingly.
2. Collect/derive values for placeholders:
- If user input (conversation) supplies a value, use it.
- Otherwise infer from existing repo context (README, docs, prior constitution versions if embedded).
- For governance dates: `RATIFICATION_DATE` is the original adoption date (if unknown ask or mark TODO), `LAST_AMENDED_DATE` is today if changes are made, otherwise keep previous.
- `CONSTITUTION_VERSION` must increment according to semantic versioning rules:
- MAJOR: Backward incompatible governance/principle removals or redefinitions.
- MINOR: New principle/section added or materially expanded guidance.
- PATCH: Clarifications, wording, typo fixes, non-semantic refinements.
- If version bump type ambiguous, propose reasoning before finalizing.
3. Draft the updated constitution content:
- Replace every placeholder with concrete text (no bracketed tokens left except intentionally retained template slots that the project has chosen not to define yet—explicitly justify any left).
- Preserve heading hierarchy and comments can be removed once replaced unless they still add clarifying guidance.
- Ensure each Principle section: succinct name line, paragraph (or bullet list) capturing non‑negotiable rules, explicit rationale if not obvious.
- Ensure Governance section lists amendment procedure, versioning policy, and compliance review expectations.
4. Consistency propagation checklist (convert prior checklist into active validations):
- Read `.specify/templates/plan-template.md` and ensure any "Constitution Check" or rules align with updated principles.
- Read `.specify/templates/spec-template.md` for scope/requirements alignment—update if constitution adds/removes mandatory sections or constraints.
- Read `.specify/templates/tasks-template.md` and ensure task categorization reflects new or removed principle-driven task types (e.g., observability, versioning, testing discipline).
- Read each command file in `.specify/templates/commands/*.md` (including this one) to verify no outdated references (agent-specific names like CLAUDE only) remain when generic guidance is required.
- Read any runtime guidance docs (e.g., `README.md`, `docs/quickstart.md`, or agent-specific guidance files if present). Update references to principles changed.
5. Produce a Sync Impact Report (prepend as an HTML comment at top of the constitution file after update):
- Version change: old → new
- List of modified principles (old title → new title if renamed)
- Added sections
- Removed sections
- Templates requiring updates (✅ updated / ⚠ pending) with file paths
- Follow-up TODOs if any placeholders intentionally deferred.
6. Validation before final output:
- No remaining unexplained bracket tokens.
- Version line matches report.
- Dates ISO format YYYY-MM-DD.
- Principles are declarative, testable, and free of vague language ("should" → replace with MUST/SHOULD rationale where appropriate).
7. Write the completed constitution back to `.specify/memory/constitution.md` (overwrite).
8. Output a final summary to the user with:
- New version and bump rationale.
- Any files flagged for manual follow-up.
- Suggested commit message (e.g., `docs: amend constitution to vX.Y.Z (principle additions + governance update)`).
Formatting & Style Requirements:
- Use Markdown headings exactly as in the template (do not demote/promote levels).
- Wrap long rationale lines to keep readability (<100 chars ideally) but do not hard enforce with awkward breaks.
- Keep a single blank line between sections.
- Avoid trailing whitespace.
If the user supplies partial updates (e.g., only one principle revision), still perform validation and version decision steps.
If critical info missing (e.g., ratification date truly unknown), insert `TODO(<FIELD_NAME>): explanation` and include in the Sync Impact Report under deferred items.
Do not create a new template; always operate on the existing `.specify/memory/constitution.md` file.

134
.opencode/command/speckit.implement.md Normal file
View file

@ -0,0 +1,134 @@
---
description: Execute the implementation plan by processing and executing all tasks defined in tasks.md
---
## User Input
```text
$ARGUMENTS
```
You **MUST** consider the user input before proceeding (if not empty).
## Outline
1. Run `.specify/scripts/bash/check-prerequisites.sh --json --require-tasks --include-tasks` from repo root and parse FEATURE_DIR and AVAILABLE_DOCS list. All paths must be absolute. For single quotes in args like "I'm Groot", use escape syntax: e.g 'I'\''m Groot' (or double-quote if possible: "I'm Groot").
2. **Check checklists status** (if FEATURE_DIR/checklists/ exists):
- Scan all checklist files in the checklists/ directory
- For each checklist, count:
- Total items: All lines matching `- [ ]` or `- [X]` or `- [x]`
- Completed items: Lines matching `- [X]` or `- [x]`
- Incomplete items: Lines matching `- [ ]`
- Create a status table:
```text
| Checklist | Total | Completed | Incomplete | Status |
|-----------|-------|-----------|------------|--------|
| ux.md | 12 | 12 | 0 | ✓ PASS |
| test.md | 8 | 5 | 3 | ✗ FAIL |
| security.md | 6 | 6 | 0 | ✓ PASS |
```
- Calculate overall status:
- **PASS**: All checklists have 0 incomplete items
- **FAIL**: One or more checklists have incomplete items
- **If any checklist is incomplete**:
- Display the table with incomplete item counts
- **STOP** and ask: "Some checklists are incomplete. Do you want to proceed with implementation anyway? (yes/no)"
- Wait for user response before continuing
- If user says "no" or "wait" or "stop", halt execution
- If user says "yes" or "proceed" or "continue", proceed to step 3
- **If all checklists are complete**:
- Display the table showing all checklists passed
- Automatically proceed to step 3
3. Load and analyze the implementation context:
- **REQUIRED**: Read tasks.md for the complete task list and execution plan
- **REQUIRED**: Read plan.md for tech stack, architecture, and file structure
- **IF EXISTS**: Read data-model.md for entities and relationships
- **IF EXISTS**: Read contracts/ for API specifications and test requirements
- **IF EXISTS**: Read research.md for technical decisions and constraints
- **IF EXISTS**: Read quickstart.md for integration scenarios
4. **Project Setup Verification**:
- **REQUIRED**: Create/verify ignore files based on actual project setup:
**Detection & Creation Logic**:
- Check if the following command succeeds to determine if the repository is a git repo (create/verify .gitignore if so):
```sh
git rev-parse --git-dir 2>/dev/null
```
- Check if Dockerfile* exists or Docker in plan.md → create/verify .dockerignore
- Check if .eslintrc*or eslint.config.* exists → create/verify .eslintignore
- Check if .prettierrc* exists → create/verify .prettierignore
- Check if .npmrc or package.json exists → create/verify .npmignore (if publishing)
- Check if terraform files (*.tf) exist → create/verify .terraformignore
- Check if .helmignore needed (helm charts present) → create/verify .helmignore
**If ignore file already exists**: Verify it contains essential patterns, append missing critical patterns only
**If ignore file missing**: Create with full pattern set for detected technology
**Common Patterns by Technology** (from plan.md tech stack):
- **Node.js/JavaScript/TypeScript**: `node_modules/`, `dist/`, `build/`, `*.log`, `.env*`
- **Python**: `__pycache__/`, `*.pyc`, `.venv/`, `venv/`, `dist/`, `*.egg-info/`
- **Java**: `target/`, `*.class`, `*.jar`, `.gradle/`, `build/`
- **C#/.NET**: `bin/`, `obj/`, `*.user`, `*.suo`, `packages/`
- **Go**: `*.exe`, `*.test`, `vendor/`, `*.out`
- **Ruby**: `.bundle/`, `log/`, `tmp/`, `*.gem`, `vendor/bundle/`
- **PHP**: `vendor/`, `*.log`, `*.cache`, `*.env`
- **Rust**: `target/`, `debug/`, `release/`, `*.rs.bk`, `*.rlib`, `*.prof*`, `.idea/`, `*.log`, `.env*`
- **Kotlin**: `build/`, `out/`, `.gradle/`, `.idea/`, `*.class`, `*.jar`, `*.iml`, `*.log`, `.env*`
- **C++**: `build/`, `bin/`, `obj/`, `out/`, `*.o`, `*.so`, `*.a`, `*.exe`, `*.dll`, `.idea/`, `*.log`, `.env*`
- **C**: `build/`, `bin/`, `obj/`, `out/`, `*.o`, `*.a`, `*.so`, `*.exe`, `Makefile`, `config.log`, `.idea/`, `*.log`, `.env*`
- **Swift**: `.build/`, `DerivedData/`, `*.swiftpm/`, `Packages/`
- **R**: `.Rproj.user/`, `.Rhistory`, `.RData`, `.Ruserdata`, `*.Rproj`, `packrat/`, `renv/`
- **Universal**: `.DS_Store`, `Thumbs.db`, `*.tmp`, `*.swp`, `.vscode/`, `.idea/`
**Tool-Specific Patterns**:
- **Docker**: `node_modules/`, `.git/`, `Dockerfile*`, `.dockerignore`, `*.log*`, `.env*`, `coverage/`
- **ESLint**: `node_modules/`, `dist/`, `build/`, `coverage/`, `*.min.js`
- **Prettier**: `node_modules/`, `dist/`, `build/`, `coverage/`, `package-lock.json`, `yarn.lock`, `pnpm-lock.yaml`
- **Terraform**: `.terraform/`, `*.tfstate*`, `*.tfvars`, `.terraform.lock.hcl`
- **Kubernetes/k8s**: `*.secret.yaml`, `secrets/`, `.kube/`, `kubeconfig*`, `*.key`, `*.crt`
5. Parse tasks.md structure and extract:
- **Task phases**: Setup, Tests, Core, Integration, Polish
- **Task dependencies**: Sequential vs parallel execution rules
- **Task details**: ID, description, file paths, parallel markers [P]
- **Execution flow**: Order and dependency requirements
6. Execute implementation following the task plan:
- **Phase-by-phase execution**: Complete each phase before moving to the next
- **Respect dependencies**: Run sequential tasks in order, parallel tasks [P] can run together
- **Follow TDD approach**: Execute test tasks before their corresponding implementation tasks
- **File-based coordination**: Tasks affecting the same files must run sequentially
- **Validation checkpoints**: Verify each phase completion before proceeding
7. Implementation execution rules:
- **Setup first**: Initialize project structure, dependencies, configuration
- **Tests before code**: If you need to write tests for contracts, entities, and integration scenarios
- **Core development**: Implement models, services, CLI commands, endpoints
- **Integration work**: Database connections, middleware, logging, external services
- **Polish and validation**: Unit tests, performance optimization, documentation
8. Progress tracking and error handling:
- Report progress after each completed task
- Halt execution if any non-parallel task fails
- For parallel tasks [P], continue with successful tasks, report failed ones
- Provide clear error messages with context for debugging
- Suggest next steps if implementation cannot proceed
- **IMPORTANT** For completed tasks, make sure to mark the task off as [X] in the tasks file.
9. Completion validation:
- Verify all required tasks are completed
- Check that implemented features match the original specification
- Validate that tests pass and coverage meets requirements
- Confirm the implementation follows the technical plan
- Report final status with summary of completed work
Note: This command assumes a complete task breakdown exists in tasks.md. If tasks are incomplete or missing, suggest running `/speckit.tasks` first to regenerate the task list.

81
.opencode/command/speckit.plan.md Normal file
View file

@ -0,0 +1,81 @@
---
description: Execute the implementation planning workflow using the plan template to generate design artifacts.
---
## User Input
```text
$ARGUMENTS
```
You **MUST** consider the user input before proceeding (if not empty).
## Outline
1. **Setup**: Run `.specify/scripts/bash/setup-plan.sh --json` from repo root and parse JSON for FEATURE_SPEC, IMPL_PLAN, SPECS_DIR, BRANCH. For single quotes in args like "I'm Groot", use escape syntax: e.g 'I'\''m Groot' (or double-quote if possible: "I'm Groot").
2. **Load context**: Read FEATURE_SPEC and `.specify/memory/constitution.md`. Load IMPL_PLAN template (already copied).
3. **Execute plan workflow**: Follow the structure in IMPL_PLAN template to:
- Fill Technical Context (mark unknowns as "NEEDS CLARIFICATION")
- Fill Constitution Check section from constitution
- Evaluate gates (ERROR if violations unjustified)
- Phase 0: Generate research.md (resolve all NEEDS CLARIFICATION)
- Phase 1: Generate data-model.md, contracts/, quickstart.md
- Phase 1: Update agent context by running the agent script
- Re-evaluate Constitution Check post-design
4. **Stop and report**: Command ends after Phase 2 planning. Report branch, IMPL_PLAN path, and generated artifacts.
## Phases
### Phase 0: Outline & Research
1. **Extract unknowns from Technical Context** above:
- For each NEEDS CLARIFICATION → research task
- For each dependency → best practices task
- For each integration → patterns task
2. **Generate and dispatch research agents**:
```text
For each unknown in Technical Context:
Task: "Research {unknown} for {feature context}"
For each technology choice:
Task: "Find best practices for {tech} in {domain}"
```
3. **Consolidate findings** in `research.md` using format:
- Decision: [what was chosen]
- Rationale: [why chosen]
- Alternatives considered: [what else evaluated]
**Output**: research.md with all NEEDS CLARIFICATION resolved
### Phase 1: Design & Contracts
**Prerequisites:** `research.md` complete
1. **Extract entities from feature spec** → `data-model.md`:
- Entity name, fields, relationships
- Validation rules from requirements
- State transitions if applicable
2. **Generate API contracts** from functional requirements:
- For each user action → endpoint
- Use standard REST/GraphQL patterns
- Output OpenAPI/GraphQL schema to `/contracts/`
3. **Agent context update**:
- Run `.specify/scripts/bash/update-agent-context.sh opencode`
- These scripts detect which AI agent is in use
- Update the appropriate agent-specific context file
- Add only new technology from current plan
- Preserve manual additions between markers
**Output**: data-model.md, /contracts/*, quickstart.md, agent-specific file
## Key rules
- Use absolute paths
- ERROR on gate failures or unresolved clarifications

249
.opencode/command/speckit.specify.md Normal file
View file

@ -0,0 +1,249 @@
---
description: Create or update the feature specification from a natural language feature description.
---
## User Input
```text
$ARGUMENTS
```
You **MUST** consider the user input before proceeding (if not empty).
## Outline
The text the user typed after `/speckit.specify` in the triggering message **is** the feature description. Assume you always have it available in this conversation even if `$ARGUMENTS` appears literally below. Do not ask the user to repeat it unless they provided an empty command.
Given that feature description, do this:
1. **Generate a concise short name** (2-4 words) for the branch:
- Analyze the feature description and extract the most meaningful keywords
- Create a 2-4 word short name that captures the essence of the feature
- Use action-noun format when possible (e.g., "add-user-auth", "fix-payment-bug")
- Preserve technical terms and acronyms (OAuth2, API, JWT, etc.)
- Keep it concise but descriptive enough to understand the feature at a glance
- Examples:
- "I want to add user authentication" → "user-auth"
- "Implement OAuth2 integration for the API" → "oauth2-api-integration"
- "Create a dashboard for analytics" → "analytics-dashboard"
- "Fix payment processing timeout bug" → "fix-payment-timeout"
2. **Check for existing branches before creating new one**:
a. First, fetch all remote branches to ensure we have the latest information:
```bash
git fetch --all --prune
```
b. Find the highest feature number across all sources for the short-name:
- Remote branches: `git ls-remote --heads origin | grep -E 'refs/heads/[0-9]+-<short-name>$'`
- Local branches: `git branch | grep -E '^[* ]*[0-9]+-<short-name>$'`
- Specs directories: Check for directories matching `specs/[0-9]+-<short-name>`
c. Determine the next available number:
- Extract all numbers from all three sources
- Find the highest number N
- Use N+1 for the new branch number
d. Run the script `.specify/scripts/bash/create-new-feature.sh --json "$ARGUMENTS"` with the calculated number and short-name:
- Pass `--number N+1` and `--short-name "your-short-name"` along with the feature description
- Bash example: `.specify/scripts/bash/create-new-feature.sh --json "$ARGUMENTS" --json --number 5 --short-name "user-auth" "Add user authentication"`
- PowerShell example: `.specify/scripts/bash/create-new-feature.sh --json "$ARGUMENTS" -Json -Number 5 -ShortName "user-auth" "Add user authentication"`
**IMPORTANT**:
- Check all three sources (remote branches, local branches, specs directories) to find the highest number
- Only match branches/directories with the exact short-name pattern
- If no existing branches/directories found with this short-name, start with number 1
- You must only ever run this script once per feature
- The JSON is provided in the terminal as output - always refer to it to get the actual content you're looking for
- The JSON output will contain BRANCH_NAME and SPEC_FILE paths
- For single quotes in args like "I'm Groot", use escape syntax: e.g 'I'\''m Groot' (or double-quote if possible: "I'm Groot")
3. Load `.specify/templates/spec-template.md` to understand required sections.
4. Follow this execution flow:
1. Parse user description from Input
If empty: ERROR "No feature description provided"
2. Extract key concepts from description
Identify: actors, actions, data, constraints
3. For unclear aspects:
- Make informed guesses based on context and industry standards
- Only mark with [NEEDS CLARIFICATION: specific question] if:
- The choice significantly impacts feature scope or user experience
- Multiple reasonable interpretations exist with different implications
- No reasonable default exists
- **LIMIT: Maximum 3 [NEEDS CLARIFICATION] markers total**
- Prioritize clarifications by impact: scope > security/privacy > user experience > technical details
4. Fill User Scenarios & Testing section
If no clear user flow: ERROR "Cannot determine user scenarios"
5. Generate Functional Requirements
Each requirement must be testable
Use reasonable defaults for unspecified details (document assumptions in Assumptions section)
6. Define Success Criteria
Create measurable, technology-agnostic outcomes
Include both quantitative metrics (time, performance, volume) and qualitative measures (user satisfaction, task completion)
Each criterion must be verifiable without implementation details
7. Identify Key Entities (if data involved)
8. Return: SUCCESS (spec ready for planning)
5. Write the specification to SPEC_FILE using the template structure, replacing placeholders with concrete details derived from the feature description (arguments) while preserving section order and headings.
6. **Specification Quality Validation**: After writing the initial spec, validate it against quality criteria:
a. **Create Spec Quality Checklist**: Generate a checklist file at `FEATURE_DIR/checklists/requirements.md` using the checklist template structure with these validation items:
```markdown
# Specification Quality Checklist: [FEATURE NAME]
**Purpose**: Validate specification completeness and quality before proceeding to planning
**Created**: [DATE]
**Feature**: [Link to spec.md]
## Content Quality
- [ ] No implementation details (languages, frameworks, APIs)
- [ ] Focused on user value and business needs
- [ ] Written for non-technical stakeholders
- [ ] All mandatory sections completed
## Requirement Completeness
- [ ] No [NEEDS CLARIFICATION] markers remain
- [ ] Requirements are testable and unambiguous
- [ ] Success criteria are measurable
- [ ] Success criteria are technology-agnostic (no implementation details)
- [ ] All acceptance scenarios are defined
- [ ] Edge cases are identified
- [ ] Scope is clearly bounded
- [ ] Dependencies and assumptions identified
## Feature Readiness
- [ ] All functional requirements have clear acceptance criteria
- [ ] User scenarios cover primary flows
- [ ] Feature meets measurable outcomes defined in Success Criteria
- [ ] No implementation details leak into specification
## Notes
- Items marked incomplete require spec updates before `/speckit.clarify` or `/speckit.plan`
```
b. **Run Validation Check**: Review the spec against each checklist item:
- For each item, determine if it passes or fails
- Document specific issues found (quote relevant spec sections)
c. **Handle Validation Results**:
- **If all items pass**: Mark checklist complete and proceed to step 6
- **If items fail (excluding [NEEDS CLARIFICATION])**:
1. List the failing items and specific issues
2. Update the spec to address each issue
3. Re-run validation until all items pass (max 3 iterations)
4. If still failing after 3 iterations, document remaining issues in checklist notes and warn user
- **If [NEEDS CLARIFICATION] markers remain**:
1. Extract all [NEEDS CLARIFICATION: ...] markers from the spec
2. **LIMIT CHECK**: If more than 3 markers exist, keep only the 3 most critical (by scope/security/UX impact) and make informed guesses for the rest
3. For each clarification needed (max 3), present options to user in this format:
```markdown
## Question [N]: [Topic]
**Context**: [Quote relevant spec section]
**What we need to know**: [Specific question from NEEDS CLARIFICATION marker]
**Suggested Answers**:
| Option | Answer | Implications |
|--------|--------|--------------|
| A | [First suggested answer] | [What this means for the feature] |
| B | [Second suggested answer] | [What this means for the feature] |
| C | [Third suggested answer] | [What this means for the feature] |
| Custom | Provide your own answer | [Explain how to provide custom input] |
**Your choice**: _[Wait for user response]_
```
4. **CRITICAL - Table Formatting**: Ensure markdown tables are properly formatted:
- Use consistent spacing with pipes aligned
- Each cell should have spaces around content: `| Content |` not `|Content|`
- Header separator must have at least 3 dashes: `|--------|`
- Test that the table renders correctly in markdown preview
5. Number questions sequentially (Q1, Q2, Q3 - max 3 total)
6. Present all questions together before waiting for responses
7. Wait for user to respond with their choices for all questions (e.g., "Q1: A, Q2: Custom - [details], Q3: B")
8. Update the spec by replacing each [NEEDS CLARIFICATION] marker with the user's selected or provided answer
9. Re-run validation after all clarifications are resolved
d. **Update Checklist**: After each validation iteration, update the checklist file with current pass/fail status
7. Report completion with branch name, spec file path, checklist results, and readiness for the next phase (`/speckit.clarify` or `/speckit.plan`).
**NOTE:** The script creates and checks out the new branch and initializes the spec file before writing.
## General Guidelines
## Quick Guidelines
- Focus on **WHAT** users need and **WHY**.
- Avoid HOW to implement (no tech stack, APIs, code structure).
- Written for business stakeholders, not developers.
- DO NOT create any checklists that are embedded in the spec. That will be a separate command.
### Section Requirements
- **Mandatory sections**: Must be completed for every feature
- **Optional sections**: Include only when relevant to the feature
- When a section doesn't apply, remove it entirely (don't leave as "N/A")
### For AI Generation
When creating this spec from a user prompt:
1. **Make informed guesses**: Use context, industry standards, and common patterns to fill gaps
2. **Document assumptions**: Record reasonable defaults in the Assumptions section
3. **Limit clarifications**: Maximum 3 [NEEDS CLARIFICATION] markers - use only for critical decisions that:
- Significantly impact feature scope or user experience
- Have multiple reasonable interpretations with different implications
- Lack any reasonable default
4. **Prioritize clarifications**: scope > security/privacy > user experience > technical details
5. **Think like a tester**: Every vague requirement should fail the "testable and unambiguous" checklist item
6. **Common areas needing clarification** (only if no reasonable default exists):
- Feature scope and boundaries (include/exclude specific use cases)
- User types and permissions (if multiple conflicting interpretations possible)
- Security/compliance requirements (when legally/financially significant)
**Examples of reasonable defaults** (don't ask about these):
- Data retention: Industry-standard practices for the domain
- Performance targets: Standard web/mobile app expectations unless specified
- Error handling: User-friendly messages with appropriate fallbacks
- Authentication method: Standard session-based or OAuth2 for web apps
- Integration patterns: RESTful APIs unless specified otherwise
### Success Criteria Guidelines
Success criteria must be:
1. **Measurable**: Include specific metrics (time, percentage, count, rate)
2. **Technology-agnostic**: No mention of frameworks, languages, databases, or tools
3. **User-focused**: Describe outcomes from user/business perspective, not system internals
4. **Verifiable**: Can be tested/validated without knowing implementation details
**Good examples**:
- "Users can complete checkout in under 3 minutes"
- "System supports 10,000 concurrent users"
- "95% of searches return results in under 1 second"
- "Task completion rate improves by 40%"
**Bad examples** (implementation-focused):
- "API response time is under 200ms" (too technical, use "Users see results instantly")
- "Database can handle 1000 TPS" (implementation detail, use user-facing metric)
- "React components render efficiently" (framework-specific)
- "Redis cache hit rate above 80%" (technology-specific)

128
.opencode/command/speckit.tasks.md Normal file
View file

@ -0,0 +1,128 @@
---
description: Generate an actionable, dependency-ordered tasks.md for the feature based on available design artifacts.
---
## User Input
```text
$ARGUMENTS
```
You **MUST** consider the user input before proceeding (if not empty).
## Outline
1. **Setup**: Run `.specify/scripts/bash/check-prerequisites.sh --json` from repo root and parse FEATURE_DIR and AVAILABLE_DOCS list. All paths must be absolute. For single quotes in args like "I'm Groot", use escape syntax: e.g 'I'\''m Groot' (or double-quote if possible: "I'm Groot").
2. **Load design documents**: Read from FEATURE_DIR:
- **Required**: plan.md (tech stack, libraries, structure), spec.md (user stories with priorities)
- **Optional**: data-model.md (entities), contracts/ (API endpoints), research.md (decisions), quickstart.md (test scenarios)
- Note: Not all projects have all documents. Generate tasks based on what's available.
3. **Execute task generation workflow**:
- Load plan.md and extract tech stack, libraries, project structure
- Load spec.md and extract user stories with their priorities (P1, P2, P3, etc.)
- If data-model.md exists: Extract entities and map to user stories
- If contracts/ exists: Map endpoints to user stories
- If research.md exists: Extract decisions for setup tasks
- Generate tasks organized by user story (see Task Generation Rules below)
- Generate dependency graph showing user story completion order
- Create parallel execution examples per user story
- Validate task completeness (each user story has all needed tasks, independently testable)
4. **Generate tasks.md**: Use `.specify.specify/templates/tasks-template.md` as structure, fill with:
- Correct feature name from plan.md
- Phase 1: Setup tasks (project initialization)
- Phase 2: Foundational tasks (blocking prerequisites for all user stories)
- Phase 3+: One phase per user story (in priority order from spec.md)
- Each phase includes: story goal, independent test criteria, tests (if requested), implementation tasks
- Final Phase: Polish & cross-cutting concerns
- All tasks must follow the strict checklist format (see Task Generation Rules below)
- Clear file paths for each task
- Dependencies section showing story completion order
- Parallel execution examples per story
- Implementation strategy section (MVP first, incremental delivery)
5. **Report**: Output path to generated tasks.md and summary:
- Total task count
- Task count per user story
- Parallel opportunities identified
- Independent test criteria for each story
- Suggested MVP scope (typically just User Story 1)
- Format validation: Confirm ALL tasks follow the checklist format (checkbox, ID, labels, file paths)
Context for task generation: $ARGUMENTS
The tasks.md should be immediately executable - each task must be specific enough that an LLM can complete it without additional context.
## Task Generation Rules
**CRITICAL**: Tasks MUST be organized by user story to enable independent implementation and testing.
**Tests are OPTIONAL**: Only generate test tasks if explicitly requested in the feature specification or if user requests TDD approach.
### Checklist Format (REQUIRED)
Every task MUST strictly follow this format:
```text
- [ ] [TaskID] [P?] [Story?] Description with file path
```
**Format Components**:
1. **Checkbox**: ALWAYS start with `- [ ]` (markdown checkbox)
2. **Task ID**: Sequential number (T001, T002, T003...) in execution order
3. **[P] marker**: Include ONLY if task is parallelizable (different files, no dependencies on incomplete tasks)
4. **[Story] label**: REQUIRED for user story phase tasks only
- Format: [US1], [US2], [US3], etc. (maps to user stories from spec.md)
- Setup phase: NO story label
- Foundational phase: NO story label
- User Story phases: MUST have story label
- Polish phase: NO story label
5. **Description**: Clear action with exact file path
**Examples**:
- ✅ CORRECT: `- [ ] T001 Create project structure per implementation plan`
- ✅ CORRECT: `- [ ] T005 [P] Implement authentication middleware in src/middleware/auth.py`
- ✅ CORRECT: `- [ ] T012 [P] [US1] Create User model in src/models/user.py`
- ✅ CORRECT: `- [ ] T014 [US1] Implement UserService in src/services/user_service.py`
- ❌ WRONG: `- [ ] Create User model` (missing ID and Story label)
- ❌ WRONG: `T001 [US1] Create model` (missing checkbox)
- ❌ WRONG: `- [ ] [US1] Create User model` (missing Task ID)
- ❌ WRONG: `- [ ] T001 [US1] Create model` (missing file path)
### Task Organization
1. **From User Stories (spec.md)** - PRIMARY ORGANIZATION:
- Each user story (P1, P2, P3...) gets its own phase
- Map all related components to their story:
- Models needed for that story
- Services needed for that story
- Endpoints/UI needed for that story
- If tests requested: Tests specific to that story
- Mark story dependencies (most stories should be independent)
2. **From Contracts**:
- Map each contract/endpoint → to the user story it serves
- If tests requested: Each contract → contract test task [P] before implementation in that story's phase
3. **From Data Model**:
- Map each entity to the user story(ies) that need it
- If entity serves multiple stories: Put in earliest story or Setup phase
- Relationships → service layer tasks in appropriate story phase
4. **From Setup/Infrastructure**:
- Shared infrastructure → Setup phase (Phase 1)
- Foundational/blocking tasks → Foundational phase (Phase 2)
- Story-specific setup → within that story's phase
### Phase Structure
- **Phase 1**: Setup (project initialization)
- **Phase 2**: Foundational (blocking prerequisites - MUST complete before user stories)
- **Phase 3+**: User Stories in priority order (P1, P2, P3...)
- Within each story: Tests (if requested) → Models → Services → Endpoints → Integration
- Each phase should be a complete, independently testable increment
- **Final Phase**: Polish & Cross-Cutting Concerns

50
.specify/memory/constitution.md Normal file
View file

@ -0,0 +1,50 @@
# [PROJECT_NAME] Constitution
<!-- Example: Spec Constitution, TaskFlow Constitution, etc. -->
## Core Principles
### [PRINCIPLE_1_NAME]
<!-- Example: I. Library-First -->
[PRINCIPLE_1_DESCRIPTION]
<!-- Example: Every feature starts as a standalone library; Libraries must be self-contained, independently testable, documented; Clear purpose required - no organizational-only libraries -->
### [PRINCIPLE_2_NAME]
<!-- Example: II. CLI Interface -->
[PRINCIPLE_2_DESCRIPTION]
<!-- Example: Every library exposes functionality via CLI; Text in/out protocol: stdin/args → stdout, errors → stderr; Support JSON + human-readable formats -->
### [PRINCIPLE_3_NAME]
<!-- Example: III. Test-First (NON-NEGOTIABLE) -->
[PRINCIPLE_3_DESCRIPTION]
<!-- Example: TDD mandatory: Tests written → User approved → Tests fail → Then implement; Red-Green-Refactor cycle strictly enforced -->
### [PRINCIPLE_4_NAME]
<!-- Example: IV. Integration Testing -->
[PRINCIPLE_4_DESCRIPTION]
<!-- Example: Focus areas requiring integration tests: New library contract tests, Contract changes, Inter-service communication, Shared schemas -->
### [PRINCIPLE_5_NAME]
<!-- Example: V. Observability, VI. Versioning & Breaking Changes, VII. Simplicity -->
[PRINCIPLE_5_DESCRIPTION]
<!-- Example: Text I/O ensures debuggability; Structured logging required; Or: MAJOR.MINOR.BUILD format; Or: Start simple, YAGNI principles -->
## [SECTION_2_NAME]
<!-- Example: Additional Constraints, Security Requirements, Performance Standards, etc. -->
[SECTION_2_CONTENT]
<!-- Example: Technology stack requirements, compliance standards, deployment policies, etc. -->
## [SECTION_3_NAME]
<!-- Example: Development Workflow, Review Process, Quality Gates, etc. -->
[SECTION_3_CONTENT]
<!-- Example: Code review requirements, testing gates, deployment approval process, etc. -->
## Governance
<!-- Example: Constitution supersedes all other practices; Amendments require documentation, approval, migration plan -->
[GOVERNANCE_RULES]
<!-- Example: All PRs/reviews must verify compliance; Complexity must be justified; Use [GUIDANCE_FILE] for runtime development guidance -->
**Version**: [CONSTITUTION_VERSION] | **Ratified**: [RATIFICATION_DATE] | **Last Amended**: [LAST_AMENDED_DATE]
<!-- Example: Version: 2.1.1 | Ratified: 2025-06-13 | Last Amended: 2025-07-16 -->

166
.specify/scripts/bash/check-prerequisites.sh Executable file
View file

@ -0,0 +1,166 @@
#!/usr/bin/env bash
# Consolidated prerequisite checking script
#
# This script provides unified prerequisite checking for Spec-Driven Development workflow.
# It replaces the functionality previously spread across multiple scripts.
#
# Usage: ./check-prerequisites.sh [OPTIONS]
#
# OPTIONS:
# --json Output in JSON format
# --require-tasks Require tasks.md to exist (for implementation phase)
# --include-tasks Include tasks.md in AVAILABLE_DOCS list
# --paths-only Only output path variables (no validation)
# --help, -h Show help message
#
# OUTPUTS:
# JSON mode: {"FEATURE_DIR":"...", "AVAILABLE_DOCS":["..."]}
# Text mode: FEATURE_DIR:... \n AVAILABLE_DOCS: \n ✓/✗ file.md
# Paths only: REPO_ROOT: ... \n BRANCH: ... \n FEATURE_DIR: ... etc.
set -e
# Parse command line arguments
JSON_MODE=false
REQUIRE_TASKS=false
INCLUDE_TASKS=false
PATHS_ONLY=false
for arg in "$@"; do
case "$arg" in
--json)
JSON_MODE=true
;;
--require-tasks)
REQUIRE_TASKS=true
;;
--include-tasks)
INCLUDE_TASKS=true
;;
--paths-only)
PATHS_ONLY=true
;;
--help|-h)
cat << 'EOF'
Usage: check-prerequisites.sh [OPTIONS]
Consolidated prerequisite checking for Spec-Driven Development workflow.
OPTIONS:
--json Output in JSON format
--require-tasks Require tasks.md to exist (for implementation phase)
--include-tasks Include tasks.md in AVAILABLE_DOCS list
--paths-only Only output path variables (no prerequisite validation)
--help, -h Show this help message
EXAMPLES:
# Check task prerequisites (plan.md required)
./check-prerequisites.sh --json
# Check implementation prerequisites (plan.md + tasks.md required)
./check-prerequisites.sh --json --require-tasks --include-tasks
# Get feature paths only (no validation)
./check-prerequisites.sh --paths-only
EOF
exit 0
;;
*)
echo "ERROR: Unknown option '$arg'. Use --help for usage information." >&2
exit 1
;;
esac
done
# Source common functions
SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
source "$SCRIPT_DIR/common.sh"
# Get feature paths and validate branch
eval $(get_feature_paths)
check_feature_branch "$CURRENT_BRANCH" "$HAS_GIT" || exit 1
# If paths-only mode, output paths and exit (support JSON + paths-only combined)
if $PATHS_ONLY; then
if $JSON_MODE; then
# Minimal JSON paths payload (no validation performed)
printf '{"REPO_ROOT":"%s","BRANCH":"%s","FEATURE_DIR":"%s","FEATURE_SPEC":"%s","IMPL_PLAN":"%s","TASKS":"%s"}\n' \
"$REPO_ROOT" "$CURRENT_BRANCH" "$FEATURE_DIR" "$FEATURE_SPEC" "$IMPL_PLAN" "$TASKS"
else
echo "REPO_ROOT: $REPO_ROOT"
echo "BRANCH: $CURRENT_BRANCH"
echo "FEATURE_DIR: $FEATURE_DIR"
echo "FEATURE_SPEC: $FEATURE_SPEC"
echo "IMPL_PLAN: $IMPL_PLAN"
echo "TASKS: $TASKS"
fi
exit 0
fi
# Validate required directories and files
if [[ ! -d "$FEATURE_DIR" ]]; then
echo "ERROR: Feature directory not found: $FEATURE_DIR" >&2
echo "Run /speckit.specify first to create the feature structure." >&2
exit 1
fi
if [[ ! -f "$IMPL_PLAN" ]]; then
echo "ERROR: plan.md not found in $FEATURE_DIR" >&2
echo "Run /speckit.plan first to create the implementation plan." >&2
exit 1
fi
# Check for tasks.md if required
if $REQUIRE_TASKS && [[ ! -f "$TASKS" ]]; then
echo "ERROR: tasks.md not found in $FEATURE_DIR" >&2
echo "Run /speckit.tasks first to create the task list." >&2
exit 1
fi
# Build list of available documents
docs=()
# Always check these optional docs
[[ -f "$RESEARCH" ]] && docs+=("research.md")
[[ -f "$DATA_MODEL" ]] && docs+=("data-model.md")
# Check contracts directory (only if it exists and has files)
if [[ -d "$CONTRACTS_DIR" ]] && [[ -n "$(ls -A "$CONTRACTS_DIR" 2>/dev/null)" ]]; then
docs+=("contracts/")
fi
[[ -f "$QUICKSTART" ]] && docs+=("quickstart.md")
# Include tasks.md if requested and it exists
if $INCLUDE_TASKS && [[ -f "$TASKS" ]]; then
docs+=("tasks.md")
fi
# Output results
if $JSON_MODE; then
# Build JSON array of documents
if [[ ${#docs[@]} -eq 0 ]]; then
json_docs="[]"
else
json_docs=$(printf '"%s",' "${docs[@]}")
json_docs="[${json_docs%,}]"
fi
printf '{"FEATURE_DIR":"%s","AVAILABLE_DOCS":%s}\n' "$FEATURE_DIR" "$json_docs"
else
# Text output
echo "FEATURE_DIR:$FEATURE_DIR"
echo "AVAILABLE_DOCS:"
# Show status of each potential document
check_file "$RESEARCH" "research.md"
check_file "$DATA_MODEL" "data-model.md"
check_dir "$CONTRACTS_DIR" "contracts/"
check_file "$QUICKSTART" "quickstart.md"
if $INCLUDE_TASKS; then
check_file "$TASKS" "tasks.md"
fi
fi

156
.specify/scripts/bash/common.sh Executable file
View file

@ -0,0 +1,156 @@
#!/usr/bin/env bash
# Common functions and variables for all scripts
# Get repository root, with fallback for non-git repositories
get_repo_root() {
if git rev-parse --show-toplevel >/dev/null 2>&1; then
git rev-parse --show-toplevel
else
# Fall back to script location for non-git repos
local script_dir="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
(cd "$script_dir/../../.." && pwd)
fi
}
# Get current branch, with fallback for non-git repositories
get_current_branch() {
# First check if SPECIFY_FEATURE environment variable is set
if [[ -n "${SPECIFY_FEATURE:-}" ]]; then
echo "$SPECIFY_FEATURE"
return
fi
# Then check git if available
if git rev-parse --abbrev-ref HEAD >/dev/null 2>&1; then
git rev-parse --abbrev-ref HEAD
return
fi
# For non-git repos, try to find the latest feature directory
local repo_root=$(get_repo_root)
local specs_dir="$repo_root/specs"
if [[ -d "$specs_dir" ]]; then
local latest_feature=""
local highest=0
for dir in "$specs_dir"/*; do
if [[ -d "$dir" ]]; then
local dirname=$(basename "$dir")
if [[ "$dirname" =~ ^([0-9]{3})- ]]; then
local number=${BASH_REMATCH[1]}
number=$((10#$number))
if [[ "$number" -gt "$highest" ]]; then
highest=$number
latest_feature=$dirname
fi
fi
fi
done
if [[ -n "$latest_feature" ]]; then
echo "$latest_feature"
return
fi
fi
echo "main" # Final fallback
}
# Check if we have git available
has_git() {
git rev-parse --show-toplevel >/dev/null 2>&1
}
check_feature_branch() {
local branch="$1"
local has_git_repo="$2"
# For non-git repos, we can't enforce branch naming but still provide output
if [[ "$has_git_repo" != "true" ]]; then
echo "[specify] Warning: Git repository not detected; skipped branch validation" >&2
return 0
fi
if [[ ! "$branch" =~ ^[0-9]{3}- ]]; then
echo "ERROR: Not on a feature branch. Current branch: $branch" >&2
echo "Feature branches should be named like: 001-feature-name" >&2
return 1
fi
return 0
}
get_feature_dir() { echo "$1/specs/$2"; }
# Find feature directory by numeric prefix instead of exact branch match
# This allows multiple branches to work on the same spec (e.g., 004-fix-bug, 004-add-feature)
find_feature_dir_by_prefix() {
local repo_root="$1"
local branch_name="$2"
local specs_dir="$repo_root/specs"
# Extract numeric prefix from branch (e.g., "004" from "004-whatever")
if [[ ! "$branch_name" =~ ^([0-9]{3})- ]]; then
# If branch doesn't have numeric prefix, fall back to exact match
echo "$specs_dir/$branch_name"
return
fi
local prefix="${BASH_REMATCH[1]}"
# Search for directories in specs/ that start with this prefix
local matches=()
if [[ -d "$specs_dir" ]]; then
for dir in "$specs_dir"/"$prefix"-*; do
if [[ -d "$dir" ]]; then
matches+=("$(basename "$dir")")
fi
done
fi
# Handle results
if [[ ${#matches[@]} -eq 0 ]]; then
# No match found - return the branch name path (will fail later with clear error)
echo "$specs_dir/$branch_name"
elif [[ ${#matches[@]} -eq 1 ]]; then
# Exactly one match - perfect!
echo "$specs_dir/${matches[0]}"
else
# Multiple matches - this shouldn't happen with proper naming convention
echo "ERROR: Multiple spec directories found with prefix '$prefix': ${matches[*]}" >&2
echo "Please ensure only one spec directory exists per numeric prefix." >&2
echo "$specs_dir/$branch_name" # Return something to avoid breaking the script
fi
}
get_feature_paths() {
local repo_root=$(get_repo_root)
local current_branch=$(get_current_branch)
local has_git_repo="false"
if has_git; then
has_git_repo="true"
fi
# Use prefix-based lookup to support multiple branches per spec
local feature_dir=$(find_feature_dir_by_prefix "$repo_root" "$current_branch")
cat <<EOF
REPO_ROOT='$repo_root'
CURRENT_BRANCH='$current_branch'
HAS_GIT='$has_git_repo'
FEATURE_DIR='$feature_dir'
FEATURE_SPEC='$feature_dir/spec.md'
IMPL_PLAN='$feature_dir/plan.md'
TASKS='$feature_dir/tasks.md'
RESEARCH='$feature_dir/research.md'
DATA_MODEL='$feature_dir/data-model.md'
QUICKSTART='$feature_dir/quickstart.md'
CONTRACTS_DIR='$feature_dir/contracts'
EOF
}
check_file() { [[ -f "$1" ]] && echo " ✓ $2" || echo " ✗ $2"; }
check_dir() { [[ -d "$1" && -n $(ls -A "$1" 2>/dev/null) ]] && echo " ✓ $2" || echo " ✗ $2"; }

260
.specify/scripts/bash/create-new-feature.sh Executable file
View file

@ -0,0 +1,260 @@
#!/usr/bin/env bash
set -e
JSON_MODE=false
SHORT_NAME=""
BRANCH_NUMBER=""
ARGS=()
i=1
while [ $i -le $# ]; do
arg="${!i}"
case "$arg" in
--json)
JSON_MODE=true
;;
--short-name)
if [ $((i + 1)) -gt $# ]; then
echo 'Error: --short-name requires a value' >&2
exit 1
fi
i=$((i + 1))
next_arg="${!i}"
# Check if the next argument is another option (starts with --)
if [[ "$next_arg" == --* ]]; then
echo 'Error: --short-name requires a value' >&2
exit 1
fi
SHORT_NAME="$next_arg"
;;
--number)
if [ $((i + 1)) -gt $# ]; then
echo 'Error: --number requires a value' >&2
exit 1
fi
i=$((i + 1))
next_arg="${!i}"
if [[ "$next_arg" == --* ]]; then
echo 'Error: --number requires a value' >&2
exit 1
fi
BRANCH_NUMBER="$next_arg"
;;
--help|-h)
echo "Usage: $0 [--json] [--short-name <name>] [--number N] <feature_description>"
echo ""
echo "Options:"
echo " --json Output in JSON format"
echo " --short-name <name> Provide a custom short name (2-4 words) for the branch"
echo " --number N Specify branch number manually (overrides auto-detection)"
echo " --help, -h Show this help message"
echo ""
echo "Examples:"
echo " $0 'Add user authentication system' --short-name 'user-auth'"
echo " $0 'Implement OAuth2 integration for API' --number 5"
exit 0
;;
*)
ARGS+=("$arg")
;;
esac
i=$((i + 1))
done
FEATURE_DESCRIPTION="${ARGS[*]}"
if [ -z "$FEATURE_DESCRIPTION" ]; then
echo "Usage: $0 [--json] [--short-name <name>] [--number N] <feature_description>" >&2
exit 1
fi
# Function to find the repository root by searching for existing project markers
find_repo_root() {
local dir="$1"
while [ "$dir" != "/" ]; do
if [ -d "$dir/.git" ] || [ -d "$dir/.specify" ]; then
echo "$dir"
return 0
fi
dir="$(dirname "$dir")"
done
return 1
}
# Function to check existing branches (local and remote) and return next available number
check_existing_branches() {
local short_name="$1"
# Fetch all remotes to get latest branch info (suppress errors if no remotes)
git fetch --all --prune 2>/dev/null || true
# Find all branches matching the pattern using git ls-remote (more reliable)
local remote_branches=$(git ls-remote --heads origin 2>/dev/null | grep -E "refs/heads/[0-9]+-${short_name}$" | sed 's/.*\/\([0-9]*\)-.*/\1/' | sort -n)
# Also check local branches
local local_branches=$(git branch 2>/dev/null | grep -E "^[* ]*[0-9]+-${short_name}$" | sed 's/^[* ]*//' | sed 's/-.*//' | sort -n)
# Check specs directory as well
local spec_dirs=""
if [ -d "$SPECS_DIR" ]; then
spec_dirs=$(find "$SPECS_DIR" -maxdepth 1 -type d -name "[0-9]*-${short_name}" 2>/dev/null | xargs -n1 basename 2>/dev/null | sed 's/-.*//' | sort -n)
fi
# Combine all sources and get the highest number
local max_num=0
for num in $remote_branches $local_branches $spec_dirs; do
if [ "$num" -gt "$max_num" ]; then
max_num=$num
fi
done
# Return next number
echo $((max_num + 1))
}
# Resolve repository root. Prefer git information when available, but fall back
# to searching for repository markers so the workflow still functions in repositories that
# were initialised with --no-git.
SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
if git rev-parse --show-toplevel >/dev/null 2>&1; then
REPO_ROOT=$(git rev-parse --show-toplevel)
HAS_GIT=true
else
REPO_ROOT="$(find_repo_root "$SCRIPT_DIR")"
if [ -z "$REPO_ROOT" ]; then
echo "Error: Could not determine repository root. Please run this script from within the repository." >&2
exit 1
fi
HAS_GIT=false
fi
cd "$REPO_ROOT"
SPECS_DIR="$REPO_ROOT/specs"
mkdir -p "$SPECS_DIR"
# Function to generate branch name with stop word filtering and length filtering
generate_branch_name() {
local description="$1"
# Common stop words to filter out
local stop_words="^(i|a|an|the|to|for|of|in|on|at|by|with|from|is|are|was|were|be|been|being|have|has|had|do|does|did|will|would|should|could|can|may|might|must|shall|this|that|these|those|my|your|our|their|want|need|add|get|set)$"
# Convert to lowercase and split into words
local clean_name=$(echo "$description" | tr '[:upper:]' '[:lower:]' | sed 's/[^a-z0-9]/ /g')
# Filter words: remove stop words and words shorter than 3 chars (unless they're uppercase acronyms in original)
local meaningful_words=()
for word in $clean_name; do
# Skip empty words
[ -z "$word" ] && continue
# Keep words that are NOT stop words AND (length >= 3 OR are potential acronyms)
if ! echo "$word" | grep -qiE "$stop_words"; then
if [ ${#word} -ge 3 ]; then
meaningful_words+=("$word")
elif echo "$description" | grep -q "\b${word^^}\b"; then
# Keep short words if they appear as uppercase in original (likely acronyms)
meaningful_words+=("$word")
fi
fi
done
# If we have meaningful words, use first 3-4 of them
if [ ${#meaningful_words[@]} -gt 0 ]; then
local max_words=3
if [ ${#meaningful_words[@]} -eq 4 ]; then max_words=4; fi
local result=""
local count=0
for word in "${meaningful_words[@]}"; do
if [ $count -ge $max_words ]; then break; fi
if [ -n "$result" ]; then result="$result-"; fi
result="$result$word"
count=$((count + 1))
done
echo "$result"
else
# Fallback to original logic if no meaningful words found
echo "$description" | tr '[:upper:]' '[:lower:]' | sed 's/[^a-z0-9]/-/g' | sed 's/-\+/-/g' | sed 's/^-//' | sed 's/-$//' | tr '-' '\n' | grep -v '^$' | head -3 | tr '\n' '-' | sed 's/-$//'
fi
}
# Generate branch name
if [ -n "$SHORT_NAME" ]; then
# Use provided short name, just clean it up
BRANCH_SUFFIX=$(echo "$SHORT_NAME" | tr '[:upper:]' '[:lower:]' | sed 's/[^a-z0-9]/-/g' | sed 's/-\+/-/g' | sed 's/^-//' | sed 's/-$//')
else
# Generate from description with smart filtering
BRANCH_SUFFIX=$(generate_branch_name "$FEATURE_DESCRIPTION")
fi
# Determine branch number
if [ -z "$BRANCH_NUMBER" ]; then
if [ "$HAS_GIT" = true ]; then
# Check existing branches on remotes
BRANCH_NUMBER=$(check_existing_branches "$BRANCH_SUFFIX")
else
# Fall back to local directory check
HIGHEST=0
if [ -d "$SPECS_DIR" ]; then
for dir in "$SPECS_DIR"/*; do
[ -d "$dir" ] || continue
dirname=$(basename "$dir")
number=$(echo "$dirname" | grep -o '^[0-9]\+' || echo "0")
number=$((10#$number))
if [ "$number" -gt "$HIGHEST" ]; then HIGHEST=$number; fi
done
fi
BRANCH_NUMBER=$((HIGHEST + 1))
fi
fi
FEATURE_NUM=$(printf "%03d" "$BRANCH_NUMBER")
BRANCH_NAME="${FEATURE_NUM}-${BRANCH_SUFFIX}"
# GitHub enforces a 244-byte limit on branch names
# Validate and truncate if necessary
MAX_BRANCH_LENGTH=244
if [ ${#BRANCH_NAME} -gt $MAX_BRANCH_LENGTH ]; then
# Calculate how much we need to trim from suffix
# Account for: feature number (3) + hyphen (1) = 4 chars
MAX_SUFFIX_LENGTH=$((MAX_BRANCH_LENGTH - 4))
# Truncate suffix at word boundary if possible
TRUNCATED_SUFFIX=$(echo "$BRANCH_SUFFIX" | cut -c1-$MAX_SUFFIX_LENGTH)
# Remove trailing hyphen if truncation created one
TRUNCATED_SUFFIX=$(echo "$TRUNCATED_SUFFIX" | sed 's/-$//')
ORIGINAL_BRANCH_NAME="$BRANCH_NAME"
BRANCH_NAME="${FEATURE_NUM}-${TRUNCATED_SUFFIX}"
>&2 echo "[specify] Warning: Branch name exceeded GitHub's 244-byte limit"
>&2 echo "[specify] Original: $ORIGINAL_BRANCH_NAME (${#ORIGINAL_BRANCH_NAME} bytes)"
>&2 echo "[specify] Truncated to: $BRANCH_NAME (${#BRANCH_NAME} bytes)"
fi
if [ "$HAS_GIT" = true ]; then
git checkout -b "$BRANCH_NAME"
else
>&2 echo "[specify] Warning: Git repository not detected; skipped branch creation for $BRANCH_NAME"
fi
FEATURE_DIR="$SPECS_DIR/$BRANCH_NAME"
mkdir -p "$FEATURE_DIR"
TEMPLATE="$REPO_ROOT/.specify/templates/spec-template.md"
SPEC_FILE="$FEATURE_DIR/spec.md"
if [ -f "$TEMPLATE" ]; then cp "$TEMPLATE" "$SPEC_FILE"; else touch "$SPEC_FILE"; fi
# Set the SPECIFY_FEATURE environment variable for the current session
export SPECIFY_FEATURE="$BRANCH_NAME"
if $JSON_MODE; then
printf '{"BRANCH_NAME":"%s","SPEC_FILE":"%s","FEATURE_NUM":"%s"}\n' "$BRANCH_NAME" "$SPEC_FILE" "$FEATURE_NUM"
else
echo "BRANCH_NAME: $BRANCH_NAME"
echo "SPEC_FILE: $SPEC_FILE"
echo "FEATURE_NUM: $FEATURE_NUM"
echo "SPECIFY_FEATURE environment variable set to: $BRANCH_NAME"
fi

61
.specify/scripts/bash/setup-plan.sh Executable file
View file

@ -0,0 +1,61 @@
#!/usr/bin/env bash
set -e
# Parse command line arguments
JSON_MODE=false
ARGS=()
for arg in "$@"; do
case "$arg" in
--json)
JSON_MODE=true
;;
--help|-h)
echo "Usage: $0 [--json]"
echo " --json Output results in JSON format"
echo " --help Show this help message"
exit 0
;;
*)
ARGS+=("$arg")
;;
esac
done
# Get script directory and load common functions
SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
source "$SCRIPT_DIR/common.sh"
# Get all paths and variables from common functions
eval $(get_feature_paths)
# Check if we're on a proper feature branch (only for git repos)
check_feature_branch "$CURRENT_BRANCH" "$HAS_GIT" || exit 1
# Ensure the feature directory exists
mkdir -p "$FEATURE_DIR"
# Copy plan template if it exists
TEMPLATE="$REPO_ROOT/.specify/templates/plan-template.md"
if [[ -f "$TEMPLATE" ]]; then
cp "$TEMPLATE" "$IMPL_PLAN"
echo "Copied plan template to $IMPL_PLAN"
else
echo "Warning: Plan template not found at $TEMPLATE"
# Create a basic plan file if template doesn't exist
touch "$IMPL_PLAN"
fi
# Output results
if $JSON_MODE; then
printf '{"FEATURE_SPEC":"%s","IMPL_PLAN":"%s","SPECS_DIR":"%s","BRANCH":"%s","HAS_GIT":"%s"}\n' \
"$FEATURE_SPEC" "$IMPL_PLAN" "$FEATURE_DIR" "$CURRENT_BRANCH" "$HAS_GIT"
else
echo "FEATURE_SPEC: $FEATURE_SPEC"
echo "IMPL_PLAN: $IMPL_PLAN"
echo "SPECS_DIR: $FEATURE_DIR"
echo "BRANCH: $CURRENT_BRANCH"
echo "HAS_GIT: $HAS_GIT"
fi

772
.specify/scripts/bash/update-agent-context.sh Executable file
View file

@ -0,0 +1,772 @@
#!/usr/bin/env bash
# Update agent context files with information from plan.md
#
# This script maintains AI agent context files by parsing feature specifications
# and updating agent-specific configuration files with project information.
#
# MAIN FUNCTIONS:
# 1. Environment Validation
# - Verifies git repository structure and branch information
# - Checks for required plan.md files and templates
# - Validates file permissions and accessibility
#
# 2. Plan Data Extraction
# - Parses plan.md files to extract project metadata
# - Identifies language/version, frameworks, databases, and project types
# - Handles missing or incomplete specification data gracefully
#
# 3. Agent File Management
# - Creates new agent context files from templates when needed
# - Updates existing agent files with new project information
# - Preserves manual additions and custom configurations
# - Supports multiple AI agent formats and directory structures
#
# 4. Content Generation
# - Generates language-specific build/test commands
# - Creates appropriate project directory structures
# - Updates technology stacks and recent changes sections
# - Maintains consistent formatting and timestamps
#
# 5. Multi-Agent Support
# - Handles agent-specific file paths and naming conventions
# - Supports: Claude, Gemini, Copilot, Cursor, Qwen, opencode, Codex, Windsurf, Kilo Code, Auggie CLI, Roo Code, CodeBuddy CLI, Amp, or Amazon Q Developer CLI
# - Can update single agents or all existing agent files
# - Creates default Claude file if no agent files exist
#
# Usage: ./update-agent-context.sh [agent_type]
# Agent types: claude|gemini|copilot|cursor-agent|qwen|opencode|codex|windsurf|kilocode|auggie|q
# Leave empty to update all existing agent files
set -e
# Enable strict error handling
set -u
set -o pipefail
#==============================================================================
# Configuration and Global Variables
#==============================================================================
# Get script directory and load common functions
SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
source "$SCRIPT_DIR/common.sh"
# Get all paths and variables from common functions
eval $(get_feature_paths)
NEW_PLAN="$IMPL_PLAN" # Alias for compatibility with existing code
AGENT_TYPE="${1:-}"
# Agent-specific file paths
CLAUDE_FILE="$REPO_ROOT/CLAUDE.md"
GEMINI_FILE="$REPO_ROOT/GEMINI.md"
COPILOT_FILE="$REPO_ROOT/.github/copilot-instructions.md"
CURSOR_FILE="$REPO_ROOT/.cursor/rules/specify-rules.mdc"
QWEN_FILE="$REPO_ROOT/QWEN.md"
AGENTS_FILE="$REPO_ROOT/AGENTS.md"
WINDSURF_FILE="$REPO_ROOT/.windsurf/rules/specify-rules.md"
KILOCODE_FILE="$REPO_ROOT/.kilocode/rules/specify-rules.md"
AUGGIE_FILE="$REPO_ROOT/.augment/rules/specify-rules.md"
ROO_FILE="$REPO_ROOT/.roo/rules/specify-rules.md"
CODEBUDDY_FILE="$REPO_ROOT/CODEBUDDY.md"
AMP_FILE="$REPO_ROOT/AGENTS.md"
Q_FILE="$REPO_ROOT/AGENTS.md"
# Template file
TEMPLATE_FILE="$REPO_ROOT/.specify/templates/agent-file-template.md"
# Global variables for parsed plan data
NEW_LANG=""
NEW_FRAMEWORK=""
NEW_DB=""
NEW_PROJECT_TYPE=""
#==============================================================================
# Utility Functions
#==============================================================================
log_info() {
echo "INFO: $1"
}
log_success() {
echo "✓ $1"
}
log_error() {
echo "ERROR: $1" >&2
}
log_warning() {
echo "WARNING: $1" >&2
}
# Cleanup function for temporary files
cleanup() {
local exit_code=$?
rm -f /tmp/agent_update_*_$$
rm -f /tmp/manual_additions_$$
exit $exit_code
}
# Set up cleanup trap
trap cleanup EXIT INT TERM
#==============================================================================
# Validation Functions
#==============================================================================
validate_environment() {
# Check if we have a current branch/feature (git or non-git)
if [[ -z "$CURRENT_BRANCH" ]]; then
log_error "Unable to determine current feature"
if [[ "$HAS_GIT" == "true" ]]; then
log_info "Make sure you're on a feature branch"
else
log_info "Set SPECIFY_FEATURE environment variable or create a feature first"
fi
exit 1
fi
# Check if plan.md exists
if [[ ! -f "$NEW_PLAN" ]]; then
log_error "No plan.md found at $NEW_PLAN"
log_info "Make sure you're working on a feature with a corresponding spec directory"
if [[ "$HAS_GIT" != "true" ]]; then
log_info "Use: export SPECIFY_FEATURE=your-feature-name or create a new feature first"
fi
exit 1
fi
# Check if template exists (needed for new files)
if [[ ! -f "$TEMPLATE_FILE" ]]; then
log_warning "Template file not found at $TEMPLATE_FILE"
log_warning "Creating new agent files will fail"
fi
}
#==============================================================================
# Plan Parsing Functions
#==============================================================================
extract_plan_field() {
local field_pattern="$1"
local plan_file="$2"
grep "^\*\*${field_pattern}\*\*: " "$plan_file" 2>/dev/null | \
head -1 | \
sed "s|^\*\*${field_pattern}\*\*: ||" | \
sed 's/^[ \t]*//;s/[ \t]*$//' | \
grep -v "NEEDS CLARIFICATION" | \
grep -v "^N/A$" || echo ""
}
parse_plan_data() {
local plan_file="$1"
if [[ ! -f "$plan_file" ]]; then
log_error "Plan file not found: $plan_file"
return 1
fi
if [[ ! -r "$plan_file" ]]; then
log_error "Plan file is not readable: $plan_file"
return 1
fi
log_info "Parsing plan data from $plan_file"
NEW_LANG=$(extract_plan_field "Language/Version" "$plan_file")
NEW_FRAMEWORK=$(extract_plan_field "Primary Dependencies" "$plan_file")
NEW_DB=$(extract_plan_field "Storage" "$plan_file")
NEW_PROJECT_TYPE=$(extract_plan_field "Project Type" "$plan_file")
# Log what we found
if [[ -n "$NEW_LANG" ]]; then
log_info "Found language: $NEW_LANG"
else
log_warning "No language information found in plan"
fi
if [[ -n "$NEW_FRAMEWORK" ]]; then
log_info "Found framework: $NEW_FRAMEWORK"
fi
if [[ -n "$NEW_DB" ]] && [[ "$NEW_DB" != "N/A" ]]; then
log_info "Found database: $NEW_DB"
fi
if [[ -n "$NEW_PROJECT_TYPE" ]]; then
log_info "Found project type: $NEW_PROJECT_TYPE"
fi
}
format_technology_stack() {
local lang="$1"
local framework="$2"
local parts=()
# Add non-empty parts
[[ -n "$lang" && "$lang" != "NEEDS CLARIFICATION" ]] && parts+=("$lang")
[[ -n "$framework" && "$framework" != "NEEDS CLARIFICATION" && "$framework" != "N/A" ]] && parts+=("$framework")
# Join with proper formatting
if [[ ${#parts[@]} -eq 0 ]]; then
echo ""
elif [[ ${#parts[@]} -eq 1 ]]; then
echo "${parts[0]}"
else
# Join multiple parts with " + "
local result="${parts[0]}"
for ((i=1; i<${#parts[@]}; i++)); do
result="$result + ${parts[i]}"
done
echo "$result"
fi
}
#==============================================================================
# Template and Content Generation Functions
#==============================================================================
get_project_structure() {
local project_type="$1"
if [[ "$project_type" == *"web"* ]]; then
echo "backend/\\nfrontend/\\ntests/"
else
echo "src/\\ntests/"
fi
}
get_commands_for_language() {
local lang="$1"
case "$lang" in
*"Python"*)
echo "cd src && pytest && ruff check ."
;;
*"Rust"*)
echo "cargo test && cargo clippy"
;;
*"JavaScript"*|*"TypeScript"*)
echo "npm test \\&\\& npm run lint"
;;
*)
echo "# Add commands for $lang"
;;
esac
}
get_language_conventions() {
local lang="$1"
echo "$lang: Follow standard conventions"
}
create_new_agent_file() {
local target_file="$1"
local temp_file="$2"
local project_name="$3"
local current_date="$4"
if [[ ! -f "$TEMPLATE_FILE" ]]; then
log_error "Template not found at $TEMPLATE_FILE"
return 1
fi
if [[ ! -r "$TEMPLATE_FILE" ]]; then
log_error "Template file is not readable: $TEMPLATE_FILE"
return 1
fi
log_info "Creating new agent context file from template..."
if ! cp "$TEMPLATE_FILE" "$temp_file"; then
log_error "Failed to copy template file"
return 1
fi
# Replace template placeholders
local project_structure
project_structure=$(get_project_structure "$NEW_PROJECT_TYPE")
local commands
commands=$(get_commands_for_language "$NEW_LANG")
local language_conventions
language_conventions=$(get_language_conventions "$NEW_LANG")
# Perform substitutions with error checking using safer approach
# Escape special characters for sed by using a different delimiter or escaping
local escaped_lang=$(printf '%s\n' "$NEW_LANG" | sed 's/[\[\.*^$()+{}|]/\\&/g')
local escaped_framework=$(printf '%s\n' "$NEW_FRAMEWORK" | sed 's/[\[\.*^$()+{}|]/\\&/g')
local escaped_branch=$(printf '%s\n' "$CURRENT_BRANCH" | sed 's/[\[\.*^$()+{}|]/\\&/g')
# Build technology stack and recent change strings conditionally
local tech_stack
if [[ -n "$escaped_lang" && -n "$escaped_framework" ]]; then
tech_stack="- $escaped_lang + $escaped_framework ($escaped_branch)"
elif [[ -n "$escaped_lang" ]]; then
tech_stack="- $escaped_lang ($escaped_branch)"
elif [[ -n "$escaped_framework" ]]; then
tech_stack="- $escaped_framework ($escaped_branch)"
else
tech_stack="- ($escaped_branch)"
fi
local recent_change
if [[ -n "$escaped_lang" && -n "$escaped_framework" ]]; then
recent_change="- $escaped_branch: Added $escaped_lang + $escaped_framework"
elif [[ -n "$escaped_lang" ]]; then
recent_change="- $escaped_branch: Added $escaped_lang"
elif [[ -n "$escaped_framework" ]]; then
recent_change="- $escaped_branch: Added $escaped_framework"
else
recent_change="- $escaped_branch: Added"
fi
local substitutions=(
"s|\[PROJECT NAME\]|$project_name|"
"s|\[DATE\]|$current_date|"
"s|\[EXTRACTED FROM ALL PLAN.MD FILES\]|$tech_stack|"
"s|\[ACTUAL STRUCTURE FROM PLANS\]|$project_structure|g"
"s|\[ONLY COMMANDS FOR ACTIVE TECHNOLOGIES\]|$commands|"
"s|\[LANGUAGE-SPECIFIC, ONLY FOR LANGUAGES IN USE\]|$language_conventions|"
"s|\[LAST 3 FEATURES AND WHAT THEY ADDED\]|$recent_change|"
)
for substitution in "${substitutions[@]}"; do
if ! sed -i.bak -e "$substitution" "$temp_file"; then
log_error "Failed to perform substitution: $substitution"
rm -f "$temp_file" "$temp_file.bak"
return 1
fi
done
# Convert \n sequences to actual newlines
newline=$(printf '\n')
sed -i.bak2 "s/\\\\n/${newline}/g" "$temp_file"
# Clean up backup files
rm -f "$temp_file.bak" "$temp_file.bak2"
return 0
}
update_existing_agent_file() {
local target_file="$1"
local current_date="$2"
log_info "Updating existing agent context file..."
# Use a single temporary file for atomic update
local temp_file
temp_file=$(mktemp) || {
log_error "Failed to create temporary file"
return 1
}
# Process the file in one pass
local tech_stack=$(format_technology_stack "$NEW_LANG" "$NEW_FRAMEWORK")
local new_tech_entries=()
local new_change_entry=""
# Prepare new technology entries
if [[ -n "$tech_stack" ]] && ! grep -q "$tech_stack" "$target_file"; then
new_tech_entries+=("- $tech_stack ($CURRENT_BRANCH)")
fi
if [[ -n "$NEW_DB" ]] && [[ "$NEW_DB" != "N/A" ]] && [[ "$NEW_DB" != "NEEDS CLARIFICATION" ]] && ! grep -q "$NEW_DB" "$target_file"; then
new_tech_entries+=("- $NEW_DB ($CURRENT_BRANCH)")
fi
# Prepare new change entry
if [[ -n "$tech_stack" ]]; then
new_change_entry="- $CURRENT_BRANCH: Added $tech_stack"
elif [[ -n "$NEW_DB" ]] && [[ "$NEW_DB" != "N/A" ]] && [[ "$NEW_DB" != "NEEDS CLARIFICATION" ]]; then
new_change_entry="- $CURRENT_BRANCH: Added $NEW_DB"
fi
# Check if sections exist in the file
local has_active_technologies=0
local has_recent_changes=0
if grep -q "^## Active Technologies" "$target_file" 2>/dev/null; then
has_active_technologies=1
fi
if grep -q "^## Recent Changes" "$target_file" 2>/dev/null; then
has_recent_changes=1
fi
# Process file line by line
local in_tech_section=false
local in_changes_section=false
local tech_entries_added=false
local changes_entries_added=false
local existing_changes_count=0
local file_ended=false
while IFS= read -r line || [[ -n "$line" ]]; do
# Handle Active Technologies section
if [[ "$line" == "## Active Technologies" ]]; then
echo "$line" >> "$temp_file"
in_tech_section=true
continue
elif [[ $in_tech_section == true ]] && [[ "$line" =~ ^##[[:space:]] ]]; then
# Add new tech entries before closing the section
if [[ $tech_entries_added == false ]] && [[ ${#new_tech_entries[@]} -gt 0 ]]; then
printf '%s\n' "${new_tech_entries[@]}" >> "$temp_file"
tech_entries_added=true
fi
echo "$line" >> "$temp_file"
in_tech_section=false
continue
elif [[ $in_tech_section == true ]] && [[ -z "$line" ]]; then
# Add new tech entries before empty line in tech section
if [[ $tech_entries_added == false ]] && [[ ${#new_tech_entries[@]} -gt 0 ]]; then
printf '%s\n' "${new_tech_entries[@]}" >> "$temp_file"
tech_entries_added=true
fi
echo "$line" >> "$temp_file"
continue
fi
# Handle Recent Changes section
if [[ "$line" == "## Recent Changes" ]]; then
echo "$line" >> "$temp_file"
# Add new change entry right after the heading
if [[ -n "$new_change_entry" ]]; then
echo "$new_change_entry" >> "$temp_file"
fi
in_changes_section=true
changes_entries_added=true
continue
elif [[ $in_changes_section == true ]] && [[ "$line" =~ ^##[[:space:]] ]]; then
echo "$line" >> "$temp_file"
in_changes_section=false
continue
elif [[ $in_changes_section == true ]] && [[ "$line" == "- "* ]]; then
# Keep only first 2 existing changes
if [[ $existing_changes_count -lt 2 ]]; then
echo "$line" >> "$temp_file"
((existing_changes_count++))
fi
continue
fi
# Update timestamp
if [[ "$line" =~ \*\*Last\ updated\*\*:.*[0-9][0-9][0-9][0-9]-[0-9][0-9]-[0-9][0-9] ]]; then
echo "$line" | sed "s/[0-9][0-9][0-9][0-9]-[0-9][0-9]-[0-9][0-9]/$current_date/" >> "$temp_file"
else
echo "$line" >> "$temp_file"
fi
done < "$target_file"
# Post-loop check: if we're still in the Active Technologies section and haven't added new entries
if [[ $in_tech_section == true ]] && [[ $tech_entries_added == false ]] && [[ ${#new_tech_entries[@]} -gt 0 ]]; then
printf '%s\n' "${new_tech_entries[@]}" >> "$temp_file"
tech_entries_added=true
fi
# If sections don't exist, add them at the end of the file
if [[ $has_active_technologies -eq 0 ]] && [[ ${#new_tech_entries[@]} -gt 0 ]]; then
echo "" >> "$temp_file"
echo "## Active Technologies" >> "$temp_file"
printf '%s\n' "${new_tech_entries[@]}" >> "$temp_file"
tech_entries_added=true
fi
if [[ $has_recent_changes -eq 0 ]] && [[ -n "$new_change_entry" ]]; then
echo "" >> "$temp_file"
echo "## Recent Changes" >> "$temp_file"
echo "$new_change_entry" >> "$temp_file"
changes_entries_added=true
fi
# Move temp file to target atomically
if ! mv "$temp_file" "$target_file"; then
log_error "Failed to update target file"
rm -f "$temp_file"
return 1
fi
return 0
}
#==============================================================================
# Main Agent File Update Function
#==============================================================================
update_agent_file() {
local target_file="$1"
local agent_name="$2"
if [[ -z "$target_file" ]] || [[ -z "$agent_name" ]]; then
log_error "update_agent_file requires target_file and agent_name parameters"
return 1
fi
log_info "Updating $agent_name context file: $target_file"
local project_name
project_name=$(basename "$REPO_ROOT")
local current_date
current_date=$(date +%Y-%m-%d)
# Create directory if it doesn't exist
local target_dir
target_dir=$(dirname "$target_file")
if [[ ! -d "$target_dir" ]]; then
if ! mkdir -p "$target_dir"; then
log_error "Failed to create directory: $target_dir"
return 1
fi
fi
if [[ ! -f "$target_file" ]]; then
# Create new file from template
local temp_file
temp_file=$(mktemp) || {
log_error "Failed to create temporary file"
return 1
}
if create_new_agent_file "$target_file" "$temp_file" "$project_name" "$current_date"; then
if mv "$temp_file" "$target_file"; then
log_success "Created new $agent_name context file"
else
log_error "Failed to move temporary file to $target_file"
rm -f "$temp_file"
return 1
fi
else
log_error "Failed to create new agent file"
rm -f "$temp_file"
return 1
fi
else
# Update existing file
if [[ ! -r "$target_file" ]]; then
log_error "Cannot read existing file: $target_file"
return 1
fi
if [[ ! -w "$target_file" ]]; then
log_error "Cannot write to existing file: $target_file"
return 1
fi
if update_existing_agent_file "$target_file" "$current_date"; then
log_success "Updated existing $agent_name context file"
else
log_error "Failed to update existing agent file"
return 1
fi
fi
return 0
}
#==============================================================================
# Agent Selection and Processing
#==============================================================================
update_specific_agent() {
local agent_type="$1"
case "$agent_type" in
claude)
update_agent_file "$CLAUDE_FILE" "Claude Code"
;;
gemini)
update_agent_file "$GEMINI_FILE" "Gemini CLI"
;;
copilot)
update_agent_file "$COPILOT_FILE" "GitHub Copilot"
;;
cursor-agent)
update_agent_file "$CURSOR_FILE" "Cursor IDE"
;;
qwen)
update_agent_file "$QWEN_FILE" "Qwen Code"
;;
opencode)
update_agent_file "$AGENTS_FILE" "opencode"
;;
codex)
update_agent_file "$AGENTS_FILE" "Codex CLI"
;;
windsurf)
update_agent_file "$WINDSURF_FILE" "Windsurf"
;;
kilocode)
update_agent_file "$KILOCODE_FILE" "Kilo Code"
;;
auggie)
update_agent_file "$AUGGIE_FILE" "Auggie CLI"
;;
roo)
update_agent_file "$ROO_FILE" "Roo Code"
;;
codebuddy)
update_agent_file "$CODEBUDDY_FILE" "CodeBuddy CLI"
;;
amp)
update_agent_file "$AMP_FILE" "Amp"
;;
q)
update_agent_file "$Q_FILE" "Amazon Q Developer CLI"
;;
*)
log_error "Unknown agent type '$agent_type'"
log_error "Expected: claude|gemini|copilot|cursor-agent|qwen|opencode|codex|windsurf|kilocode|auggie|roo|amp|q"
exit 1
;;
esac
}
update_all_existing_agents() {
local found_agent=false
# Check each possible agent file and update if it exists
if [[ -f "$CLAUDE_FILE" ]]; then
update_agent_file "$CLAUDE_FILE" "Claude Code"
found_agent=true
fi
if [[ -f "$GEMINI_FILE" ]]; then
update_agent_file "$GEMINI_FILE" "Gemini CLI"
found_agent=true
fi
if [[ -f "$COPILOT_FILE" ]]; then
update_agent_file "$COPILOT_FILE" "GitHub Copilot"
found_agent=true
fi
if [[ -f "$CURSOR_FILE" ]]; then
update_agent_file "$CURSOR_FILE" "Cursor IDE"
found_agent=true
fi
if [[ -f "$QWEN_FILE" ]]; then
update_agent_file "$QWEN_FILE" "Qwen Code"
found_agent=true
fi
if [[ -f "$AGENTS_FILE" ]]; then
update_agent_file "$AGENTS_FILE" "Codex/opencode"
found_agent=true
fi
if [[ -f "$WINDSURF_FILE" ]]; then
update_agent_file "$WINDSURF_FILE" "Windsurf"
found_agent=true
fi
if [[ -f "$KILOCODE_FILE" ]]; then
update_agent_file "$KILOCODE_FILE" "Kilo Code"
found_agent=true
fi
if [[ -f "$AUGGIE_FILE" ]]; then
update_agent_file "$AUGGIE_FILE" "Auggie CLI"
found_agent=true
fi
if [[ -f "$ROO_FILE" ]]; then
update_agent_file "$ROO_FILE" "Roo Code"
found_agent=true
fi
if [[ -f "$CODEBUDDY_FILE" ]]; then
update_agent_file "$CODEBUDDY_FILE" "CodeBuddy CLI"
found_agent=true
fi
if [[ -f "$Q_FILE" ]]; then
update_agent_file "$Q_FILE" "Amazon Q Developer CLI"
found_agent=true
fi
# If no agent files exist, create a default Claude file
if [[ "$found_agent" == false ]]; then
log_info "No existing agent files found, creating default Claude file..."
update_agent_file "$CLAUDE_FILE" "Claude Code"
fi
}
print_summary() {
echo
log_info "Summary of changes:"
if [[ -n "$NEW_LANG" ]]; then
echo " - Added language: $NEW_LANG"
fi
if [[ -n "$NEW_FRAMEWORK" ]]; then
echo " - Added framework: $NEW_FRAMEWORK"
fi
if [[ -n "$NEW_DB" ]] && [[ "$NEW_DB" != "N/A" ]]; then
echo " - Added database: $NEW_DB"
fi
echo
log_info "Usage: $0 [claude|gemini|copilot|cursor-agent|qwen|opencode|codex|windsurf|kilocode|auggie|codebuddy|q]"
}
#==============================================================================
# Main Execution
#==============================================================================
main() {
# Validate environment before proceeding
validate_environment
log_info "=== Updating agent context files for feature $CURRENT_BRANCH ==="
# Parse the plan file to extract project information
if ! parse_plan_data "$NEW_PLAN"; then
log_error "Failed to parse plan data"
exit 1
fi
# Process based on agent type argument
local success=true
if [[ -z "$AGENT_TYPE" ]]; then
# No specific agent provided - update all existing agent files
log_info "No agent specified, updating all existing agent files..."
if ! update_all_existing_agents; then
success=false
fi
else
# Specific agent provided - update only that agent
log_info "Updating specific agent: $AGENT_TYPE"
if ! update_specific_agent "$AGENT_TYPE"; then
success=false
fi
fi
# Print summary
print_summary
if [[ "$success" == true ]]; then
log_success "Agent context update completed successfully"
exit 0
else
log_error "Agent context update completed with errors"
exit 1
fi
}
# Execute main function if script is run directly
if [[ "${BASH_SOURCE[0]}" == "${0}" ]]; then
main "$@"
fi

28
.specify/templates/agent-file-template.md Normal file
View file

@ -0,0 +1,28 @@
# [PROJECT NAME] Development Guidelines
Auto-generated from all feature plans. Last updated: [DATE]
## Active Technologies
[EXTRACTED FROM ALL PLAN.MD FILES]
## Project Structure
```text
[ACTUAL STRUCTURE FROM PLANS]
```
## Commands
[ONLY COMMANDS FOR ACTIVE TECHNOLOGIES]
## Code Style
[LANGUAGE-SPECIFIC, ONLY FOR LANGUAGES IN USE]
## Recent Changes
[LAST 3 FEATURES AND WHAT THEY ADDED]
<!-- MANUAL ADDITIONS START -->
<!-- MANUAL ADDITIONS END -->

40
.specify/templates/checklist-template.md Normal file
View file

@ -0,0 +1,40 @@
# [CHECKLIST TYPE] Checklist: [FEATURE NAME]
**Purpose**: [Brief description of what this checklist covers]
**Created**: [DATE]
**Feature**: [Link to spec.md or relevant documentation]
**Note**: This checklist is generated by the `/speckit.checklist` command based on feature context and requirements.
<!--
============================================================================
IMPORTANT: The checklist items below are SAMPLE ITEMS for illustration only.
The /speckit.checklist command MUST replace these with actual items based on:
- User's specific checklist request
- Feature requirements from spec.md
- Technical context from plan.md
- Implementation details from tasks.md
DO NOT keep these sample items in the generated checklist file.
============================================================================
-->
## [Category 1]
- [ ] CHK001 First checklist item with clear action
- [ ] CHK002 Second checklist item
- [ ] CHK003 Third checklist item
## [Category 2]
- [ ] CHK004 Another category item
- [ ] CHK005 Item with specific criteria
- [ ] CHK006 Final item in this category
## Notes
- Check items off as completed: `[x]`
- Add comments or findings inline
- Link to relevant resources or documentation
- Items are numbered sequentially for easy reference

104
.specify/templates/plan-template.md Normal file
View file

@ -0,0 +1,104 @@
# Implementation Plan: [FEATURE]
**Branch**: `[###-feature-name]` | **Date**: [DATE] | **Spec**: [link]
**Input**: Feature specification from `/specs/[###-feature-name]/spec.md`
**Note**: This template is filled in by the `/speckit.plan` command. See `.specify/templates/commands/plan.md` for the execution workflow.
## Summary
[Extract from feature spec: primary requirement + technical approach from research]
## Technical Context
<!--
ACTION REQUIRED: Replace the content in this section with the technical details
for the project. The structure here is presented in advisory capacity to guide
the iteration process.
-->
**Language/Version**: [e.g., Python 3.11, Swift 5.9, Rust 1.75 or NEEDS CLARIFICATION]
**Primary Dependencies**: [e.g., FastAPI, UIKit, LLVM or NEEDS CLARIFICATION]
**Storage**: [if applicable, e.g., PostgreSQL, CoreData, files or N/A]
**Testing**: [e.g., pytest, XCTest, cargo test or NEEDS CLARIFICATION]
**Target Platform**: [e.g., Linux server, iOS 15+, WASM or NEEDS CLARIFICATION]
**Project Type**: [single/web/mobile - determines source structure]
**Performance Goals**: [domain-specific, e.g., 1000 req/s, 10k lines/sec, 60 fps or NEEDS CLARIFICATION]
**Constraints**: [domain-specific, e.g., <200ms p95, <100MB memory, offline-capable or NEEDS CLARIFICATION]
**Scale/Scope**: [domain-specific, e.g., 10k users, 1M LOC, 50 screens or NEEDS CLARIFICATION]
## Constitution Check
*GATE: Must pass before Phase 0 research. Re-check after Phase 1 design.*
[Gates determined based on constitution file]
## Project Structure
### Documentation (this feature)
```text
specs/[###-feature]/
├── plan.md # This file (/speckit.plan command output)
├── research.md # Phase 0 output (/speckit.plan command)
├── data-model.md # Phase 1 output (/speckit.plan command)
├── quickstart.md # Phase 1 output (/speckit.plan command)
├── contracts/ # Phase 1 output (/speckit.plan command)
└── tasks.md # Phase 2 output (/speckit.tasks command - NOT created by /speckit.plan)
```
### Source Code (repository root)
<!--
ACTION REQUIRED: Replace the placeholder tree below with the concrete layout
for this feature. Delete unused options and expand the chosen structure with
real paths (e.g., apps/admin, packages/something). The delivered plan must
not include Option labels.
-->
```text
# [REMOVE IF UNUSED] Option 1: Single project (DEFAULT)
src/
├── models/
├── services/
├── cli/
└── lib/
tests/
├── contract/
├── integration/
└── unit/
# [REMOVE IF UNUSED] Option 2: Web application (when "frontend" + "backend" detected)
backend/
├── src/
│ ├── models/
│ ├── services/
│ └── api/
└── tests/
frontend/
├── src/
│ ├── components/
│ ├── pages/
│ └── services/
└── tests/
# [REMOVE IF UNUSED] Option 3: Mobile + API (when "iOS/Android" detected)
api/
└── [same as backend above]
ios/ or android/
└── [platform-specific structure: feature modules, UI flows, platform tests]
```
**Structure Decision**: [Document the selected structure and reference the real
directories captured above]
## Complexity Tracking
> **Fill ONLY if Constitution Check has violations that must be justified**
| Violation | Why Needed | Simpler Alternative Rejected Because |
|-----------|------------|-------------------------------------|
| [e.g., 4th project] | [current need] | [why 3 projects insufficient] |
| [e.g., Repository pattern] | [specific problem] | [why direct DB access insufficient] |

115
.specify/templates/spec-template.md Normal file
View file

@ -0,0 +1,115 @@
# Feature Specification: [FEATURE NAME]
**Feature Branch**: `[###-feature-name]`
**Created**: [DATE]
**Status**: Draft
**Input**: User description: "$ARGUMENTS"
## User Scenarios & Testing *(mandatory)*
<!--
IMPORTANT: User stories should be PRIORITIZED as user journeys ordered by importance.
Each user story/journey must be INDEPENDENTLY TESTABLE - meaning if you implement just ONE of them,
you should still have a viable MVP (Minimum Viable Product) that delivers value.
Assign priorities (P1, P2, P3, etc.) to each story, where P1 is the most critical.
Think of each story as a standalone slice of functionality that can be:
- Developed independently
- Tested independently
- Deployed independently
- Demonstrated to users independently
-->
### User Story 1 - [Brief Title] (Priority: P1)
[Describe this user journey in plain language]
**Why this priority**: [Explain the value and why it has this priority level]
**Independent Test**: [Describe how this can be tested independently - e.g., "Can be fully tested by [specific action] and delivers [specific value]"]
**Acceptance Scenarios**:
1. **Given** [initial state], **When** [action], **Then** [expected outcome]
2. **Given** [initial state], **When** [action], **Then** [expected outcome]
---
### User Story 2 - [Brief Title] (Priority: P2)
[Describe this user journey in plain language]
**Why this priority**: [Explain the value and why it has this priority level]
**Independent Test**: [Describe how this can be tested independently]
**Acceptance Scenarios**:
1. **Given** [initial state], **When** [action], **Then** [expected outcome]
---
### User Story 3 - [Brief Title] (Priority: P3)
[Describe this user journey in plain language]
**Why this priority**: [Explain the value and why it has this priority level]
**Independent Test**: [Describe how this can be tested independently]
**Acceptance Scenarios**:
1. **Given** [initial state], **When** [action], **Then** [expected outcome]
---
[Add more user stories as needed, each with an assigned priority]
### Edge Cases
<!--
ACTION REQUIRED: The content in this section represents placeholders.
Fill them out with the right edge cases.
-->
- What happens when [boundary condition]?
- How does system handle [error scenario]?
## Requirements *(mandatory)*
<!--
ACTION REQUIRED: The content in this section represents placeholders.
Fill them out with the right functional requirements.
-->
### Functional Requirements
- **FR-001**: System MUST [specific capability, e.g., "allow users to create accounts"]
- **FR-002**: System MUST [specific capability, e.g., "validate email addresses"]
- **FR-003**: Users MUST be able to [key interaction, e.g., "reset their password"]
- **FR-004**: System MUST [data requirement, e.g., "persist user preferences"]
- **FR-005**: System MUST [behavior, e.g., "log all security events"]
*Example of marking unclear requirements:*
- **FR-006**: System MUST authenticate users via [NEEDS CLARIFICATION: auth method not specified - email/password, SSO, OAuth?]
- **FR-007**: System MUST retain user data for [NEEDS CLARIFICATION: retention period not specified]
### Key Entities *(include if feature involves data)*
- **[Entity 1]**: [What it represents, key attributes without implementation]
- **[Entity 2]**: [What it represents, relationships to other entities]
## Success Criteria *(mandatory)*
<!--
ACTION REQUIRED: Define measurable success criteria.
These must be technology-agnostic and measurable.
-->
### Measurable Outcomes
- **SC-001**: [Measurable metric, e.g., "Users can complete account creation in under 2 minutes"]
- **SC-002**: [Measurable metric, e.g., "System handles 1000 concurrent users without degradation"]
- **SC-003**: [User satisfaction metric, e.g., "90% of users successfully complete primary task on first attempt"]
- **SC-004**: [Business metric, e.g., "Reduce support tickets related to [X] by 50%"]

251
.specify/templates/tasks-template.md Normal file
View file

@ -0,0 +1,251 @@
---
description: "Task list template for feature implementation"
---
# Tasks: [FEATURE NAME]
**Input**: Design documents from `/specs/[###-feature-name]/`
**Prerequisites**: plan.md (required), spec.md (required for user stories), research.md, data-model.md, contracts/
**Tests**: The examples below include test tasks. Tests are OPTIONAL - only include them if explicitly requested in the feature specification.
**Organization**: Tasks are grouped by user story to enable independent implementation and testing of each story.
## Format: `[ID] [P?] [Story] Description`
- **[P]**: Can run in parallel (different files, no dependencies)
- **[Story]**: Which user story this task belongs to (e.g., US1, US2, US3)
- Include exact file paths in descriptions
## Path Conventions
- **Single project**: `src/`, `tests/` at repository root
- **Web app**: `backend/src/`, `frontend/src/`
- **Mobile**: `api/src/`, `ios/src/` or `android/src/`
- Paths shown below assume single project - adjust based on plan.md structure
<!--
============================================================================
IMPORTANT: The tasks below are SAMPLE TASKS for illustration purposes only.
The /speckit.tasks command MUST replace these with actual tasks based on:
- User stories from spec.md (with their priorities P1, P2, P3...)
- Feature requirements from plan.md
- Entities from data-model.md
- Endpoints from contracts/
Tasks MUST be organized by user story so each story can be:
- Implemented independently
- Tested independently
- Delivered as an MVP increment
DO NOT keep these sample tasks in the generated tasks.md file.
============================================================================
-->
## Phase 1: Setup (Shared Infrastructure)
**Purpose**: Project initialization and basic structure
- [ ] T001 Create project structure per implementation plan
- [ ] T002 Initialize [language] project with [framework] dependencies
- [ ] T003 [P] Configure linting and formatting tools
---
## Phase 2: Foundational (Blocking Prerequisites)
**Purpose**: Core infrastructure that MUST be complete before ANY user story can be implemented
**⚠️ CRITICAL**: No user story work can begin until this phase is complete
Examples of foundational tasks (adjust based on your project):
- [ ] T004 Setup database schema and migrations framework
- [ ] T005 [P] Implement authentication/authorization framework
- [ ] T006 [P] Setup API routing and middleware structure
- [ ] T007 Create base models/entities that all stories depend on
- [ ] T008 Configure error handling and logging infrastructure
- [ ] T009 Setup environment configuration management
**Checkpoint**: Foundation ready - user story implementation can now begin in parallel
---
## Phase 3: User Story 1 - [Title] (Priority: P1) 🎯 MVP
**Goal**: [Brief description of what this story delivers]
**Independent Test**: [How to verify this story works on its own]
### Tests for User Story 1 (OPTIONAL - only if tests requested) ⚠️
> **NOTE: Write these tests FIRST, ensure they FAIL before implementation**
- [ ] T010 [P] [US1] Contract test for [endpoint] in tests/contract/test_[name].py
- [ ] T011 [P] [US1] Integration test for [user journey] in tests/integration/test_[name].py
### Implementation for User Story 1
- [ ] T012 [P] [US1] Create [Entity1] model in src/models/[entity1].py
- [ ] T013 [P] [US1] Create [Entity2] model in src/models/[entity2].py
- [ ] T014 [US1] Implement [Service] in src/services/[service].py (depends on T012, T013)
- [ ] T015 [US1] Implement [endpoint/feature] in src/[location]/[file].py
- [ ] T016 [US1] Add validation and error handling
- [ ] T017 [US1] Add logging for user story 1 operations
**Checkpoint**: At this point, User Story 1 should be fully functional and testable independently
---
## Phase 4: User Story 2 - [Title] (Priority: P2)
**Goal**: [Brief description of what this story delivers]
**Independent Test**: [How to verify this story works on its own]
### Tests for User Story 2 (OPTIONAL - only if tests requested) ⚠️
- [ ] T018 [P] [US2] Contract test for [endpoint] in tests/contract/test_[name].py
- [ ] T019 [P] [US2] Integration test for [user journey] in tests/integration/test_[name].py
### Implementation for User Story 2
- [ ] T020 [P] [US2] Create [Entity] model in src/models/[entity].py
- [ ] T021 [US2] Implement [Service] in src/services/[service].py
- [ ] T022 [US2] Implement [endpoint/feature] in src/[location]/[file].py
- [ ] T023 [US2] Integrate with User Story 1 components (if needed)
**Checkpoint**: At this point, User Stories 1 AND 2 should both work independently
---
## Phase 5: User Story 3 - [Title] (Priority: P3)
**Goal**: [Brief description of what this story delivers]
**Independent Test**: [How to verify this story works on its own]
### Tests for User Story 3 (OPTIONAL - only if tests requested) ⚠️
- [ ] T024 [P] [US3] Contract test for [endpoint] in tests/contract/test_[name].py
- [ ] T025 [P] [US3] Integration test for [user journey] in tests/integration/test_[name].py
### Implementation for User Story 3
- [ ] T026 [P] [US3] Create [Entity] model in src/models/[entity].py
- [ ] T027 [US3] Implement [Service] in src/services/[service].py
- [ ] T028 [US3] Implement [endpoint/feature] in src/[location]/[file].py
**Checkpoint**: All user stories should now be independently functional
---
[Add more user story phases as needed, following the same pattern]
---
## Phase N: Polish & Cross-Cutting Concerns
**Purpose**: Improvements that affect multiple user stories
- [ ] TXXX [P] Documentation updates in docs/
- [ ] TXXX Code cleanup and refactoring
- [ ] TXXX Performance optimization across all stories
- [ ] TXXX [P] Additional unit tests (if requested) in tests/unit/
- [ ] TXXX Security hardening
- [ ] TXXX Run quickstart.md validation
---
## Dependencies & Execution Order
### Phase Dependencies
- **Setup (Phase 1)**: No dependencies - can start immediately
- **Foundational (Phase 2)**: Depends on Setup completion - BLOCKS all user stories
- **User Stories (Phase 3+)**: All depend on Foundational phase completion
- User stories can then proceed in parallel (if staffed)
- Or sequentially in priority order (P1 → P2 → P3)
- **Polish (Final Phase)**: Depends on all desired user stories being complete
### User Story Dependencies
- **User Story 1 (P1)**: Can start after Foundational (Phase 2) - No dependencies on other stories
- **User Story 2 (P2)**: Can start after Foundational (Phase 2) - May integrate with US1 but should be independently testable
- **User Story 3 (P3)**: Can start after Foundational (Phase 2) - May integrate with US1/US2 but should be independently testable
### Within Each User Story
- Tests (if included) MUST be written and FAIL before implementation
- Models before services
- Services before endpoints
- Core implementation before integration
- Story complete before moving to next priority
### Parallel Opportunities
- All Setup tasks marked [P] can run in parallel
- All Foundational tasks marked [P] can run in parallel (within Phase 2)
- Once Foundational phase completes, all user stories can start in parallel (if team capacity allows)
- All tests for a user story marked [P] can run in parallel
- Models within a story marked [P] can run in parallel
- Different user stories can be worked on in parallel by different team members
---
## Parallel Example: User Story 1
```bash
# Launch all tests for User Story 1 together (if tests requested):
Task: "Contract test for [endpoint] in tests/contract/test_[name].py"
Task: "Integration test for [user journey] in tests/integration/test_[name].py"
# Launch all models for User Story 1 together:
Task: "Create [Entity1] model in src/models/[entity1].py"
Task: "Create [Entity2] model in src/models/[entity2].py"
```
---
## Implementation Strategy
### MVP First (User Story 1 Only)
1. Complete Phase 1: Setup
2. Complete Phase 2: Foundational (CRITICAL - blocks all stories)
3. Complete Phase 3: User Story 1
4. **STOP and VALIDATE**: Test User Story 1 independently
5. Deploy/demo if ready
### Incremental Delivery
1. Complete Setup + Foundational → Foundation ready
2. Add User Story 1 → Test independently → Deploy/Demo (MVP!)
3. Add User Story 2 → Test independently → Deploy/Demo
4. Add User Story 3 → Test independently → Deploy/Demo
5. Each story adds value without breaking previous stories
### Parallel Team Strategy
With multiple developers:
1. Team completes Setup + Foundational together
2. Once Foundational is done:
- Developer A: User Story 1
- Developer B: User Story 2
- Developer C: User Story 3
3. Stories complete and integrate independently
---
## Notes
- [P] tasks = different files, no dependencies
- [Story] label maps task to specific user story for traceability
- Each user story should be independently completable and testable
- Verify tests fail before implementing
- Commit after each task or logical group
- Stop at any checkpoint to validate story independently
- Avoid: vague tasks, same file conflicts, cross-story dependencies that break independence

498
DEPLOYMENT.md Normal file
View file

@ -0,0 +1,498 @@
# Deployment Guide
This guide covers all deployment methods for skills to both Claude Code and OpenCode.
## Quick Reference
| Method | Use Case | Pros | Cons |
|--------|----------|------|------|
| Symlink | Active development | Live updates | Manual per-skill |
| Copy | Testing specific version | Isolated | Must re-copy for updates |
| Nix Home Manager | Production (NixOS) | Declarative, versioned | Requires rebuild |
| Git Submodule | Multi-repo sharing | Centralized updates | More complexity |
## Method 1: Symlink Deployment (Development)
Best for active development - changes in repo immediately available to agent.
### Claude Code
```bash
# Single skill
ln -s $(pwd)/skills/worklog ~/.claude/skills/worklog
# All skills
for skill in skills/*/; do
skill_name=$(basename "$skill")
if [ "$skill_name" != "template" ]; then
ln -s "$(pwd)/skills/$skill_name" ~/.claude/skills/$skill_name
fi
done
```
### OpenCode
```bash
# Single skill
ln -s $(pwd)/skills/worklog ~/.config/opencode/skills/worklog
# All skills
for skill in skills/*/; do
skill_name=$(basename "$skill")
if [ "$skill_name" != "template" ]; then
ln -s "$(pwd)/skills/$skill_name" ~/.config/opencode/skills/$skill_name
fi
done
```
### Verify Symlinks
```bash
# Claude Code
ls -la ~/.claude/skills/
# OpenCode
ls -la ~/.config/opencode/skills/
```
### Remove Symlinks
```bash
# Claude Code - single skill
rm ~/.claude/skills/worklog
# OpenCode - all skills (keeps directories, removes symlinks)
find ~/.config/opencode/skills -type l -delete
```
## Method 2: Copy Deployment (Testing)
Best for testing specific versions without affecting your main deployment.
### Claude Code
```bash
# Single skill
cp -r skills/worklog ~/.claude/skills/
# All skills (excluding template)
for skill in skills/*/; do
skill_name=$(basename "$skill")
if [ "$skill_name" != "template" ]; then
cp -r "skills/$skill_name" ~/.claude/skills/
fi
done
```
### OpenCode
```bash
# Single skill
cp -r skills/worklog ~/.config/opencode/skills/
# All skills (excluding template)
for skill in skills/*/; do
skill_name=$(basename "$skill")
if [ "$skill_name" != "template" ]; then
cp -r "skills/$skill_name" ~/.config/opencode/skills/
fi
done
```
### Update After Changes
```bash
# Must re-copy after making changes
cp -r skills/worklog ~/.claude/skills/
cp -r skills/worklog ~/.config/opencode/skills/
```
## Method 3: Nix Home Manager (Production)
Best for NixOS users - declarative, version-controlled, atomic deployments.
### Configuration
Add to your `home.nix` or equivalent:
```nix
{ config, pkgs, ... }:
{
# Claude Code skills
home.file.".claude/skills/worklog" = {
source = /home/user/proj/skills/skills/worklog;
recursive = true;
};
home.file.".claude/skills/update-spec-kit" = {
source = /home/user/proj/skills/skills/update-spec-kit;
recursive = true;
};
# OpenCode skills
home.file.".config/opencode/skills/worklog" = {
source = /home/user/proj/skills/skills/worklog;
recursive = true;
};
home.file.".config/opencode/skills/update-spec-kit" = {
source = /home/user/proj/skills/skills/update-spec-kit;
recursive = true;
};
# OpenCode plugin configuration
home.file.".config/opencode/config.json".text = builtins.toJSON {
plugin = [ "opencode-skills" ];
# ... other config
};
}
```
### Deploy All Skills Programmatically
For many skills, use a loop:
```nix
{ config, pkgs, lib, ... }:
let
skillsPath = /home/user/proj/skills/skills;
# List of skills to deploy (exclude template)
skills = [
"worklog"
"update-spec-kit"
# Add more skills here
];
# Generate home.file entries for a skill
mkSkillDeployment = skillName: {
".claude/skills/${skillName}" = {
source = "${skillsPath}/${skillName}";
recursive = true;
};
".config/opencode/skills/${skillName}" = {
source = "${skillsPath}/${skillName}";
recursive = true;
};
};
# Merge all skill deployments
allSkillDeployments = lib.foldl' (acc: skill: acc // (mkSkillDeployment skill)) {} skills;
in {
home.file = allSkillDeployments // {
# Other file configurations
".config/opencode/config.json".text = builtins.toJSON {
plugin = [ "opencode-skills" ];
};
};
}
```
### Apply Configuration
```bash
# Home Manager standalone
home-manager switch
# NixOS with flake
sudo nixos-rebuild switch --flake .#hostname
# Test first
sudo nixos-rebuild test --flake .#hostname
```
### Rollback
```bash
# Home Manager
home-manager generations
home-manager switch --rollback
# NixOS
sudo nixos-rebuild switch --rollback
```
## Method 4: Git Submodule (Shared Projects)
Best when multiple repositories need to share the same skills.
### Setup in Target Repository
```bash
# In your project repository
cd ~/proj/my-project
# Add skills as submodule
git submodule add https://github.com/yourusername/skills.git .skills
# Initialize submodule
git submodule update --init --recursive
```
### Deploy from Submodule
```bash
# Create deployment script: scripts/deploy-skills.sh
#!/usr/bin/env bash
set -euo pipefail
SKILLS_DIR=".skills/skills"
# Deploy to Claude Code
for skill in "$SKILLS_DIR"/*; do
skill_name=$(basename "$skill")
if [ "$skill_name" != "template" ]; then
ln -sf "$(realpath "$skill")" ~/.claude/skills/"$skill_name"
fi
done
# Deploy to OpenCode
for skill in "$SKILLS_DIR"/*; do
skill_name=$(basename "$skill")
if [ "$skill_name" != "template" ]; then
ln -sf "$(realpath "$skill")" ~/.config/opencode/skills/"$skill_name"
fi
done
echo "Skills deployed from submodule"
```
### Update Submodule
```bash
# Update to latest
git submodule update --remote .skills
# Or specific commit
cd .skills
git checkout main
git pull
cd ..
git add .skills
git commit -m "Update skills submodule"
```
## OpenCode Plugin Setup
OpenCode requires the `opencode-skills` plugin to discover skills.
### Manual Installation
```bash
# Edit OpenCode config
vim ~/.config/opencode/config.json
```
Add plugin:
```json
{
"plugin": ["opencode-skills"],
"other-settings": "..."
}
```
### Verify Plugin Loaded
```bash
# Start OpenCode and check for skills in output
opencode
# Or check logs for plugin loading
# (Plugin installation happens on first start after config change)
```
### Nix Configuration
```nix
home.file.".config/opencode/config.json".text = builtins.toJSON {
plugin = [ "opencode-skills" ];
};
```
## Verification
### Check Deployment
```bash
# Claude Code
ls -la ~/.claude/skills/
cat ~/.claude/skills/worklog/SKILL.md | head -5
# OpenCode
ls -la ~/.config/opencode/skills/
cat ~/.config/opencode/skills/worklog/SKILL.md | head -5
```
### Test Skill Discovery
**Claude Code:**
```bash
# Start Claude Code
claude
# In chat, try triggering a skill
# Example: "Create a worklog"
```
**OpenCode:**
```bash
# Start OpenCode
opencode
# In chat, try triggering a skill
# Example: "Document today's work"
```
### Debug Discovery Issues
**Claude Code:**
- Check SKILL.md frontmatter is valid YAML
- Verify file permissions are readable
- Restart Claude Code
- Check Claude logs (if available)
**OpenCode:**
- Verify opencode-skills plugin is installed
- Check plugin loaded at startup
- Restart OpenCode after config changes
- Check SKILL.md frontmatter
## Multi-Environment Deployment
Deploy same skills to multiple machines.
### Using Dotfiles Repository
```bash
# In your dotfiles repo
mkdir -p skills
cd skills
git submodule add https://github.com/yourusername/skills.git
# Create deployment script in dotfiles
cat > scripts/deploy-skills.sh << 'EOF'
#!/usr/bin/env bash
for skill in skills/skills/*; do
skill_name=$(basename "$skill")
[ "$skill_name" = "template" ] && continue
ln -sf "$(realpath "$skill")" ~/.claude/skills/"$skill_name"
ln -sf "$(realpath "$skill")" ~/.config/opencode/skills/"$skill_name"
done
EOF
chmod +x scripts/deploy-skills.sh
```
### Using Configuration Management
**Ansible example:**
```yaml
- name: Deploy agentic skills
file:
src: "{{ playbook_dir }}/skills/{{ item }}"
dest: "~/.claude/skills/{{ item }}"
state: link
loop:
- worklog
- update-spec-kit
```
## Cleanup
### Remove All Skills
```bash
# Claude Code
rm -rf ~/.claude/skills/*
# OpenCode
rm -rf ~/.config/opencode/skills/*
```
### Remove Specific Skill
```bash
# Claude Code
rm -rf ~/.claude/skills/worklog
# OpenCode
rm -rf ~/.config/opencode/skills/worklog
```
### Nix Cleanup
Remove from `home.nix` and rebuild:
```bash
# Edit home.nix to remove skill entries
vim home.nix
# Rebuild
home-manager switch
```
## Troubleshooting
### Symlink Target Not Found
```bash
# Check symlink
ls -la ~/.claude/skills/worklog
# If broken, recreate
rm ~/.claude/skills/worklog
ln -s $(pwd)/skills/worklog ~/.claude/skills/worklog
```
### Permission Denied
```bash
# Fix permissions on scripts
chmod +x skills/*/scripts/*.sh
# Fix ownership
chown -R $USER:$USER skills/
```
### Skills Not Updating (Nix)
```bash
# Nix copies files, doesn't symlink by default
# Changes to source won't appear until rebuild
sudo nixos-rebuild switch --flake .#hostname
```
### OpenCode Plugin Not Loading
```bash
# Check config
cat ~/.config/opencode/config.json | jq .plugin
# Ensure valid JSON
jq . ~/.config/opencode/config.json
# Restart OpenCode
pkill opencode
opencode
```
## Best Practices
1. **Development**: Use symlinks for instant updates
2. **Testing**: Use copies to test specific versions
3. **Production**: Use Nix for declarative, atomic deployments
4. **Multi-machine**: Use git submodules or dotfiles
5. **Version Control**: Always commit before deploying
6. **Documentation**: Keep deployment notes in project README
7. **Rollback Plan**: Know how to revert (especially for Nix)
## See Also
- [README.md](./README.md) - Repository overview
- [WORKFLOW.md](./WORKFLOW.md) - Development workflow
- [Nix Home Manager Manual](https://nix-community.github.io/home-manager/)
- [Claude Code Documentation](https://docs.claude.com/en/docs/claude-code)
- [OpenCode Skills Plugin](https://github.com/opencode-ai/opencode-skills)

264
README.md Normal file
View file

@ -0,0 +1,264 @@
# Agentic Coding Skills
A unified repository for developing, testing, and deploying reusable skills for AI coding agents (Claude Code and OpenCode).
## Overview
This repository provides a structured framework for building **skills** - composable, reusable capabilities that enhance AI coding agents. Skills combine instructions, helper scripts, templates, and examples to enable agents to perform complex, multi-step workflows consistently.
**Why Skills?**
- **Consistency**: Standardized workflows across different projects
- **Reusability**: Write once, use everywhere
- **Composability**: Skills can call other skills
- **Version Control**: Track and evolve capabilities over time
- **Multi-Agent Support**: Same skills work with both Claude Code and OpenCode
## Repository Structure
```
skills/
├── README.md # This file
├── WORKFLOW.md # Skill development workflow guide
├── skills/ # Individual skill implementations
│ ├── worklog/ # Org-mode worklog generation
│ ├── update-spec-kit/ # Spec-kit ecosystem updates
│ └── template/ # Template for new skills
├── .specify/ # Spec-kit framework (for developing this repo)
│ ├── templates/
│ ├── scripts/
│ └── memory/
└── .opencode/ # OpenCode commands (for developing this repo)
└── command/
```
## Skills Included
### worklog
Creates comprehensive structured org-mode worklogs documenting work sessions.
**When to use**: After completing significant work that should be documented for future reference.
**What it does**:
- Gathers git context (commits, changes, status)
- Extracts session metrics
- Generates comprehensive org-mode worklog with standardized sections
- Saves to `docs/worklogs/YYYY-MM-DD-descriptive-topic.org`
**Dependencies**: Git repository, bash
### update-spec-kit
Updates the spec-kit ecosystem to latest versions across repository, CLI, and all projects.
**When to use**: When you want to ensure spec-kit is current across your entire development environment.
**What it does**:
- Updates spec-kit repository from upstream
- Upgrades specify CLI tool via uv
- Updates all projects using spec-kit to latest templates
- Preserves user work (specs, code, settings)
**Dependencies**: git, uv, spec-kit installation
## Skill Structure
Each skill follows a standard structure:
```
skill-name/
├── SKILL.md # Primary skill definition
│ ├── Frontmatter metadata (name, description)
│ ├── When to Use section
│ ├── Process/Instructions section
│ └── Requirements section
├── README.md # User-facing documentation
├── scripts/ # Helper scripts
│ ├── script1.sh
│ └── script2.sh
├── templates/ # File templates
│ └── template-file.ext
└── examples/ # Example outputs
└── example-output.ext
```
### SKILL.md Format
```markdown
---
name: skill-name
description: One-line description of what this skill does
---
# Skill Name
Detailed description of the skill.
## When to Use
Explicit triggers and use cases for invoking this skill.
## Process
Step-by-step instructions for the agent to follow.
## Requirements
- Dependency 1
- Dependency 2
```
## Quick Start
### Using Skills
**Claude Code:**
Skills in `~/.claude/skills/` are automatically available. The agent will invoke them when appropriate based on the `description` and `When to Use` sections.
**OpenCode:**
Skills in `~/.config/opencode/skills/` are discovered by the `opencode-skills` plugin. Ensure the plugin is installed and configured.
### Developing Skills
1. **Create a new skill branch**:
```bash
git checkout -b feature/new-skill-name
```
2. **Copy the template**:
```bash
cp -r skills/template skills/your-skill-name
```
3. **Edit SKILL.md** with your skill definition
4. **Add scripts/templates** as needed
5. **Test locally** by deploying to `~/.claude/skills/` or `~/.config/opencode/skills/`
6. **Document in README.md** for users
See [WORKFLOW.md](./WORKFLOW.md) for detailed development workflow.
## Deployment
### Claude Code Deployment
**Manual deployment:**
```bash
# Link skill to Claude Code skills directory
ln -s $(pwd)/skills/your-skill-name ~/.claude/skills/your-skill-name
```
**Nix Home Manager deployment:**
```nix
# In your home.nix or equivalent
home.file.".claude/skills/your-skill-name" = {
source = /path/to/skills/skills/your-skill-name;
recursive = true;
};
```
### OpenCode Deployment
**Manual deployment:**
```bash
# Link skill to OpenCode skills directory
ln -s $(pwd)/skills/your-skill-name ~/.config/opencode/skills/your-skill-name
```
**Nix Home Manager deployment:**
```nix
# In your home.nix or equivalent
home.file.".config/opencode/skills/your-skill-name" = {
source = /path/to/skills/skills/your-skill-name;
recursive = true;
};
```
**Enable opencode-skills plugin:**
```json
// ~/.config/opencode/config.json
{
"plugin": ["opencode-skills"]
}
```
## Design Principles
### 1. Agent-First Design
Skills are written for AI agents, not humans. Instructions should be:
- Explicit and unambiguous
- Procedural (step-by-step)
- Include decision criteria
- Reference specific files/commands
### 2. Self-Contained
Each skill should:
- Include all necessary scripts
- Document all dependencies
- Provide templates for generated content
- Include examples of expected output
### 3. Composable
Skills can invoke other skills, but should:
- Declare skill dependencies explicitly
- Handle missing dependencies gracefully
- Avoid circular dependencies
### 4. Testable
Skills should be testable by:
- Providing example inputs
- Defining expected outputs
- Including validation criteria
- Supporting dry-run modes where applicable
### 5. Version Controlled
All skill components should be:
- Tracked in git
- Documented with clear commit messages
- Tagged when significant changes occur
- Backward compatible when possible
## Contributing
### Adding a New Skill
1. Use the skill template as starting point
2. Follow the standard skill structure
3. Test with both Claude Code and OpenCode
4. Document in main README.md
5. Submit PR with comprehensive description
### Modifying Existing Skills
1. Create feature branch
2. Update SKILL.md and associated files
3. Test changes with real-world usage
4. Update version/changelog if significant
5. Submit PR explaining changes and impact
## Integration with Spec-Kit
This repository uses spec-kit for its own development workflow. The `.specify/` and `.opencode/` directories contain the spec-kit framework that enables structured feature development.
**To develop a new skill using spec-kit:**
```bash
# In OpenCode or Claude Code
/speckit.specify "Add a new skill for [description]"
```
This will guide you through the structured development process.
## License
MIT
## Related Projects
- [Claude Code](https://github.com/anthropics/claude-code) - Anthropic's official CLI for Claude
- [OpenCode](https://github.com/sst/opencode) - Open source AI coding agent
- [spec-kit](https://github.com/github/spec-kit) - Specification-driven development framework
- [opencode-skills](https://github.com/opencode-ai/opencode-skills) - OpenCode skills plugin
## Support
For issues, questions, or contributions, please open an issue in this repository.

462
WORKFLOW.md Normal file
View file

@ -0,0 +1,462 @@
# Skill Development Workflow
This document describes the complete workflow for developing, testing, and deploying skills for agentic coding.
## Overview
Skills are developed in this repository and then deployed to either (or both):
- **Claude Code** (`~/.claude/skills/`)
- **OpenCode** (`~/.config/opencode/skills/`)
The workflow supports both manual development and spec-kit-driven development.
## Development Approaches
### Approach 1: Manual Development
Quick iteration for simple skills or updates.
1. **Create skill directory**:
```bash
cp -r skills/template skills/your-skill-name
```
2. **Edit SKILL.md**:
- Update frontmatter (name, description)
- Fill in "When to Use" section
- Document the process/instructions
- List requirements
3. **Add helper scripts** (if needed):
```bash
# Create scripts in skills/your-skill-name/scripts/
vim skills/your-skill-name/scripts/helper.sh
chmod +x skills/your-skill-name/scripts/helper.sh
```
4. **Add templates** (if needed):
```bash
# Create templates in skills/your-skill-name/templates/
vim skills/your-skill-name/templates/output-template.txt
```
5. **Update README.md**:
- Write user-facing documentation
- Include usage examples
- Document prerequisites
6. **Test locally** (see Testing section below)
### Approach 2: Spec-Kit Development
Structured approach for complex skills or when you want full specification.
1. **Create feature specification**:
```bash
# In OpenCode or Claude Code
/speckit.specify "Create a skill for [description]"
```
2. **Clarify requirements** (if needed):
```bash
/speckit.clarify
```
3. **Create implementation plan**:
```bash
/speckit.plan
```
4. **Implement the skill**:
```bash
/speckit.implement
```
5. **Test and iterate**
The spec-kit approach creates structured documentation in `.specify/specs/` that captures the full design and implementation process.
## Skill Structure
### Required Files
Every skill must have:
```
skill-name/
├── SKILL.md # Primary skill definition (required)
└── README.md # User documentation (required)
```
### Optional Components
Add as needed:
```
skill-name/
├── scripts/ # Helper bash scripts
│ └── helper.sh
├── templates/ # File templates for generated content
│ └── template.txt
└── examples/ # Example outputs
└── example.txt
```
### SKILL.md Structure
The SKILL.md file is what the agent reads. It must include:
**Frontmatter** (YAML):
```yaml
---
name: skill-name
description: One-line description for agent discovery
---
```
**Required Sections**:
1. Title and overview
2. "When to Use" - Explicit triggers
3. Process/Instructions - Step-by-step for agent
4. Requirements - Dependencies
**Optional Sections**:
- Context Gathering
- Helper Scripts
- Templates
- Guidelines
- Error Handling
- Examples
## Testing
### Local Testing
**Option 1: Symlink to agent directory**
For Claude Code:
```bash
ln -s $(pwd)/skills/your-skill-name ~/.claude/skills/your-skill-name
```
For OpenCode:
```bash
ln -s $(pwd)/skills/your-skill-name ~/.config/opencode/skills/your-skill-name
```
**Option 2: Copy for testing**
```bash
# Copy to Claude Code
cp -r skills/your-skill-name ~/.claude/skills/
# Copy to OpenCode
cp -r skills/your-skill-name ~/.config/opencode/skills/
```
### Test Cases
1. **Script Testing** (if skill has scripts):
```bash
# Test each script independently
cd skills/your-skill-name
./scripts/helper.sh --test-args
```
2. **Agent Testing**:
- Open Claude Code or OpenCode
- Navigate to a test project
- Use natural language trigger from "When to Use" section
- Verify agent invokes skill correctly
- Check output matches expectations
3. **Edge Cases**:
- Test with missing dependencies
- Test in non-git repositories (if applicable)
- Test with empty or minimal input
- Test error handling
### Validation Checklist
Before deploying:
- [ ] SKILL.md has correct frontmatter
- [ ] "When to Use" section has clear triggers
- [ ] Process instructions are step-by-step
- [ ] All helper scripts are executable
- [ ] README.md has installation instructions
- [ ] Examples are provided
- [ ] Scripts handle errors gracefully
- [ ] Tested with both Claude Code and OpenCode (if applicable)
## Deployment
### Development Deployment
For active development, use symlinks:
```bash
# Claude Code
ln -s $(pwd)/skills/your-skill-name ~/.claude/skills/your-skill-name
# OpenCode
ln -s $(pwd)/skills/your-skill-name ~/.config/opencode/skills/your-skill-name
```
This allows you to edit in the repo and see changes immediately.
### Production Deployment
#### Manual Deployment
Copy skills to the appropriate directories:
```bash
# Deploy to Claude Code
cp -r skills/skill-name ~/.claude/skills/
# Deploy to OpenCode
cp -r skills/skill-name ~/.config/opencode/skills/
```
#### Nix Home Manager Deployment
For NixOS users, add to your home configuration:
```nix
# home.nix or equivalent
{
# Claude Code skills
home.file.".claude/skills/your-skill-name" = {
source = /path/to/skills/skills/your-skill-name;
recursive = true;
};
# OpenCode skills
home.file.".config/opencode/skills/your-skill-name" = {
source = /path/to/skills/skills/your-skill-name;
recursive = true;
};
}
```
Then rebuild:
```bash
sudo nixos-rebuild switch --flake .#hostname
```
#### OpenCode Plugin Configuration
Ensure the opencode-skills plugin is enabled:
```json
// ~/.config/opencode/config.json
{
"plugin": ["opencode-skills"]
}
```
## Version Control
### Commit Guidelines
Follow these commit message conventions:
- `feat(skill-name): Add new feature`
- `fix(skill-name): Fix bug in script`
- `docs(skill-name): Update documentation`
- `refactor(skill-name): Restructure code`
- `test(skill-name): Add tests`
### Branching Strategy
For new skills:
```bash
git checkout -b feature/new-skill-name
```
For updates:
```bash
git checkout -b fix/skill-name-issue
```
### Pull Request Template
When submitting a skill:
```markdown
## Skill: [Name]
### Description
[Brief description of what the skill does]
### Testing
- [ ] Tested with Claude Code
- [ ] Tested with OpenCode
- [ ] Scripts are executable
- [ ] Examples included
- [ ] Documentation complete
### Deployment Notes
[Any special deployment considerations]
```
## Troubleshooting
### Skill Not Discovered
**Claude Code:**
- Check file exists: `ls ~/.claude/skills/skill-name/SKILL.md`
- Verify frontmatter is valid YAML
- Restart Claude Code
- Check Claude Code logs
**OpenCode:**
- Check file exists: `ls ~/.config/opencode/skills/skill-name/SKILL.md`
- Verify opencode-skills plugin is enabled
- Restart OpenCode
- Check plugin loaded: Look for skills in OpenCode output
### Scripts Fail
- Verify scripts are executable: `chmod +x scripts/*.sh`
- Test scripts independently
- Check for missing dependencies
- Verify paths are correct (use absolute paths when possible)
### Agent Doesn't Use Skill
- Make "When to Use" section more explicit
- Use more specific trigger phrases in user request
- Check description in frontmatter is clear
- Verify skill is appropriate for the task
## Best Practices
### 1. Clear Triggers
Make the "When to Use" section explicit:
**Good**:
```markdown
## When to Use
Invoke this skill when the user requests:
- "Create a worklog"
- "Document today's work"
- "Write a session summary"
```
**Bad**:
```markdown
## When to Use
Use this for documentation.
```
### 2. Step-by-Step Instructions
The agent needs procedural instructions:
**Good**:
```markdown
1. Gather git context using: `git status`
2. Run helper script: `./scripts/extract-metrics.sh`
3. Read template from: `./templates/output.txt`
4. Fill in template with gathered information
5. Save to: `docs/output/YYYY-MM-DD-topic.txt`
```
**Bad**:
```markdown
Gather information and create output.
```
### 3. Self-Contained Scripts
Scripts should work from any directory:
**Good**:
```bash
#!/usr/bin/env bash
SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
SKILL_DIR="$(dirname "$SCRIPT_DIR")"
# Use absolute paths
cat "$SKILL_DIR/templates/template.txt"
```
**Bad**:
```bash
#!/usr/bin/env bash
cat templates/template.txt # Fails if not in skill directory
```
### 4. Error Handling
All scripts should handle errors:
```bash
#!/usr/bin/env bash
set -euo pipefail # Exit on error, undefined vars, pipe failures
# Check prerequisites
if ! command -v git &> /dev/null; then
echo "Error: git not found" >&2
exit 1
fi
# Validate input
if [ $# -lt 1 ]; then
echo "Usage: $0 <argument>" >&2
exit 1
fi
```
### 5. Documentation
Every skill needs both SKILL.md (for agent) and README.md (for humans):
- **SKILL.md**: Procedural, step-by-step, for agent execution
- **README.md**: Conceptual, examples, for human understanding
## Examples
### Simple Skill (No Scripts)
```
hello-world/
├── SKILL.md # Instructions for agent
└── README.md # User documentation
```
SKILL.md might instruct the agent to simply output a greeting based on context.
### Complex Skill (Full Structure)
```
worklog/
├── SKILL.md # Agent instructions
├── README.md # User guide
├── scripts/
│ ├── extract-metrics.sh # Git statistics
│ ├── suggest-filename.sh # Filename generation
│ └── find-related-logs.sh # Search previous logs
├── templates/
│ └── worklog-template.org # Output template
└── examples/
└── example-worklog.org # Sample output
```
The agent follows SKILL.md to orchestrate all components.
## Contributing
See [README.md](./README.md) for contribution guidelines.
## See Also
- [README.md](./README.md) - Repository overview
- [skills/template/](./skills/template/) - Template for new skills
- [Claude Code Skills Documentation](https://docs.claude.com/en/docs/claude-code/skills)
- [OpenCode Skills Plugin](https://github.com/opencode-ai/opencode-skills)

103
skills/template/README.md Normal file
View file

@ -0,0 +1,103 @@
# Skill Template
[One-paragraph user-facing description of what this skill does]
## Quick Start
[Brief example of how to use this skill]
**Claude Code / OpenCode:**
The agent will automatically invoke this skill when you request [trigger phrase].
**Manual invocation:**
```
[Example user request that triggers the skill]
```
## What It Does
[Detailed explanation of the skill's functionality]
- Feature 1
- Feature 2
- Feature 3
## Prerequisites
- Requirement 1
- Requirement 2
- Requirement 3
## Example Usage
### Scenario 1: [Use Case Name]
**User request:**
```
[Example request]
```
**Agent actions:**
1. [Step 1]
2. [Step 2]
3. [Step 3]
**Result:**
[Description of output]
### Scenario 2: [Another Use Case]
**User request:**
```
[Example request]
```
**Agent actions:**
1. [Step 1]
2. [Step 2]
3. [Step 3]
**Result:**
[Description of output]
## Configuration
[If the skill requires configuration, document it here]
No configuration required / or:
Create a configuration file at `[path]`:
```json
{
"setting1": "value1",
"setting2": "value2"
}
```
## Troubleshooting
### Problem: [Common Issue 1]
**Cause:** [Why this happens]
**Solution:** [How to fix]
### Problem: [Common Issue 2]
**Cause:** [Why this happens]
**Solution:** [How to fix]
## Advanced Usage
[Optional advanced features or customization options]
## See Also
- [Related Skill 1](../skill-name/README.md)
- [Related Skill 2](../other-skill/README.md)
- [External Documentation](https://example.com)
## Contributing
Found a bug or have a suggestion? Please open an issue in the main repository.
## License
MIT

140
skills/template/SKILL.md Normal file
View file

@ -0,0 +1,140 @@
---
name: skill-template
description: Template for creating new agentic coding skills
---
# Skill Template
[Replace with a clear description of what this skill does and the problem it solves]
## When to Use
Invoke this skill when the user requests:
- [List specific phrases or requests that should trigger this skill]
- [Example: "Document today's work"]
- [Example: "Update the spec-kit ecosystem"]
- [Example: "Create a comprehensive worklog"]
## Context Gathering
Before executing the skill, gather necessary context using appropriate tools:
**Git Information** (if applicable):
- Current git status: `git status`
- Recent commits: `git log --oneline -10`
- Active branch: `git branch --show-current`
- Uncommitted changes: `git diff --stat`
**File System Information** (if applicable):
- Check for required directories
- Verify necessary files exist
- Locate configuration files
**External Dependencies** (if applicable):
- Check for required tools/commands
- Verify API access or credentials
- Validate configuration settings
## Process
[Detailed step-by-step instructions for the agent to follow]
1. **Preparation**
- Verify all prerequisites are met
- Gather necessary context (see Context Gathering section)
- Check for conflicts or blockers
2. **Execution**
- [Specific action 1]
- [Specific action 2]
- [Specific action 3]
3. **Validation**
- Verify expected outputs were created
- Check for errors or warnings
- Validate content meets quality standards
4. **Completion**
- Report summary of actions taken
- Provide next steps or recommendations
- Clean up temporary files if applicable
## Helper Scripts
[Document any helper scripts in the scripts/ directory]
### script-name.sh
**Purpose**: [What this script does]
**Usage**:
```bash
./scripts/script-name.sh [arguments]
```
**Output**: [What the script returns]
## Templates
[Document any templates in the templates/ directory]
### template-file.ext
**Purpose**: [What this template is used for]
**Placeholders**:
- `[PLACEHOLDER_1]`: [Description]
- `[PLACEHOLDER_2]`: [Description]
## Examples
See the `examples/` directory for example outputs and usage patterns.
## Guidelines
[Specific guidelines for how the agent should behave when using this skill]
1. **Principle 1**: [Description]
2. **Principle 2**: [Description]
3. **Principle 3**: [Description]
## Error Handling
[How to handle common errors or edge cases]
- **Error Scenario 1**: [How to handle]
- **Error Scenario 2**: [How to handle]
- **Error Scenario 3**: [How to handle]
## Requirements
[List all dependencies and prerequisites]
- Dependency 1 (e.g., Git repository)
- Dependency 2 (e.g., Bash environment)
- Dependency 3 (e.g., Specific CLI tool)
- Optional: Dependency 4 (e.g., Internet connection for API calls)
## Output Format
[Describe what the skill produces]
- File(s) created: [List files and locations]
- Terminal output: [What is displayed to user]
- Side effects: [Any state changes, commits, etc.]
## Testing
[How to verify this skill works correctly]
1. **Test Case 1**: [Scenario and expected outcome]
2. **Test Case 2**: [Scenario and expected outcome]
3. **Test Case 3**: [Scenario and expected outcome]
## Notes
[Additional context, limitations, or considerations]
- Note 1
- Note 2
- Note 3

24
skills/template/examples/example-output.txt Normal file
View file

@ -0,0 +1,24 @@
# Example Output
This file demonstrates what the skill produces when executed successfully.
---
Skill: example-skill
Created: 2025-11-08
Author: AI Agent
---
Description: This is an example of the skill's output
## Section 1
Example content that was generated by the skill...
## Section 2
More example content demonstrating the structure and format...
## Notes
This example shows the expected format and content structure.
The actual output will vary based on the specific skill implementation.

92
skills/template/scripts/example-script.sh Executable file
View file

@ -0,0 +1,92 @@
#!/usr/bin/env bash
# Example helper script for skill template
#
# This script demonstrates the standard structure for skill helper scripts.
# Replace this with actual functionality for your skill.
set -euo pipefail
# Script directory (useful for referencing other skill files)
SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
SKILL_DIR="$(dirname "$SCRIPT_DIR")"
# Parse arguments
show_help() {
cat << EOF
Usage: $(basename "$0") [OPTIONS] [ARGUMENTS]
Description of what this script does.
OPTIONS:
-h, --help Show this help message
-v, --verbose Enable verbose output
-d, --dry-run Show what would be done without doing it
ARGUMENTS:
arg1 Description of argument 1
arg2 Description of argument 2
EXAMPLES:
$(basename "$0") value1 value2
$(basename "$0") --verbose value1 value2
$(basename "$0") --dry-run value1 value2
EOF
}
# Default values
VERBOSE=false
DRY_RUN=false
# Parse options
while [[ $# -gt 0 ]]; do
case $1 in
-h|--help)
show_help
exit 0
;;
-v|--verbose)
VERBOSE=true
shift
;;
-d|--dry-run)
DRY_RUN=true
shift
;;
-*)
echo "Error: Unknown option $1" >&2
show_help
exit 1
;;
*)
break
;;
esac
done
# Validate arguments
if [[ $# -lt 1 ]]; then
echo "Error: Missing required arguments" >&2
show_help
exit 1
fi
# Main logic
main() {
local arg1="$1"
local arg2="${2:-default}"
if [[ "$VERBOSE" == "true" ]]; then
echo "Running with arg1=$arg1, arg2=$arg2" >&2
fi
if [[ "$DRY_RUN" == "true" ]]; then
echo "[DRY RUN] Would perform action with $arg1 and $arg2"
exit 0
fi
# Actual work goes here
echo "Result: Processed $arg1 with $arg2"
}
main "$@"

34
skills/template/templates/example-template.txt Normal file
View file

@ -0,0 +1,34 @@
# Example Template File
This is a template file that demonstrates how to create templates for your skill.
## Placeholders
Replace the following placeholders when using this template:
- [SKILL_NAME]: The name of your skill
- [DATE]: Current date
- [AUTHOR]: Name of the person/agent creating this
- [DESCRIPTION]: Brief description
## Template Content
---
Skill: [SKILL_NAME]
Created: [DATE]
Author: [AUTHOR]
---
Description: [DESCRIPTION]
## Section 1
Content goes here...
## Section 2
More content...
## Notes
Additional notes or instructions...

159
skills/update-spec-kit/README.md Normal file
View file

@ -0,0 +1,159 @@
# Update Spec-Kit Skill
A skill for keeping the spec-kit ecosystem up-to-date across repository, CLI, and all projects.
## What This Skill Does
Automatically updates three levels of the spec-kit ecosystem:
1. **Spec-kit repository** - Pulls latest commits from upstream
2. **Specify CLI tool** - Upgrades the installed CLI to latest version
3. **Project templates** - Updates all projects using spec-kit to latest templates
## Installation
### Claude Code
```bash
# Link skill to Claude Code skills directory
ln -s $(pwd)/skills/update-spec-kit ~/.claude/skills/update-spec-kit
```
Or via Nix Home Manager:
```nix
home.file.".claude/skills/update-spec-kit" = {
source = /path/to/skills/skills/update-spec-kit;
recursive = true;
};
```
### OpenCode
```bash
# Link skill to OpenCode skills directory
ln -s $(pwd)/skills/update-spec-kit ~/.config/opencode/skills/update-spec-kit
```
Or via Nix Home Manager:
```nix
home.file.".config/opencode/skills/update-spec-kit" = {
source = /path/to/skills/skills/update-spec-kit;
recursive = true;
};
```
## Usage
Simply ask the agent in natural language:
- "Update spec-kit"
- "Upgrade spec-kit to the latest version"
- "Refresh all my spec-kit projects"
- "Are my spec-kit projects current?"
- "Sync spec-kit templates"
The agent will automatically invoke this skill based on your request.
## How It Works
**Model-Invoked**: The agent decides when to activate this skill. You don't need to explicitly call it.
**Three-Step Process**:
1. **Update Repository**: Pulls latest changes from `~/proj/spec-kit`
2. **Upgrade CLI**: Updates `specify` CLI tool via `uv`
3. **Update Projects**: Refreshes templates in all projects with `.specify` directories
## File Structure
```
update-spec-kit/
├── SKILL.md # Skill definition and instructions
├── README.md # This file
└── scripts/
└── update-all-projects.sh # Batch update script for all projects
```
## Safety Guarantees
**What's Updated**:
- Slash command files (`.claude/commands/*.md`, `.opencode/command/*.md`)
- Helper scripts (`.specify/scripts/`)
- Template files (`.specify/templates/`)
**What's Preserved**:
- All specifications (`.specify/specs/`)
- Source code
- Git history
- VS Code settings (smart-merged, not replaced)
## Manual Usage
### Update All Projects
```bash
./scripts/update-all-projects.sh
```
### Check Current Status
```bash
# Check spec-kit repo status
cd ~/proj/spec-kit && git fetch && git status
# Check CLI version
specify --version
# Compare installed vs latest
git log --oneline HEAD..origin/main
```
## Requirements
- Git repository at `~/proj/spec-kit`
- `uv` package manager installed
- `specify` CLI tool installed
- Projects with `.specify` directories
## Troubleshooting
### Skill doesn't activate
- Ensure deployed: `ls ~/.claude/skills/update-spec-kit/SKILL.md`
- Try explicit language: "update spec-kit"
- Check agent sees the skill in available skills list
### Update script fails
- Verify internet connectivity
- Check git repository is clean: `cd ~/proj/spec-kit && git status`
- Ensure `uv` is installed: `uv --version`
- Verify projects have `.specify` directories: `find ~/proj -name ".specify"`
### Agent detection fails
The script auto-detects the AI agent for each project:
- Checks for `.claude/`, `.cursor/`, `.gemini/` directories
- Checks for `.github/copilot-instructions.md`
- Defaults to `claude` if unclear
## Advanced
### Custom Project Locations
Edit `scripts/update-all-projects.sh` to change the search path:
```bash
# Default: searches ~/proj
projects=($(find ~/proj -name ".specify" -type d 2>/dev/null | sed 's|/.specify$||'))
# Custom: search multiple locations
projects=($(find ~/proj ~/work ~/dev -name ".specify" -type d 2>/dev/null | sed 's|/.specify$||'))
```
### Skip Specific Projects
Exclude projects by filtering the array:
```bash
# After finding projects, filter out unwanted ones
projects=("${projects[@]//*archive*}")
```
## See Also
- [Spec-Kit Repository](https://github.com/github/spec-kit)
- [Specify CLI Documentation](https://github.com/github/spec-kit#cli-usage)
## License
MIT

153
skills/update-spec-kit/SKILL.md Normal file
View file

@ -0,0 +1,153 @@
---
name: update-spec-kit
description: Update the spec-kit repository, CLI tool, and all project templates to the latest version. Use when the user asks to update spec-kit, upgrade spec-kit templates, refresh spec-kit projects, or sync spec-kit to latest.
---
# Update Spec-Kit
This skill updates the spec-kit ecosystem to the latest version across three levels:
1. **Spec-kit repository** - Pull latest commits from upstream
2. **Specify CLI tool** - Upgrade the installed CLI to latest
3. **Project templates** - Update all projects using spec-kit to latest templates
## When to Use
Invoke this skill when the user requests:
- "Update spec-kit"
- "Upgrade spec-kit to latest"
- "Refresh spec-kit templates in my projects"
- "Sync all spec-kit projects"
- "Make sure spec-kit is up to date"
## Process
### Step 1: Update Spec-Kit Repository
Navigate to the spec-kit repository and update:
```bash
cd ~/proj/spec-kit
git fetch origin
git log --oneline main..origin/main # Show what's new
git pull --ff-only origin main
```
Report the number of new commits and releases to the user.
### Step 2: Update Specify CLI Tool
Update the globally installed CLI:
```bash
uv tool install specify-cli --force --from git+https://github.com/github/spec-kit.git
```
Verify the installation:
```bash
specify --help
```
### Step 3: Update All Project Templates
Find all projects with spec-kit installed and update them:
```bash
~/.claude/skills/update-spec-kit/scripts/update-all-projects.sh
```
This script:
- Finds all directories with `.specify` folders
- Detects which AI agent each project uses (claude, cursor, copilot, etc.)
- Runs `specify init --here --force --ai <agent>` in each project
- Preserves all user work (specs, code, settings)
- Only updates template files (commands, scripts)
## Important Notes
**Safe Operations:**
- Templates are merged/overwritten
- User work in `.specify/specs/` is never touched
- Source code and git history are preserved
- `.vscode/settings.json` is smart-merged (not replaced)
**What Gets Updated:**
- Slash command files (`.claude/commands/*.md`, `.opencode/command/*.md`)
- Helper scripts (`.specify/scripts/`)
- Template files (`.specify/templates/`)
**What Stays:**
- All your specifications (`.specify/specs/`)
- Your source code
- Git history
- Custom VS Code settings (merged intelligently)
## Output Format
After completion, report:
1. Number of commits pulled from upstream
2. New version tags/releases available
3. List of projects updated
4. Brief summary of major changes (check CHANGELOG.md)
## Error Handling
If updates fail:
- Check internet connectivity
- Verify git repository is clean (no uncommitted changes)
- Ensure `uv` is installed and working
- Check that projects have `.specify` directories
## Examples
**User Request:**
> "Update spec-kit and all my projects"
**Skill Action:**
1. Navigate to ~/proj/spec-kit
2. Pull latest changes
3. Show: "Pulled 28 new commits (v0.0.72 → v0.0.79)"
4. Upgrade CLI tool
5. Find 7 projects with spec-kit
6. Update each project to v0.0.79
7. Report: "Updated: klmgraph, talu, ops-red, ops-jrz1, wifi-tester, delbaker"
---
**User Request:**
> "Are my spec-kit projects current?"
**Skill Action:**
1. Check spec-kit repo status
2. Compare installed CLI version
3. Compare one project's templates with latest
4. Report status and suggest update if needed
## Requirements
- Spec-kit repository at `~/proj/spec-kit`
- `uv` package manager installed
- `specify` CLI tool installed
- Projects with `.specify` directories in `~/proj`
## Helper Scripts
### update-all-projects.sh
**Purpose**: Batch update all projects using spec-kit
**Location**: `~/.claude/skills/update-spec-kit/scripts/update-all-projects.sh`
**What it does**:
1. Finds all projects with `.specify` directories
2. Detects AI agent for each project
3. Updates templates using `specify init --force`
4. Reports results
**Agent Detection**:
- Checks for `.claude/` directory → `claude`
- Checks for `.cursor/` directory → `cursor-agent`
- Checks for `.gemini/` directory → `gemini`
- Checks for `.github/copilot-instructions.md` → `copilot`
- Defaults to `claude` if unclear

51
skills/update-spec-kit/scripts/update-all-projects.sh Executable file
View file

@ -0,0 +1,51 @@
#!/usr/bin/env bash
# Update all spec-kit projects to latest templates
# Part of the update-spec-kit skill
set -euo pipefail
# Find all projects with .specify directories
projects=($(find ~/proj -name ".specify" -type d 2>/dev/null | sed 's|/.specify$||'))
if [ ${#projects[@]} -eq 0 ]; then
echo "No spec-kit projects found"
exit 0
fi
echo "Found ${#projects[@]} spec-kit projects:"
for proj in "${projects[@]}"; do
echo " - $proj"
done
echo ""
# Detect AI agent from existing setup
detect_agent() {
local proj="$1"
if [ -d "$proj/.claude" ]; then
echo "claude"
elif [ -d "$proj/.cursor" ]; then
echo "cursor-agent"
elif [ -d "$proj/.gemini" ]; then
echo "gemini"
elif [ -f "$proj/.github/copilot-instructions.md" ]; then
echo "copilot"
else
echo "claude" # default
fi
}
# Update each project
for project in "${projects[@]}"; do
agent=$(detect_agent "$project")
echo "==> Updating: $project (agent: $agent)"
cd "$project"
# Run update
specify init --here --force --ai "$agent"
echo " ✓ Updated"
echo ""
done
echo "All projects updated!"

184
skills/worklog/README.md Normal file
View file

@ -0,0 +1,184 @@
# Worklog Skill
A skill for creating comprehensive, structured worklogs of development sessions.
## What This Skill Does
Automatically creates detailed org-mode worklogs documenting:
- Session accomplishments and decisions
- Problems encountered and solutions found
- Technical details and code changes
- Process insights and learnings
- Context for future work
## Installation
### Claude Code
```bash
# Link skill to Claude Code skills directory
ln -s $(pwd)/skills/worklog ~/.claude/skills/worklog
```
Or via Nix Home Manager:
```nix
home.file.".claude/skills/worklog" = {
source = /path/to/skills/skills/worklog;
recursive = true;
};
```
### OpenCode
```bash
# Link skill to OpenCode skills directory
ln -s $(pwd)/skills/worklog ~/.config/opencode/skills/worklog
```
Or via Nix Home Manager:
```nix
home.file.".config/opencode/skills/worklog" = {
source = /path/to/skills/skills/worklog;
recursive = true;
};
```
Ensure the opencode-skills plugin is enabled in `~/.config/opencode/config.json`:
```json
{
"plugin": ["opencode-skills"]
}
```
## Usage
Simply ask Claude or OpenCode in natural language:
- "Document today's work"
- "Create a worklog"
- "Write a worklog for this session"
- "Log what we accomplished"
- "Record this work session"
The agent will automatically invoke this skill based on the description.
## How It Works
**Model-Invoked**: The agent decides when to activate this skill based on your request. You don't need to explicitly call it.
**Process**:
1. Gathers git context (status, commits, diffs)
2. Extracts session metrics using helper scripts
3. Loads the org-mode template
4. Searches for related previous worklogs
5. Fills in all sections with session details
6. Saves to `docs/worklogs/YYYY-MM-DD-{topic}.org`
## File Structure
```
worklog/
├── SKILL.md # Skill definition and instructions
├── README.md # This file
├── templates/
│ └── worklog-template.org # Org-mode template structure
├── scripts/
│ ├── extract-metrics.sh # Extract git statistics
│ ├── suggest-filename.sh # Generate descriptive filename
│ └── find-related-logs.sh # Search previous worklogs
└── examples/
└── example-worklog.org # Example of filled template
```
## Requirements
### System Requirements
- Must be in a git repository
- Git commands available in PATH
- Bash for helper scripts
### Project Structure
- Creates `docs/worklogs/` directory if it doesn't exist
- Worklogs saved as: `docs/worklogs/YYYY-MM-DD-{topic}.org`
### Output Format
- Org-mode (.org) format
- Structured with frontmatter metadata
- Comprehensive sections (see template)
## Helper Scripts
All scripts use absolute paths and can be tested independently:
### Extract Metrics
```bash
./scripts/extract-metrics.sh
```
Outputs: commits made today, files touched, lines added/removed
### Suggest Filename
```bash
./scripts/suggest-filename.sh
```
Analyzes recent commits to suggest descriptive filename
### Find Related Logs
```bash
./scripts/find-related-logs.sh "keyword1 keyword2"
```
Searches previous worklogs by keywords
## Testing
### Test Scripts Locally
```bash
# Test each script from the skill directory
./scripts/extract-metrics.sh
./scripts/suggest-filename.sh
./scripts/find-related-logs.sh "test search"
```
### Test Skill with Agent
1. Deploy the skill
2. In a git repository, ask: "Document today's work"
3. Verify agent creates worklog in `docs/worklogs/`
## Known Limitations
- **Git dependency**: Must be in a git repository
- **Hardcoded paths**: Assumes `docs/worklogs/` directory structure
- **Format**: Only outputs org-mode, not markdown or plain text
- **Language**: Scripts assume bash and standard Unix tools
## Future Work
**Semantic Compression**: The worklogs are designed as raw material for a planned semantic compression workflow that will:
- Distill key insights from verbose logs
- Create searchable index of decisions and solutions
- Build knowledge graph across sessions
This workflow is not yet implemented but referenced in the worklog metadata.
## Troubleshooting
### Skill doesn't activate
- Ensure deployed: `ls ~/.claude/skills/worklog/SKILL.md`
- Try explicit language: "create a worklog"
- Check agent sees the skill in available skills list
### Scripts fail
- Verify you're in a git repository: `git status`
- Check scripts are executable: `ls -la ./scripts/`
- Test scripts individually from command line
### Directory doesn't exist
- Agent should create `docs/worklogs/` automatically
- Or manually: `mkdir -p docs/worklogs/`
### No commits to analyze
- Scripts handle repos with no commits (will show zeros)
- Filename suggestion falls back to "work-session" if no commits
## License
MIT

126
skills/worklog/SKILL.md Normal file
View file

@ -0,0 +1,126 @@
---
name: worklog
description: Create comprehensive structured org-mode worklogs documenting work sessions in docs/worklogs/. Use when the user explicitly asks to document work, create/write a worklog, log the session, or record what was accomplished.
---
# Worklog Skill
Create comprehensive structured worklogs that document work sessions with rich context for future reference.
## When to Use
Invoke this skill when the user requests:
- "Document today's work"
- "Create a worklog"
- "Record this session"
- "Write up what we accomplished"
- "Log this work session"
## Context Gathering
Before writing the worklog, gather the following context using the Bash tool:
**Git Information:**
- Current git status: `git status`
- Current date and time: `date`
- Recent commits: `git log --oneline -10`
- Active branch: `git branch --show-current`
- Uncommitted changes: `git diff --stat`
**Session Metrics:**
Use the helper script to extract metrics (see Helper Scripts section below)
## File Location
Save worklogs to: `docs/worklogs/YYYY-MM-DD-{descriptive-topic-kebab-case}.org`
Create the `docs/worklogs/` directory if it doesn't exist.
Use the helper script to suggest the filename:
```bash
~/.claude/skills/worklog/scripts/suggest-filename.sh
```
## Structure
Read the complete template from: `~/.claude/skills/worklog/templates/worklog-template.org`
The worklog must follow this template structure exactly.
Key sections to include:
1. **Metadata** - Title, date, keywords, commits, compression status
2. **Session Summary** - Date, focus area
3. **Accomplishments** - Checkbox list of what was done
4. **Key Decisions** - Context, options, rationale, impact
5. **Problems & Solutions** - Table format with learnings
6. **Technical Details** - Code changes, commands, architecture notes
7. **Process & Workflow** - What worked, what was challenging
8. **Learning & Insights** - Technical, process, and architectural insights
9. **Context for Future Work** - Open questions, next steps, related work
10. **Raw Notes** - Additional context
11. **Session Metrics** - Quantitative summary
## Helper Scripts
**Extract Git Metrics:**
```bash
~/.claude/skills/worklog/scripts/extract-metrics.sh
```
Outputs: commits made, files touched, lines added/removed
**Suggest Filename:**
```bash
~/.claude/skills/worklog/scripts/suggest-filename.sh
```
Analyzes recent commits to suggest a descriptive filename
**Find Related Logs:**
```bash
~/.claude/skills/worklog/scripts/find-related-logs.sh "keyword1 keyword2"
```
Searches previous worklogs for context continuity
## Guidelines
1. **Be Comprehensive** - Include more information rather than less. This worklog will be compressed later.
2. **Focus on Facts and Context** - Document what happened, why decisions were made, and how problems were solved.
3. **Include Code and Commands** - Show actual code snippets, error messages, and commands used.
4. **Capture the Journey** - Document false starts, debugging sessions, and the path to the solution.
5. **Think About Future You** - What would you want to know if you encountered this situation in 6 months?
6. **No Premature Optimization** - Don't worry about redundancy or verbosity. Semantic compression will handle distillation later.
7. **Minimum Length** - Aim for at least 3-5KB of content. Thorough worklogs typically run 5-15KB or more.
8. **Pull Previous Context** - Use the find-related-logs script to reference related work and maintain continuity.
## Process
1. Gather git context using the Bash tool with commands shown above
2. Run helper scripts to extract metrics and suggest filename
3. Read the complete template from `~/.claude/skills/worklog/templates/worklog-template.org`
4. Search for related previous worklogs using the find-related-logs script
5. Fill in all template sections with detailed information from the session
6. Ensure the `docs/worklogs/` directory exists (create if needed)
7. Save the worklog with the suggested filename
8. Verify metadata frontmatter is complete
## Remember
- This is raw material for future semantic compression - be thorough
- Semantic compression is a planned workflow that will distill and index these logs
- Decisions and rationale are crucial - explain the "why"
- Technical details help reconstruct solutions
- Process insights prevent future mistakes
- The journey is as important as the destination
## Requirements
- Must be in a git repository
- Saves to `docs/worklogs/` directory (will create if needed)
- Outputs org-mode format
- Requires helper scripts in `~/.claude/skills/worklog/scripts/`

1
skills/worklog/examples/example-worklog.org Normal file
View file

@ -0,0 +1 @@
Example worklog placeholder - see actual worklog examples in ~/proj/dotfiles/docs/worklogs/

61
skills/worklog/scripts/extract-metrics.sh Executable file
View file

@ -0,0 +1,61 @@
#!/usr/bin/env bash
set -euo pipefail
# Extract git metrics for worklog session
# Outputs structured data about commits, files, and changes
# Check if we're in a git repo
if ! git rev-parse --git-dir > /dev/null 2>&1; then
echo "Error: Not in a git repository"
exit 1
fi
# Get commits made today
TODAY=$(date +%Y-%m-%d)
COMMITS_TODAY=$(git log --since="$TODAY 00:00:00" --oneline | wc -l)
# Get total commits available in repo to avoid HEAD~N crash in shallow/small repos
TOTAL_COMMITS=$(git rev-list --count HEAD)
# Get files touched in recent commits (last 10 or today's commits, whichever is more)
COMMIT_COUNT=$((COMMITS_TODAY > 10 ? COMMITS_TODAY : 10))
# Clamp to actual available commits (need at least 1 commit to compare)
if [ "$COMMIT_COUNT" -ge "$TOTAL_COMMITS" ]; then
COMMIT_COUNT=$((TOTAL_COMMITS - 1))
fi
# Only calculate diffs if we have commits to compare
if [ "$COMMIT_COUNT" -gt 0 ]; then
FILES_TOUCHED=$(git diff --name-only HEAD~"$COMMIT_COUNT"..HEAD 2>/dev/null | sort -u | wc -l)
LINES_STATS=$(git diff --shortstat HEAD~"$COMMIT_COUNT"..HEAD 2>/dev/null || echo "0 files changed, 0 insertions(+), 0 deletions(-)")
else
FILES_TOUCHED=0
LINES_STATS="0 files changed, 0 insertions(+), 0 deletions(-)"
fi
# Extract numbers from shortstat using portable sed (works on Linux/macOS/BSD)
# Handles both singular and plural forms (insertion/insertions, deletion/deletions)
INSERTIONS=$(echo "$LINES_STATS" | sed -n 's/.* \([0-9]\+\) insertion.*/\1/p')
if [ -z "$INSERTIONS" ]; then
INSERTIONS="0"
fi
DELETIONS=$(echo "$LINES_STATS" | sed -n 's/.* \([0-9]\+\) deletion.*/\1/p')
if [ -z "$DELETIONS" ]; then
DELETIONS="0"
fi
# Get recent commit messages
RECENT_COMMITS=$(git log --since="$TODAY 00:00:00" --oneline | head -10)
# Output structured data
cat <<EOF
Session Metrics (generated $(date)):
- Commits made today: $COMMITS_TODAY
- Files touched: $FILES_TOUCHED
- Lines added: +$INSERTIONS
- Lines removed: -$DELETIONS
Recent commits:
$RECENT_COMMITS
EOF

68
skills/worklog/scripts/find-related-logs.sh Executable file
View file

@ -0,0 +1,68 @@
#!/usr/bin/env bash
set -euo pipefail
# Find related worklogs by keyword search (OR semantics)
# Usage: find-related-logs.sh "keyword1 keyword2"
if [ $# -eq 0 ]; then
echo "Usage: $0 \"keyword1 keyword2 ...\""
echo "Searches previous worklogs for keywords (OR logic)"
exit 1
fi
# Get repository root to handle relative paths correctly
if git rev-parse --git-dir > /dev/null 2>&1; then
REPO_ROOT=$(git rev-parse --show-toplevel)
WORKLOG_DIR="$REPO_ROOT/docs/worklogs"
else
# Not in a git repo, try relative path as fallback
WORKLOG_DIR="docs/worklogs"
fi
# Check if worklog directory exists
if [ ! -d "$WORKLOG_DIR" ]; then
echo "Worklog directory not found: $WORKLOG_DIR"
exit 1
fi
# Split keywords into array for OR search
read -ra KEYWORD_ARRAY <<< "$*"
# Search for keywords in worklogs with OR semantics
echo "Searching for: ${KEYWORD_ARRAY[*]} (OR logic)"
echo "---"
# Use ripgrep if available, otherwise fall back to grep
# Note: rg/grep return non-zero when no matches, so we need '|| true' to prevent errexit
if command -v rg &> /dev/null; then
# Build ripgrep pattern: keyword1|keyword2|keyword3
PATTERN=$(IFS='|'; echo "${KEYWORD_ARRAY[*]}")
RESULTS=$(rg -i -l "$PATTERN" "$WORKLOG_DIR" 2>/dev/null | sort -r | head -10 || true)
else
# Build grep command with multiple -e flags for OR logic
GREP_ARGS=()
for keyword in "${KEYWORD_ARRAY[@]}"; do
GREP_ARGS+=(-e "$keyword")
done
RESULTS=$(grep -r -i -l "${GREP_ARGS[@]}" "$WORKLOG_DIR" 2>/dev/null | sort -r | head -10 || true)
fi
# Check if we found any results
if [ -z "$RESULTS" ]; then
echo "No related worklogs found for: ${KEYWORD_ARRAY[*]}"
exit 0
fi
# Display results
echo "$RESULTS" | while read -r file; do
# Extract title and date from file
TITLE=$(grep -m1 "^#+TITLE:" "$file" 2>/dev/null | sed 's/#+TITLE: //' || echo "Untitled")
DATE=$(grep -m1 "^#+DATE:" "$file" 2>/dev/null | sed 's/#+DATE: //' || echo "Unknown date")
KEYWORDS_LINE=$(grep -m1 "^#+KEYWORDS:" "$file" 2>/dev/null | sed 's/#+KEYWORDS: //' || echo "")
echo "File: $file"
echo " Title: $TITLE"
echo " Date: $DATE"
echo " Keywords: $KEYWORDS_LINE"
echo ""
done

47
skills/worklog/scripts/suggest-filename.sh Executable file
View file

@ -0,0 +1,47 @@
#!/usr/bin/env bash
set -euo pipefail
# Suggest a worklog filename based on recent git activity
# Analyzes commit messages to extract a descriptive topic
# Check if we're in a git repo
if ! git rev-parse --git-dir > /dev/null 2>&1; then
echo "Error: Not in a git repository"
exit 1
fi
# Get today's date
TODAY=$(date +%Y-%m-%d)
# Get recent commit messages from today
COMMIT_MESSAGES=$(git log --since="$TODAY 00:00:00" --pretty=format:"%s" | head -10)
if [ -z "$COMMIT_MESSAGES" ]; then
# No commits today, check last few commits
COMMIT_MESSAGES=$(git log --oneline -5 | cut -d' ' -f2-)
fi
# Extract common words (excluding common prefixes like fix, add, update)
# Convert to kebab-case topic suggestion
TOPIC=$(echo "$COMMIT_MESSAGES" \
| tr '[:upper:]' '[:lower:]' \
| sed 's/[^a-z0-9 ]/ /g' \
| tr -s ' ' \
| sed 's/^fix //g; s/^add //g; s/^update //g; s/^feat //g; s/^refactor //g' \
| tr ' ' '\n' \
| grep -v -E '^(and|the|for|with|from|to|in|on|at|by|of|a|an)$' \
| sort | uniq -c | sort -rn \
| head -3 \
| awk '{print $2}' \
| tr '\n' '-' \
| sed 's/-$//')
# If no topic extracted, use generic
if [ -z "$TOPIC" ]; then
TOPIC="work-session"
fi
# Construct filename
FILENAME="docs/worklogs/${TODAY}-${TOPIC}.org"
echo "$FILENAME"

127
skills/worklog/templates/worklog-template.org Normal file
View file

@ -0,0 +1,127 @@
#+TITLE: {Descriptive Title of Work Session}
#+DATE: YYYY-MM-DD
#+KEYWORDS: keyword1, keyword2, keyword3, keyword4, keyword5
#+COMMITS: {number of commits made}
#+COMPRESSION_STATUS: uncompressed
* Session Summary
** Date: YYYY-MM-DD (Day N of project)
** Focus Area: {Main area/theme of work}
* Accomplishments
- [X] Major accomplishment 1 with specific details
- [X] Major accomplishment 2 with context
- [X] Feature implemented or bug fixed
- [ ] Started but not completed
(Use checkboxes, include as much detail as needed)
* Key Decisions
** Decision 1: {What was decided}
- Context: Why this decision was needed
- Options considered:
1. Option A - pros/cons
2. Option B - pros/cons
- Rationale: Why we chose this approach
- Impact: How this affects the system
** Decision 2: {What was decided}
(Include all significant decisions made)
* Problems & Solutions
| Problem | Solution | Learning |
|---------|----------|----------|
| Detailed problem description | Step-by-step solution | Key insight gained |
| Include error messages | Include code snippets | Generalizable principle |
| Stack traces if relevant | Multiple attempts documented | Future prevention |
* Technical Details
** Code Changes
- Total files modified: {number}
- Key files changed:
- `path/to/file1.ex` - Description of changes
- `path/to/file2.ex` - What was modified and why
- New files created:
- `path/to/new_file.ex` - Purpose and contents
- Files deleted:
- Reason for deletion
** Commands Used
Document useful commands discovered or used:
```bash
# Command that solved a problem
mix some.command --with-flags
# Debugging command that revealed issue
```
** Architecture Notes
- Patterns discovered or implemented
- Design decisions with rationale
- Performance considerations
- Security considerations
* Process and Workflow
** What Worked Well
- Effective approaches
- Tools that helped
- Successful debugging strategies
** What Was Challenging
- Obstacles encountered
- Time sinks
- False starts and dead ends
- Confusion points
* Learning and Insights
** Technical Insights
- New understanding about the system
- Language/framework features discovered
- Performance characteristics observed
- Edge cases uncovered
** Process Insights
- Workflow improvements identified
- Testing strategies that worked
- Documentation needs discovered
** Architectural Insights
- System design revelations
- Integration points clarified
- Abstraction opportunities identified
* Context for Future Work
** Open Questions
- Unresolved design questions
- Performance concerns to investigate
- Technical debt identified
- Areas needing more research
** Next Steps
- Immediate next tasks
- Follow-up work required
- Dependencies to resolve
- Tests to write
** Related Work
- Links to related worklogs
- References to design documents
- Connected issues or features
- External documentation consulted
* Raw Notes
(Include any additional notes, thoughts, or context that doesn't fit above)
- Stream of consciousness observations
- Links to resources found
- Chat logs if relevant
- Screenshots or diagrams (as links or ASCII art)
* Session Metrics
- Commits made: N
- Files touched: N
- Lines added/removed: +N/-N
- Tests added: N
- Tests passing: N/N