Brief description of what this project does.
# Install dependencies (if any)
npm install
# Run the project
npm startThis project uses the Ironclad Workflow — a structured 4-phase development process:
PLAN -> EXECUTE -> VERIFY -> SHIP
-
Create a plan:
mkdir -p .workflow/sessions/SESSION-$(date +%Y-%m-%d)-feature-name cp .workflow/templates/plan-template.md .workflow/sessions/SESSION-$(date +%Y-%m-%d)-feature-name/plan.md
-
Get plan approval before writing code
-
Execute the planned tasks
-
Verify with AI code review:
npm run verify
-
Ship when verification passes:
npm run ship:pr
| Command | Description |
|---|---|
npm run verify |
Full verification with AI review |
npm run verify:skip-ai |
Verify without AI review |
npm run ai-review |
Run AI review only |
npm run ai-review:diff |
Review git changes only |
npm run ship |
Validate integrity |
npm run ship:pr |
Validate and create PR |
Copy .env.example to .env and add your Gemini API key:
cp .env.example .env
# Edit .env and add your GEMINI_API_KEY.
├── src/ # Source code
├── scripts/ # Ironclad workflow scripts
├── .workflow/ # Workflow documents
│ ├── templates/ # Plan, session, PR templates
│ ├── checklists/ # Security and verification checklists
│ ├── sessions/ # Active session documents
│ └── state/ # Verification state files
├── .cursor/rules # Cursor IDE workflow enforcement
├── CLAUDE.md # AI assistant context
└── package.json
MIT