blueprint-os 1.0.0
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/.agent/skills/brainstorming/SKILL.md +157 -0
- package/.agent/skills/code-review/SKILL.md +80 -0
- package/.agent/skills/creating-skills/SKILL.md +141 -0
- package/.agent/skills/deploying-standards/SKILL.md +85 -0
- package/.agent/skills/discovering-standards/SKILL.md +107 -0
- package/.agent/skills/quality-assurance/SKILL.md +68 -0
- package/.agent/skills/security-audit/SKILL.md +115 -0
- package/.agent/skills/shaping-specs/SKILL.md +120 -0
- package/README.md +406 -0
- package/adapters/antigravity.md +147 -0
- package/adapters/claude-code.md +160 -0
- package/adapters/cursor.md +131 -0
- package/adapters/skills-sh.md +134 -0
- package/bin/blueprint-os.js +14 -0
- package/lib/init.js +43 -0
- package/package.json +33 -0
- package/references/README.md +62 -0
- package/references/agent-workflow/Skills.md +155 -0
- package/references/agent-workflow/agent-os-link.md +1 -0
- package/references/agent-workflow/blast.md +155 -0
- package/references/agent-workflow/superpowers-link.md +1 -0
- package/standards/README.md +123 -0
|
@@ -0,0 +1,115 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: security-audit
|
|
3
|
+
description: Audits code changes for security vulnerabilities and data exposure. Use when the user asks for a security audit, SEC review, or before merge of auth, API, or sensitive data changes. Required for authentication, API endpoints, and sensitive data handling. Applies to frontend and backend.
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# Security Audit
|
|
7
|
+
|
|
8
|
+
## When to use this skill
|
|
9
|
+
|
|
10
|
+
- User asks to "security audit", "SEC", or "audit for vulnerabilities"
|
|
11
|
+
- Before merge when changes touch authentication, API endpoints, or sensitive data
|
|
12
|
+
- Implementation involves user input, file uploads, or third-party integrations
|
|
13
|
+
- After quality-assurance when tests revealed security-sensitive code paths
|
|
14
|
+
|
|
15
|
+
## Workflow
|
|
16
|
+
|
|
17
|
+
- [ ] Load the spec from `specs/<feature-name>.md`
|
|
18
|
+
- [ ] Load changed files and identify security-relevant code
|
|
19
|
+
- [ ] Run through the security checklist (frontend and backend as applicable)
|
|
20
|
+
- [ ] Assign severity to each finding (Critical, High, Medium, Low)
|
|
21
|
+
- [ ] Produce audit report inline or in `specs/<feature-name>-security-audit.md`
|
|
22
|
+
- [ ] Block merge for Critical and High; document Medium and Low for resolution
|
|
23
|
+
|
|
24
|
+
## Instructions
|
|
25
|
+
|
|
26
|
+
### When this skill is required
|
|
27
|
+
|
|
28
|
+
Run security-audit before merge when the change involves:
|
|
29
|
+
|
|
30
|
+
- Authentication or authorization flows
|
|
31
|
+
- API endpoints (new or modified)
|
|
32
|
+
- Sensitive data (passwords, tokens, PII, API keys)
|
|
33
|
+
- User input processing or file uploads
|
|
34
|
+
- Third-party integrations or external service calls
|
|
35
|
+
|
|
36
|
+
### Security checklist
|
|
37
|
+
|
|
38
|
+
**Data protection (frontend and backend)**
|
|
39
|
+
|
|
40
|
+
- No sensitive data in client-side code, logs, or error messages
|
|
41
|
+
- No passwords, tokens, or API keys in localStorage/sessionStorage without encryption
|
|
42
|
+
- Secrets use environment variables only; .env never committed
|
|
43
|
+
- Validate all user inputs before processing or sending to backend
|
|
44
|
+
- Sanitize outputs to prevent XSS
|
|
45
|
+
|
|
46
|
+
**Frontend-specific**
|
|
47
|
+
|
|
48
|
+
- No eval(), Function(), or innerHTML with user-controlled data
|
|
49
|
+
- Token handling uses httpOnly cookies when possible
|
|
50
|
+
- API calls use centralized client; no arbitrary external requests
|
|
51
|
+
- Third-party scripts and dynamic imports reference trusted sources
|
|
52
|
+
|
|
53
|
+
**Backend-specific**
|
|
54
|
+
|
|
55
|
+
- Auth checks occur server-side; never trust client for authorization
|
|
56
|
+
- SQL/NoSQL injection prevented via parameterized queries or ORM
|
|
57
|
+
- File uploads validated (type, size) before processing
|
|
58
|
+
- Rate limiting and CORS configured appropriately
|
|
59
|
+
|
|
60
|
+
**Network**
|
|
61
|
+
|
|
62
|
+
- HTTPS only for production
|
|
63
|
+
- No credentials in URLs or query params
|
|
64
|
+
- CORS explicitly defined on backend
|
|
65
|
+
|
|
66
|
+
**Dependencies**
|
|
67
|
+
|
|
68
|
+
- New dependencies checked for known vulnerabilities (npm audit, etc.)
|
|
69
|
+
- Avoid packages with excessive permissions or unclear provenance
|
|
70
|
+
|
|
71
|
+
**Configuration**
|
|
72
|
+
|
|
73
|
+
- .cursorignore blocks agent access to sensitive config
|
|
74
|
+
- Workspace trust enabled for unknown repositories
|
|
75
|
+
|
|
76
|
+
### Severity levels
|
|
77
|
+
|
|
78
|
+
| Level | Examples | Action |
|
|
79
|
+
|-------|----------|--------|
|
|
80
|
+
| Critical | Data exposure, auth bypass, arbitrary code execution | Block merge |
|
|
81
|
+
| High | XSS, insecure storage, missing input validation | Block merge |
|
|
82
|
+
| Medium | Verbose errors, dependency vulns, missing error handling | Document for resolution |
|
|
83
|
+
| Low | Style issues that could cause security confusion | Document |
|
|
84
|
+
|
|
85
|
+
### Audit report format
|
|
86
|
+
|
|
87
|
+
Save to `specs/<feature-name>-security-audit.md` or append to the spec:
|
|
88
|
+
|
|
89
|
+
```markdown
|
|
90
|
+
## Security audit — [date]
|
|
91
|
+
|
|
92
|
+
### Summary
|
|
93
|
+
[Pass / Block — list Critical/High if blocking]
|
|
94
|
+
|
|
95
|
+
### Findings
|
|
96
|
+
| Severity | Location | Issue | Recommendation |
|
|
97
|
+
|----------|----------|-------|----------------|
|
|
98
|
+
| High | path/to/file.ts:42 | [description] | [fix] |
|
|
99
|
+
|
|
100
|
+
### Checklist coverage
|
|
101
|
+
- [x] Data protection
|
|
102
|
+
- [x] Input validation
|
|
103
|
+
- [ ] [any unchecked items]
|
|
104
|
+
```
|
|
105
|
+
|
|
106
|
+
## Handoff
|
|
107
|
+
|
|
108
|
+
- Recommend running `code-review` after audit
|
|
109
|
+
- If Critical or High: list required fixes; do not recommend merge until resolved
|
|
110
|
+
|
|
111
|
+
## Resources
|
|
112
|
+
|
|
113
|
+
- Spec directory: `specs/`
|
|
114
|
+
- Standards: `standards/authentication.md`, `standards/api-design.md` if present
|
|
115
|
+
- Next step: `.agent/skills/code-review/SKILL.md`
|
|
@@ -0,0 +1,120 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: shaping-specs
|
|
3
|
+
description: Shapes a structured spec for a feature or task by asking clarifying questions and saving the output to a persistent file. Use when the user wants to plan a feature, create a spec, write a PRD, or define what to build before coding starts.
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# Shaping Specs
|
|
7
|
+
|
|
8
|
+
## When to use this skill
|
|
9
|
+
|
|
10
|
+
- User wants to plan a feature before implementation
|
|
11
|
+
- User asks to "create a spec", "write a PRD", or "shape this idea"
|
|
12
|
+
- A brainstorm document exists in `specs/brainstorm-<name>.md` and is ready to formalize
|
|
13
|
+
- User is starting work on a new feature, epic, or significant change where the approach is already decided
|
|
14
|
+
|
|
15
|
+
**If the approach is still undecided or the problem is not fully understood, run `brainstorming` first.**
|
|
16
|
+
Load `.agent/skills/brainstorming/SKILL.md` and complete that workflow before returning here.
|
|
17
|
+
The brainstorm document (`specs/brainstorm-<name>.md`) becomes the starting context for spec shaping.
|
|
18
|
+
|
|
19
|
+
## Workflow
|
|
20
|
+
|
|
21
|
+
- [ ] Check for a brainstorm document in `specs/brainstorm-<name>.md` — load it if it exists
|
|
22
|
+
- [ ] Load relevant standards from `standards/` and references from `references/` if they exist
|
|
23
|
+
- [ ] Ask the shaping questions (see below) — skip any already answered in the brainstorm doc
|
|
24
|
+
- [ ] Confirm answers with the user before proceeding
|
|
25
|
+
- [ ] Write the spec file to `specs/<feature-name>.md`
|
|
26
|
+
- [ ] Summarize the spec and confirm it is ready to execute
|
|
27
|
+
|
|
28
|
+
## Instructions
|
|
29
|
+
|
|
30
|
+
### Shaping questions
|
|
31
|
+
|
|
32
|
+
Ask these questions in a conversational flow. Adapt wording to context, but cover every area:
|
|
33
|
+
|
|
34
|
+
**1. What are we building?**
|
|
35
|
+
- What is the feature or task in one sentence?
|
|
36
|
+
- What problem does it solve for the user?
|
|
37
|
+
|
|
38
|
+
**2. Who is it for?**
|
|
39
|
+
- Who is the primary user or system consuming this?
|
|
40
|
+
- Are there secondary users or systems affected?
|
|
41
|
+
|
|
42
|
+
**3. What does success look like?**
|
|
43
|
+
- What is the expected behavior when it works correctly?
|
|
44
|
+
- Are there measurable outcomes or acceptance criteria?
|
|
45
|
+
|
|
46
|
+
**4. What are the boundaries?**
|
|
47
|
+
- What is explicitly out of scope?
|
|
48
|
+
- Are there constraints (performance, security, compatibility)?
|
|
49
|
+
|
|
50
|
+
**5. What already exists?**
|
|
51
|
+
- Which files, modules, or components are relevant?
|
|
52
|
+
- Is there existing code to extend, or is this net new?
|
|
53
|
+
|
|
54
|
+
**6. What are the risks?**
|
|
55
|
+
- What could go wrong?
|
|
56
|
+
- Are there edge cases or failure modes to account for?
|
|
57
|
+
|
|
58
|
+
**7. What standards apply?**
|
|
59
|
+
- Which entries in `standards/` are relevant to this task?
|
|
60
|
+
|
|
61
|
+
**8. What references apply?**
|
|
62
|
+
- Are there design docs, flowcharts, or diagrams in `references/` that define this feature?
|
|
63
|
+
|
|
64
|
+
### Spec file format
|
|
65
|
+
|
|
66
|
+
Save the completed spec to `specs/<feature-name>.md`:
|
|
67
|
+
|
|
68
|
+
```markdown
|
|
69
|
+
# Spec: [Feature Name]
|
|
70
|
+
|
|
71
|
+
**Date:** [YYYY-MM-DD]
|
|
72
|
+
**Status:** Draft | Ready | In Progress | Done
|
|
73
|
+
|
|
74
|
+
## What we're building
|
|
75
|
+
[One paragraph summary]
|
|
76
|
+
|
|
77
|
+
## Users and context
|
|
78
|
+
[Who this is for and why]
|
|
79
|
+
|
|
80
|
+
## Success criteria
|
|
81
|
+
- [ ] [Criterion 1]
|
|
82
|
+
- [ ] [Criterion 2]
|
|
83
|
+
|
|
84
|
+
## Scope
|
|
85
|
+
**In scope:**
|
|
86
|
+
- [Item]
|
|
87
|
+
|
|
88
|
+
**Out of scope:**
|
|
89
|
+
- [Item]
|
|
90
|
+
|
|
91
|
+
## Relevant files and modules
|
|
92
|
+
- `path/to/file.ts` — [why it's relevant]
|
|
93
|
+
|
|
94
|
+
## Risks and edge cases
|
|
95
|
+
- [Risk or edge case]
|
|
96
|
+
|
|
97
|
+
## Applicable standards
|
|
98
|
+
- `standards/[file].md` — [which section]
|
|
99
|
+
|
|
100
|
+
## Applicable references
|
|
101
|
+
- `references/[file]` — [design, flowchart, diagram that defines this]
|
|
102
|
+
|
|
103
|
+
## Implementation notes
|
|
104
|
+
[Any technical direction, decisions, or constraints to carry into execution]
|
|
105
|
+
```
|
|
106
|
+
|
|
107
|
+
### Execution hand-off
|
|
108
|
+
|
|
109
|
+
After saving the spec, tell the agent (or user) to run the `deploying-standards` skill before executing, so relevant standards are loaded alongside the spec.
|
|
110
|
+
|
|
111
|
+
After execution, consider running `quality-assurance`, `security-audit` (for auth, API, or sensitive data changes), and `code-review` before merge.
|
|
112
|
+
|
|
113
|
+
## Resources
|
|
114
|
+
|
|
115
|
+
- Run first if approach is undecided: `.agent/skills/brainstorming/SKILL.md`
|
|
116
|
+
- Standards reference: `standards/README.md`
|
|
117
|
+
- References index: `references/README.md`
|
|
118
|
+
- Spec output directory: `specs/`
|
|
119
|
+
- Deploy before executing: `.agent/skills/deploying-standards/SKILL.md`
|
|
120
|
+
- Quality gates after execution: `.agent/skills/quality-assurance/SKILL.md`, `.agent/skills/security-audit/SKILL.md`, `.agent/skills/code-review/SKILL.md`
|
package/README.md
ADDED
|
@@ -0,0 +1,406 @@
|
|
|
1
|
+
# Blueprint OS
|
|
2
|
+
|
|
3
|
+
A portable, tool-agnostic AI agent workflow system built on skills and standards. Works in Cursor, Antigravity, Claude Code, or any AI IDE.
|
|
4
|
+
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
## What is Blueprint OS?
|
|
8
|
+
|
|
9
|
+
Every time you start a new session with an AI agent, you re-teach it your context — your conventions, your architecture, your preferences. Blueprint OS eliminates that friction.
|
|
10
|
+
|
|
11
|
+
It gives your AI agent a persistent operating system:
|
|
12
|
+
|
|
13
|
+
- **Skills** — reusable instruction sets the agent follows for specific tasks
|
|
14
|
+
- **Standards** — documented patterns extracted from your codebase
|
|
15
|
+
- **Specs** — structured plans shaped before execution
|
|
16
|
+
|
|
17
|
+
Since everything is plain markdown, it works with any tool that can read files.
|
|
18
|
+
|
|
19
|
+
---
|
|
20
|
+
|
|
21
|
+
## Workflow
|
|
22
|
+
|
|
23
|
+
```mermaid
|
|
24
|
+
flowchart TD
|
|
25
|
+
Start([New Product or Feature]) --> IsNew{New or existing codebase?}
|
|
26
|
+
IsNew -->|New product| Brainstorm[Brainstorm]
|
|
27
|
+
IsNew -->|Existing codebase| DiscoverStandards[Discover Standards]
|
|
28
|
+
DiscoverStandards --> Brainstorm
|
|
29
|
+
|
|
30
|
+
subgraph planning [Planning]
|
|
31
|
+
Brainstorm --> ShapeSpec[Shape Spec]
|
|
32
|
+
ShapeSpec --> DeployStandards[Deploy Standards & References]
|
|
33
|
+
end
|
|
34
|
+
|
|
35
|
+
subgraph execution [Execution]
|
|
36
|
+
DeployStandards --> Execute[Execute with Agent]
|
|
37
|
+
end
|
|
38
|
+
|
|
39
|
+
subgraph qualityGates [Quality Gates - Optional]
|
|
40
|
+
Execute --> QA[Quality Assurance]
|
|
41
|
+
QA --> SEC[Security Audit]
|
|
42
|
+
SEC --> REV[Code Review]
|
|
43
|
+
end
|
|
44
|
+
|
|
45
|
+
REV --> Review{Review Output}
|
|
46
|
+
Review -->|Standards need updating| DiscoverStandards
|
|
47
|
+
Review -->|Next feature| Brainstorm
|
|
48
|
+
Review -->|New capability needed| SearchSkillssh[Search skills.sh]
|
|
49
|
+
SearchSkillssh -->|Found| InstallSkill[Install and customize]
|
|
50
|
+
SearchSkillssh -->|Not found| CreateSkill[Create from scratch]
|
|
51
|
+
InstallSkill --> ShapeSpec
|
|
52
|
+
CreateSkill --> ShapeSpec
|
|
53
|
+
```
|
|
54
|
+
|
|
55
|
+
### The Core Loop
|
|
56
|
+
|
|
57
|
+
| Step | What happens | Skill |
|
|
58
|
+
|---|---|---|
|
|
59
|
+
| 1. Plan Product | Document your mission, stack, and roadmap | *(manual)* |
|
|
60
|
+
| 2. Discover Standards | Extract patterns from your codebase into `standards/` files | `discovering-standards` |
|
|
61
|
+
| 3. Brainstorm | Explore the problem, compare approaches, produce a design document | `brainstorming` |
|
|
62
|
+
| 4. Shape Spec | Formalize the chosen direction into an implementation spec | `shaping-specs` |
|
|
63
|
+
| 5. Deploy Standards | Inject relevant standards and references into the agent's context | `deploying-standards` |
|
|
64
|
+
| 6. Execute | Run the agent with full context | *(your agent)* |
|
|
65
|
+
| 7a. Quality Assurance *(optional)* | Add or update tests against acceptance criteria | `quality-assurance` |
|
|
66
|
+
| 7b. Security Audit *(optional)* | Audit auth, API, or sensitive data changes | `security-audit` |
|
|
67
|
+
| 7c. Code Review *(optional)* | Validate against spec and standards before merge | `code-review` |
|
|
68
|
+
| 8. Review & Refine | Update standards as patterns evolve | repeat |
|
|
69
|
+
|
|
70
|
+
---
|
|
71
|
+
|
|
72
|
+
## Quick Start
|
|
73
|
+
|
|
74
|
+
### 1. Install Blueprint OS into your project
|
|
75
|
+
|
|
76
|
+
From your project directory:
|
|
77
|
+
|
|
78
|
+
```bash
|
|
79
|
+
npx blueprint-os init
|
|
80
|
+
```
|
|
81
|
+
|
|
82
|
+
This copies `.agent/`, `standards/`, `references/`, and `adapters/` into your project. No dependency is added to `package.json`.
|
|
83
|
+
|
|
84
|
+
**Or copy manually:** Place the `.agent/` folder, `standards/` folder, and `references/` folder at the root of your project:
|
|
85
|
+
|
|
86
|
+
```
|
|
87
|
+
your-project/
|
|
88
|
+
├── .agent/
|
|
89
|
+
│ └── skills/
|
|
90
|
+
├── standards/
|
|
91
|
+
├── references/
|
|
92
|
+
└── ... your code
|
|
93
|
+
```
|
|
94
|
+
|
|
95
|
+
### 2. Choose your tool
|
|
96
|
+
|
|
97
|
+
| Tool | Setup | Guide |
|
|
98
|
+
|---|---|---|
|
|
99
|
+
| Cursor | Reference SKILL.md files via `.cursor/rules/` | [adapters/cursor.md](adapters/cursor.md) |
|
|
100
|
+
| Antigravity | Native — `.agent/skills/` is the default path | [adapters/antigravity.md](adapters/antigravity.md) |
|
|
101
|
+
| Claude Code | Use slash commands or `@file` references | [adapters/claude-code.md](adapters/claude-code.md) |
|
|
102
|
+
| skills.sh | Install community skills with `npx skills add` | [adapters/skills-sh.md](adapters/skills-sh.md) |
|
|
103
|
+
| Any other AI | Paste or reference `SKILL.md` content directly | Read the skill file and include it in your prompt |
|
|
104
|
+
|
|
105
|
+
### 3. Run your first workflow
|
|
106
|
+
|
|
107
|
+
**Starting a new product (no codebase yet):**
|
|
108
|
+
|
|
109
|
+
```
|
|
110
|
+
1. Ask your agent: "Read .agent/skills/brainstorming/SKILL.md and brainstorm [product idea]"
|
|
111
|
+
2. Ask your agent: "Read .agent/skills/shaping-specs/SKILL.md and shape a spec using specs/brainstorm-<name>.md"
|
|
112
|
+
3. Ask your agent: "Read .agent/skills/deploying-standards/SKILL.md and inject relevant standards for [task]"
|
|
113
|
+
```
|
|
114
|
+
|
|
115
|
+
**Starting a new feature in an existing codebase:**
|
|
116
|
+
|
|
117
|
+
```
|
|
118
|
+
1. Ask your agent: "Read .agent/skills/discovering-standards/SKILL.md and document my codebase standards"
|
|
119
|
+
2. Ask your agent: "Read .agent/skills/brainstorming/SKILL.md and brainstorm [feature] with the existing standards loaded"
|
|
120
|
+
3. Ask your agent: "Read .agent/skills/shaping-specs/SKILL.md and shape a spec using specs/brainstorm-<name>.md"
|
|
121
|
+
4. Ask your agent: "Read .agent/skills/deploying-standards/SKILL.md and inject relevant standards for [task]"
|
|
122
|
+
```
|
|
123
|
+
|
|
124
|
+
**Adding a new skill:**
|
|
125
|
+
|
|
126
|
+
```
|
|
127
|
+
1. Browse https://skills.sh or run: npx skills add find-skills
|
|
128
|
+
2. If found: npx skills add <owner/repo>
|
|
129
|
+
3. If not found: ask your agent "Read .agent/skills/creating-skills/SKILL.md and create a skill for [task]"
|
|
130
|
+
```
|
|
131
|
+
|
|
132
|
+
---
|
|
133
|
+
|
|
134
|
+
## Skills Index
|
|
135
|
+
|
|
136
|
+
Skills live in `.agent/skills/`. Each skill is a `SKILL.md` file the agent reads and follows.
|
|
137
|
+
|
|
138
|
+
| Skill | Path | Purpose |
|
|
139
|
+
|---|---|---|
|
|
140
|
+
| Brainstorming | `.agent/skills/brainstorming/` | Explore problems, compare approaches, produce a design document |
|
|
141
|
+
| Creating Skills | `.agent/skills/creating-skills/` | Find on skills.sh first, author from scratch as fallback |
|
|
142
|
+
| Shaping Specs | `.agent/skills/shaping-specs/` | Formalize a chosen direction into an implementation spec |
|
|
143
|
+
| Discovering Standards | `.agent/skills/discovering-standards/` | Extract codebase patterns into standards files |
|
|
144
|
+
| Deploying Standards | `.agent/skills/deploying-standards/` | Inject relevant standards and references into agent context |
|
|
145
|
+
| Quality Assurance | `.agent/skills/quality-assurance/` | Add or update tests, validate against acceptance criteria |
|
|
146
|
+
| Security Audit | `.agent/skills/security-audit/` | Audit auth, API, and sensitive data changes before merge |
|
|
147
|
+
| Code Review | `.agent/skills/code-review/` | Final validation against spec and standards before merge |
|
|
148
|
+
|
|
149
|
+
**Community skills** from [skills.sh](https://skills.sh) install directly into `.agent/skills/` and work with Blueprint OS out of the box. Run `npx skills add <owner/repo>` to install any skill from the registry.
|
|
150
|
+
|
|
151
|
+
---
|
|
152
|
+
|
|
153
|
+
## When to brainstorm vs. shape a spec
|
|
154
|
+
|
|
155
|
+
These two skills are sequential, not interchangeable.
|
|
156
|
+
|
|
157
|
+
| Situation | Start with |
|
|
158
|
+
|---|---|
|
|
159
|
+
| You know what to build and how | `shaping-specs` directly |
|
|
160
|
+
| You know what to build but not how | `brainstorming` first |
|
|
161
|
+
| You have a rough idea but it's unclear | `brainstorming` first |
|
|
162
|
+
| New product, no codebase yet | `brainstorming` first |
|
|
163
|
+
| New feature in a legacy codebase | `discovering-standards` → `brainstorming` → `shaping-specs` |
|
|
164
|
+
| Bug fix or small task | `shaping-specs` or skip to `deploying-standards` |
|
|
165
|
+
|
|
166
|
+
**Brainstorming produces a design document** (`specs/brainstorm-<name>.md`). Spec shaping picks that up and formalizes it into an implementation spec (`specs/<feature-name>.md`). They're two steps in the same pipeline, not alternatives.
|
|
167
|
+
|
|
168
|
+
---
|
|
169
|
+
|
|
170
|
+
## When to use quality gates
|
|
171
|
+
|
|
172
|
+
Quality gates run after implementation and before merge. They are optional — use them when rigor matters.
|
|
173
|
+
|
|
174
|
+
| Gate | When to run |
|
|
175
|
+
|------|-------------|
|
|
176
|
+
| `quality-assurance` | After implementation; add or update tests against spec acceptance criteria |
|
|
177
|
+
| `security-audit` | Required for auth flows, API endpoints, sensitive data handling |
|
|
178
|
+
| `code-review` | Before merge; validates scope alignment and that SEC was run when required |
|
|
179
|
+
|
|
180
|
+
Typical order: QA → SEC (if auth/API/sensitive) → REV.
|
|
181
|
+
|
|
182
|
+
---
|
|
183
|
+
|
|
184
|
+
## Scenarios
|
|
185
|
+
|
|
186
|
+
Real-world walkthroughs showing exactly how Blueprint OS fits into your work.
|
|
187
|
+
|
|
188
|
+
---
|
|
189
|
+
|
|
190
|
+
### Scenario 1 — Brand new SaaS product
|
|
191
|
+
|
|
192
|
+
You have an idea. No code exists yet.
|
|
193
|
+
|
|
194
|
+
**Step 1: Brainstorm the product**
|
|
195
|
+
```
|
|
196
|
+
Read .agent/skills/brainstorming/SKILL.md and brainstorm a task management app for remote teams
|
|
197
|
+
```
|
|
198
|
+
The agent asks Socratic questions, presents 3 approaches (e.g., kanban vs. list-based vs. AI-prioritized), and saves the chosen direction to `specs/brainstorm-task-app.md`.
|
|
199
|
+
|
|
200
|
+
**Step 2: Shape the first feature spec**
|
|
201
|
+
```
|
|
202
|
+
Read .agent/skills/shaping-specs/SKILL.md and shape a spec using specs/brainstorm-task-app.md
|
|
203
|
+
```
|
|
204
|
+
The agent formalizes the brainstorm into `specs/user-auth.md` with scope, success criteria, and implementation notes.
|
|
205
|
+
|
|
206
|
+
**Step 3: Execute**
|
|
207
|
+
```
|
|
208
|
+
Read .agent/skills/deploying-standards/SKILL.md and inject standards and references for building a Next.js auth system
|
|
209
|
+
```
|
|
210
|
+
The agent loads any standards and references you have (design docs, flowcharts if present) and proceeds to build with full context.
|
|
211
|
+
|
|
212
|
+
---
|
|
213
|
+
|
|
214
|
+
### Scenario 2 — New feature in a legacy codebase
|
|
215
|
+
|
|
216
|
+
You've been handed a 3-year-old Express API and need to add a payments feature.
|
|
217
|
+
|
|
218
|
+
**Step 1: Discover what conventions already exist**
|
|
219
|
+
```
|
|
220
|
+
Read .agent/skills/discovering-standards/SKILL.md and document the API design standards
|
|
221
|
+
```
|
|
222
|
+
The agent reads your existing routes, middleware, and error handling patterns, then saves `standards/api-design.md` and `standards/error-handling.md`.
|
|
223
|
+
|
|
224
|
+
**Step 2: Brainstorm the payments feature within those constraints**
|
|
225
|
+
```
|
|
226
|
+
Read .agent/skills/brainstorming/SKILL.md and brainstorm a Stripe payments integration with the existing standards loaded
|
|
227
|
+
```
|
|
228
|
+
The agent loads your standards as constraints, explores integration approaches (webhook-first vs. sync, where to put the service layer, etc.), and saves `specs/brainstorm-payments.md`.
|
|
229
|
+
|
|
230
|
+
**Step 3: Shape the spec**
|
|
231
|
+
```
|
|
232
|
+
Read .agent/skills/shaping-specs/SKILL.md and shape a spec using specs/brainstorm-payments.md
|
|
233
|
+
```
|
|
234
|
+
Saves `specs/payments-feature.md` with relevant files mapped out, risks identified, and applicable standards and references.
|
|
235
|
+
|
|
236
|
+
**Step 4: Build**
|
|
237
|
+
```
|
|
238
|
+
Read .agent/skills/deploying-standards/SKILL.md and inject standards and references for implementing a payment service
|
|
239
|
+
```
|
|
240
|
+
Agent loads `api-design.md`, `error-handling.md`, and any references listed in the spec (e.g. payment flow diagram), then executes against the spec.
|
|
241
|
+
|
|
242
|
+
---
|
|
243
|
+
|
|
244
|
+
### Scenario 3 — Quick bug fix
|
|
245
|
+
|
|
246
|
+
A button submits twice on slow connections. Approach is already clear.
|
|
247
|
+
|
|
248
|
+
**Skip brainstorming entirely. Go straight to deployment.**
|
|
249
|
+
|
|
250
|
+
```
|
|
251
|
+
Read .agent/skills/deploying-standards/SKILL.md and inject standards and references — I'm fixing a double-submit bug in the checkout form
|
|
252
|
+
```
|
|
253
|
+
Agent loads `component-patterns.md`, `error-handling.md`, and any relevant references, then fixes the issue without any planning overhead.
|
|
254
|
+
|
|
255
|
+
---
|
|
256
|
+
|
|
257
|
+
### Scenario 4 — Adding a capability your agent doesn't have
|
|
258
|
+
|
|
259
|
+
You want the agent to follow a strict TDD workflow but Blueprint OS has no skill for it.
|
|
260
|
+
|
|
261
|
+
**Step 1: Check skills.sh first**
|
|
262
|
+
```
|
|
263
|
+
npx skills add find-skills
|
|
264
|
+
```
|
|
265
|
+
Then: `Use the find-skills skill to search for a test-driven development skill`
|
|
266
|
+
|
|
267
|
+
Found: `obra/superpowers` has `test-driven-development`.
|
|
268
|
+
|
|
269
|
+
**Step 2: Install it**
|
|
270
|
+
```
|
|
271
|
+
npx skills add obra/superpowers test-driven-development
|
|
272
|
+
```
|
|
273
|
+
Lands in `.agent/skills/test-driven-development/SKILL.md` — immediately available.
|
|
274
|
+
|
|
275
|
+
**Step 3: Use it in your workflow**
|
|
276
|
+
```
|
|
277
|
+
Read .agent/skills/test-driven-development/SKILL.md and implement the payments service using TDD
|
|
278
|
+
```
|
|
279
|
+
|
|
280
|
+
---
|
|
281
|
+
|
|
282
|
+
### Scenario 5 — Resuming work in a new session
|
|
283
|
+
|
|
284
|
+
You shaped a spec yesterday. Today you're back in a fresh chat with no context.
|
|
285
|
+
|
|
286
|
+
```
|
|
287
|
+
Read specs/payments-feature.md — this is what we're building.
|
|
288
|
+
Read .agent/skills/deploying-standards/SKILL.md and inject the relevant standards and references for continuing this work.
|
|
289
|
+
```
|
|
290
|
+
|
|
291
|
+
The spec, standards, and references persist on disk. The agent picks up exactly where you left off, no re-explaining needed.
|
|
292
|
+
|
|
293
|
+
---
|
|
294
|
+
|
|
295
|
+
### Scenario 6 — Before merging a feature
|
|
296
|
+
|
|
297
|
+
Implementation is done. You want tests, a security check, and a final review before merge.
|
|
298
|
+
|
|
299
|
+
**Step 1: Add tests**
|
|
300
|
+
```
|
|
301
|
+
Read .agent/skills/quality-assurance/SKILL.md and add tests for [feature]
|
|
302
|
+
```
|
|
303
|
+
Agent loads the spec, identifies acceptance criteria, adds or updates tests, records evidence.
|
|
304
|
+
|
|
305
|
+
**Step 2: Security audit (if auth, API, or sensitive data)**
|
|
306
|
+
```
|
|
307
|
+
Read .agent/skills/security-audit/SKILL.md and audit [feature] for vulnerabilities
|
|
308
|
+
```
|
|
309
|
+
Agent runs through the security checklist, produces an audit report, blocks merge if Critical or High findings exist.
|
|
310
|
+
|
|
311
|
+
**Step 3: Code review**
|
|
312
|
+
```
|
|
313
|
+
Read .agent/skills/code-review/SKILL.md and review [feature] before merge
|
|
314
|
+
```
|
|
315
|
+
Agent validates scope alignment, confirms SEC was run when required, and confirms readiness for merge.
|
|
316
|
+
|
|
317
|
+
---
|
|
318
|
+
|
|
319
|
+
## Project Structure
|
|
320
|
+
|
|
321
|
+
```
|
|
322
|
+
blueprint-os/
|
|
323
|
+
├── README.md
|
|
324
|
+
├── .agent/
|
|
325
|
+
│ └── skills/
|
|
326
|
+
│ ├── brainstorming/
|
|
327
|
+
│ │ └── SKILL.md
|
|
328
|
+
│ ├── creating-skills/
|
|
329
|
+
│ │ └── SKILL.md
|
|
330
|
+
│ ├── shaping-specs/
|
|
331
|
+
│ │ └── SKILL.md
|
|
332
|
+
│ ├── discovering-standards/
|
|
333
|
+
│ │ └── SKILL.md
|
|
334
|
+
│ ├── deploying-standards/
|
|
335
|
+
│ │ └── SKILL.md
|
|
336
|
+
│ ├── quality-assurance/
|
|
337
|
+
│ │ └── SKILL.md
|
|
338
|
+
│ ├── security-audit/
|
|
339
|
+
│ │ └── SKILL.md
|
|
340
|
+
│ └── code-review/
|
|
341
|
+
│ └── SKILL.md
|
|
342
|
+
├── specs/
|
|
343
|
+
│ └── (brainstorm docs and specs saved here)
|
|
344
|
+
├── standards/
|
|
345
|
+
│ └── README.md
|
|
346
|
+
├── references/
|
|
347
|
+
│ ├── README.md
|
|
348
|
+
│ └── agent-workflow/ # Meta: framework links (agent-os, superpowers, etc.)
|
|
349
|
+
└── adapters/
|
|
350
|
+
├── cursor.md
|
|
351
|
+
├── antigravity.md
|
|
352
|
+
├── claude-code.md
|
|
353
|
+
└── skills-sh.md
|
|
354
|
+
```
|
|
355
|
+
|
|
356
|
+
---
|
|
357
|
+
|
|
358
|
+
## Skill Format
|
|
359
|
+
|
|
360
|
+
Every `SKILL.md` is self-contained and follows this universal structure:
|
|
361
|
+
|
|
362
|
+
```markdown
|
|
363
|
+
---
|
|
364
|
+
name: gerund-skill-name
|
|
365
|
+
description: Third-person description with specific triggers. Max 1024 chars.
|
|
366
|
+
---
|
|
367
|
+
|
|
368
|
+
# Skill Title
|
|
369
|
+
|
|
370
|
+
## When to use this skill
|
|
371
|
+
- Trigger condition 1
|
|
372
|
+
- Trigger condition 2
|
|
373
|
+
|
|
374
|
+
## Workflow
|
|
375
|
+
- [ ] Step 1
|
|
376
|
+
- [ ] Step 2
|
|
377
|
+
|
|
378
|
+
## Instructions
|
|
379
|
+
Specific logic, rules, and code examples.
|
|
380
|
+
|
|
381
|
+
## Resources
|
|
382
|
+
- Links to supporting files
|
|
383
|
+
```
|
|
384
|
+
|
|
385
|
+
This format is compatible with Antigravity natively. For other tools, see the [adapters/](adapters/) folder.
|
|
386
|
+
|
|
387
|
+
---
|
|
388
|
+
|
|
389
|
+
## Standards
|
|
390
|
+
|
|
391
|
+
Standards live in `standards/`. They are plain markdown files documenting the patterns, conventions, and architecture decisions of your specific project. See [standards/README.md](standards/README.md) for the format and conventions.
|
|
392
|
+
|
|
393
|
+
---
|
|
394
|
+
|
|
395
|
+
## References
|
|
396
|
+
|
|
397
|
+
References live in `references/`. Design docs, flowcharts, diagrams, and other reference materials that guide implementation. The shaping-specs and deploying-standards skills load relevant references when planning and executing. See [references/README.md](references/README.md) for the index and conventions.
|
|
398
|
+
|
|
399
|
+
---
|
|
400
|
+
|
|
401
|
+
## Philosophy
|
|
402
|
+
|
|
403
|
+
- **Portable** — plain markdown files, no vendor lock-in
|
|
404
|
+
- **Composable** — skills are independent and combinable
|
|
405
|
+
- **Iterative** — standards evolve with your codebase
|
|
406
|
+
- **AI-first** — written for agents to read and follow, not for humans to memorize
|