@abranjith/spec-lite 0.0.1 → 0.0.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -14,7 +14,7 @@ spec-lite is a set of **modular prompt files** — each defining a specialist AI
14
14
  - **Modular** — Use one sub-agent or all of them. Skip what you don't need.
15
15
  - **Unopinionated** — Adapts to any project type (web, CLI, library, desktop, pipeline), any language, any stack.
16
16
  - **Finite-scoped** — Each sub-agent has one job, clear inputs, and a concrete output artifact.
17
- - **Memory-first** — Cross-cutting standards (coding conventions, architecture, testing, security) live in `.spec/memory.md` — the single source of truth read by every sub-agent.
17
+ - **Memory-first** — Cross-cutting standards (coding conventions, architecture, testing, security) live in `.spec-lite/memory.md` — the single source of truth read by every sub-agent.
18
18
  - **Provider-agnostic** — Works with GitHub Copilot, Claude Code, or any LLM via generic mode.
19
19
 
20
20
  ---
@@ -22,7 +22,7 @@ spec-lite is a set of **modular prompt files** — each defining a specialist AI
22
22
  ## Installation
23
23
 
24
24
  ```bash
25
- npm install -g spec-lite
25
+ npm install -g @abranjith/spec-lite
26
26
  ```
27
27
 
28
28
  Requires Node.js 18+.
@@ -47,7 +47,7 @@ The CLI will walk you through a short **project profile questionnaire** (languag
47
47
  1. Write agent prompt files to the correct location for your AI tool
48
48
  2. Inject your tech-stack context into every prompt's `<!-- project-context -->` block
49
49
  3. Copy a curated **best-practice snippet** for your stack into `.spec-lite/stacks/`
50
- 4. Create the `.spec/` directory structure for agent outputs
50
+ 4. Create the `.spec-lite/` directory structure for agent outputs
51
51
  5. Save a `.spec-lite.json` config (including your project profile) to track your setup
52
52
 
53
53
  After init completes, run **`/memorize bootstrap`** (see below) to let the LLM auto-generate a comprehensive `memory.md` from your codebase.
@@ -88,12 +88,12 @@ More providers (Cursor, Windsurf, Cline, Zed) coming soon.
88
88
 
89
89
  ## Memory-First Architecture
90
90
 
91
- spec-lite uses a **memory-first** approach: cross-cutting concerns that every sub-agent needs — coding standards, architecture patterns, testing conventions, security guidelines, logging strategy — live in a single file: **`.spec/memory.md`**.
91
+ spec-lite uses a **memory-first** approach: cross-cutting concerns that every sub-agent needs — coding standards, architecture patterns, testing conventions, security guidelines, logging strategy — live in a single file: **`.spec-lite/memory.md`**.
92
92
 
93
93
  | Source | Purpose | Authority |
94
94
  |--------|---------|-----------|
95
- | `.spec/memory.md` | Cross-cutting standards & conventions | **Primary** — authoritative for all sub-agents |
96
- | `.spec/plan.md` or `.spec/plan_<name>.md` | Project-specific blueprint(s) & task breakdown | Overrides memory only with explicit justification |
95
+ | `.spec-lite/memory.md` | Cross-cutting standards & conventions | **Primary** — authoritative for all sub-agents |
96
+ | `.spec-lite/plan.md` or `.spec-lite/plan_<name>.md` | Project-specific blueprint(s) & task breakdown | Overrides memory only with explicit justification |
97
97
  | User instruction | Ad-hoc guidance in chat | Highest priority (trumps both) |
98
98
 
99
99
  ### Bootstrap Flow
@@ -121,45 +121,47 @@ spec_help (anytime)
121
121
 
122
122
  ┌─ /memorize bootstrap (one-time setup)
123
123
 
124
- Brainstorm ─→ Planner ─→ Feature (×N) ─→ Reviews ─→ Tests ─→ DevOps ─→ Docs
124
+ Brainstorm ─→ Planner ─→ Architect ─→ Feature (×N) ─→ Reviews ─→ Tests ─→ DevOps ─→ Docs
125
125
  │ ├─ Code Review
126
126
  │ ├─ Security Audit
127
127
  ▼ └─ Performance Review
128
128
  TODO.md (living backlog)
129
129
  ```
130
130
 
131
- All sub-agents read `.spec/memory.md` first for standing instructions, then the relevant plan (`.spec/plan.md` or `.spec/plan_<name>.md`) for project-specific context. Complex projects can have multiple named plans — one per domain (e.g., `plan_order_management.md`, `plan_catalog.md`). Not every project needs every sub-agent. Start with the Planner if you already have requirements. Use `spec-lite list` or the spec_help sub-agent to understand the pipeline.
131
+ All sub-agents read `.spec-lite/memory.md` first for standing instructions, then the relevant plan (`.spec-lite/plan.md` or `.spec-lite/plan_<name>.md`) for project-specific context. Complex projects can have multiple named plans — one per domain (e.g., `plan_order_management.md`, `plan_catalog.md`). Not every project needs every sub-agent. Start with the Planner if you already have requirements. Use `spec-lite list` or the spec_help sub-agent to understand the pipeline.
132
132
 
133
133
  ## Sub-Agent Prompt Files
134
134
 
135
135
  | File | Sub-Agent | What It Does | Output |
136
136
  |------|-----------|-------------|--------|
137
137
  | [spec_help.md](prompts/spec_help.md) | Spec Help | Navigator — explains which sub-agent to use and when | Interactive guidance |
138
- | [brainstorm.md](prompts/brainstorm.md) | Brainstorm | Back-and-forth ideation partner that refines vague ideas | `.spec/brainstorm.md` |
139
- | [planner.md](prompts/planner.md) | Planner | Creates a detailed technical blueprint (living document) | `.spec/plan.md` or `.spec/plan_<name>.md` |
140
- | [feature.md](prompts/feature.md) | Feature | 3-phase lifecycle: explore tasks implement+test+docs | `.spec/features/feature_<name>.md` |
141
- | [code_review.md](prompts/code_review.md) | Code Review | Reviews code for correctness, architecture, readability | `.spec/reviews/code_review_<name>.md` |
142
- | [security_audit.md](prompts/security_audit.md) | Security Audit | Threat-models and scans for vulnerabilities | `.spec/reviews/security_audit.md` |
143
- | [performance_review.md](prompts/performance_review.md) | Performance Review | Identifies bottlenecks and optimization opportunities | `.spec/reviews/performance_review.md` |
144
- | [integration_tests.md](prompts/integration_tests.md) | Integration Tests | Writes traceable integration test scenarios from feature specs | `.spec/features/integration_tests_<name>.md` |
145
- | [unit_tests.md](prompts/unit_tests.md) | Unit Tests | Generates comprehensive unit tests with edge-case coverage and smart coverage exclusions | `.spec/features/unit_tests_<name>.md` |
146
- | [devops.md](prompts/devops.md) | DevOps | Sets up Docker, CI/CD, environments, and deployment | `.spec/devops/` + infra files |
147
- | [fix.md](prompts/fix.md) | Fix | Debugs issues with root cause analysis + regression tests | `.spec/reviews/fix_<issue>.md` |
138
+ | [brainstorm.md](prompts/brainstorm.md) | Brainstorm | Back-and-forth ideation partner that refines vague ideas | `.spec-lite/brainstorm.md` |
139
+ | [planner.md](prompts/planner.md) | Planner | Creates a detailed technical blueprint (living document) | `.spec-lite/plan.md` or `.spec-lite/plan_<name>.md` |
140
+ | [architect.md](prompts/architect.md) | Architect | Designs cloud infrastructure, database strategy, and scaling architecture | `.spec-lite/architect_<name>.md` |
141
+ | [feature.md](prompts/feature.md) | Feature | 3-phase lifecycle: explore tasks implement+test+docs | `.spec-lite/features/feature_<name>.md` |
142
+ | [code_review.md](prompts/code_review.md) | Code Review | Reviews code for correctness, architecture, readability | `.spec-lite/reviews/code_review_<name>.md` |
143
+ | [security_audit.md](prompts/security_audit.md) | Security Audit | Threat-models and scans for vulnerabilities | `.spec-lite/reviews/security_audit.md` |
144
+ | [performance_review.md](prompts/performance_review.md) | Performance Review | Identifies bottlenecks and optimization opportunities | `.spec-lite/reviews/performance_review.md` |
145
+ | [integration_tests.md](prompts/integration_tests.md) | Integration Tests | Writes traceable integration test scenarios from feature specs | `.spec-lite/features/integration_tests_<name>.md` |
146
+ | [unit_tests.md](prompts/unit_tests.md) | Unit Tests | Generates comprehensive unit tests with edge-case coverage and smart coverage exclusions | `.spec-lite/features/unit_tests_<name>.md` |
147
+ | [devops.md](prompts/devops.md) | DevOps | Sets up Docker, CI/CD, environments, and deployment | `.spec-lite/devops/` + infra files |
148
+ | [fix.md](prompts/fix.md) | Fix | Debugs issues with root cause analysis + regression tests | `.spec-lite/reviews/fix_<issue>.md` |
148
149
  | [technical_docs.md](prompts/technical_docs.md) | Technical Docs | Creates architecture docs, API references, setup guides | Technical documentation |
149
150
  | [readme.md](prompts/readme.md) | README | Writes the project README | `README.md` |
150
- | [memorize.md](prompts/memorize.md) | Memorize | Manages `.spec/memory.md` — standing instructions for all agents. Use `/memorize bootstrap` to auto-generate. | `.spec/memory.md` |
151
+ | [memorize.md](prompts/memorize.md) | Memorize | Manages `.spec-lite/memory.md` — standing instructions for all agents. Use `/memorize bootstrap` to auto-generate. | `.spec-lite/memory.md` |
151
152
  | [orchestrator.md](prompts/orchestrator.md) | — | Meta-document: pipeline, memory protocol, conflict resolution | Reference only |
152
153
 
153
154
  ## Output Directory Structure
154
155
 
155
- spec-lite sub-agents produce artifacts in the `.spec/` directory (version-controlled project metadata):
156
+ spec-lite sub-agents produce artifacts in the `.spec-lite/` directory (version-controlled project metadata):
156
157
 
157
158
  ```
158
- .spec/
159
+ .spec-lite/
159
160
  ├── memory.md # Cross-cutting standards — authoritative source
160
161
  ├── brainstorm.md
161
162
  ├── plan.md # Default plan (simple projects) — user-modifiable
162
163
  ├── plan_<name>.md # Named plans (complex projects, e.g., plan_order_management.md)
164
+ ├── architect_<name>.md # Cloud & infrastructure architecture (e.g., architect_fintech_platform.md)
163
165
  ├── TODO.md # Enhancement backlog — maintained by planner + feature
164
166
  ├── features/
165
167
  │ ├── feature_user_management.md
@@ -184,7 +186,7 @@ See [orchestrator.md](prompts/orchestrator.md) for the complete workflow documen
184
186
  - The full sub-agent pipeline DAG
185
187
  - Memory protocol — which artifacts each sub-agent reads
186
188
  - Conflict resolution rules (user instruction > plan > sub-agent expertise)
187
- - Enhancement tracking via `.spec/TODO.md`
189
+ - Enhancement tracking via `.spec-lite/TODO.md`
188
190
  - Invocation patterns for different scenarios (new project, feature addition, bug fix)
189
191
 
190
192
  ## CLI Commands
@@ -228,13 +230,13 @@ spec-lite relies on **git** for artifact versioning. When a plan or review is up
228
230
 
229
231
  spec-lite is designed to be forked and adapted:
230
232
 
231
- - **Bootstrap memory first** — run `/memorize bootstrap` after init to populate `.spec/memory.md` with your project's standards.
232
- - **Edit memory directly** — `.spec/memory.md` is the standing-instruction file. Your edits persist across all sub-agent invocations.
233
+ - **Bootstrap memory first** — run `/memorize bootstrap` after init to populate `.spec-lite/memory.md` with your project's standards.
234
+ - **Edit memory directly** — `.spec-lite/memory.md` is the standing-instruction file. Your edits persist across all sub-agent invocations.
233
235
  - **Add project-specific conventions** to the Project Context blocks or directly to memory.
234
236
  - **Remove sub-agents** you don't need.
235
237
  - **Add new sub-agents** following the same pattern (Persona → Required Context → Process → Output Template → Constraints).
236
238
  - **Modify output paths** to match your project's directory structure.
237
- - **Edit the plan** — `.spec/plan.md` (or `.spec/plan_<name>.md` for named plans) is a living document. Your edits take priority over sub-agent defaults.
239
+ - **Edit the plan** — `.spec-lite/plan.md` (or `.spec-lite/plan_<name>.md` for named plans) is a living document. Your edits take priority over sub-agent defaults.
238
240
  - **Add stack snippets** — drop a `<language>.md` file into `src/stacks/` to add best-practice snippets for additional languages.
239
241
 
240
242
  Contributions welcome — especially for new sub-agent types, improvements to existing prompts, and real-world usage feedback.