sinapse-ai 6.0.4 β 7.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/.claude/CLAUDE.md +10 -10
- package/.sinapse-ai/constitution.md +2 -2
- package/.sinapse-ai/data/entity-registry.yaml +831 -894
- package/.sinapse-ai/data/registry-update-log.jsonl +195 -0
- package/.sinapse-ai/data/sinapse-kb.md +6 -6
- package/.sinapse-ai/data/tech-presets/_template.md +2 -2
- package/.sinapse-ai/data/tech-presets/csharp.md +2 -2
- package/.sinapse-ai/data/tech-presets/go.md +2 -2
- package/.sinapse-ai/data/tech-presets/java.md +2 -2
- package/.sinapse-ai/data/tech-presets/nextjs-react.md +2 -2
- package/.sinapse-ai/data/tech-presets/php.md +2 -2
- package/.sinapse-ai/data/tech-presets/rust.md +2 -2
- package/.sinapse-ai/data/technical-preferences.md +1 -1
- package/.sinapse-ai/development/agents/analyst.md +3 -3
- package/.sinapse-ai/development/agents/architect/MEMORY.md +1 -1
- package/.sinapse-ai/development/agents/architect.md +2 -2
- package/.sinapse-ai/development/agents/developer.md +2 -2
- package/.sinapse-ai/development/agents/devops.md +2 -2
- package/.sinapse-ai/development/agents/product-lead.md +2 -2
- package/.sinapse-ai/development/agents/project-lead.md +3 -3
- package/.sinapse-ai/development/agents/quality-gate.md +3 -3
- package/.sinapse-ai/development/agents/sinapse-orqx.md +6 -6
- package/.sinapse-ai/development/agents/sprint-lead.md +2 -2
- package/.sinapse-ai/development/agents/squad-creator.md +2 -2
- package/.sinapse-ai/development/agents/ux-design-expert.md +1 -1
- package/.sinapse-ai/development/data/decision-heuristics-framework.md +5 -5
- package/.sinapse-ai/development/tasks/apply-qa-fixes.md +1 -1
- package/.sinapse-ai/development/tasks/brownfield-create-epic.md +3 -3
- package/.sinapse-ai/development/tasks/brownfield-create-story.md +1 -1
- package/.sinapse-ai/development/tasks/build-autonomous.md +2 -2
- package/.sinapse-ai/development/tasks/build-resume.md +1 -1
- package/.sinapse-ai/development/tasks/build-status.md +1 -1
- package/.sinapse-ai/development/tasks/build.md +1 -1
- package/.sinapse-ai/development/tasks/create-agent.md +2 -2
- package/.sinapse-ai/development/tasks/create-brownfield-story.md +4 -4
- package/.sinapse-ai/development/tasks/create-deep-research-prompt.md +1 -1
- package/.sinapse-ai/development/tasks/create-next-story.md +5 -5
- package/.sinapse-ai/development/tasks/create-suite.md +1 -1
- package/.sinapse-ai/development/tasks/dev-backlog-debt.md +2 -2
- package/.sinapse-ai/development/tasks/dev-develop-story.md +1 -1
- package/.sinapse-ai/development/tasks/execute-checklist.md +1 -1
- package/.sinapse-ai/development/tasks/execute-epic-plan.md +7 -7
- package/.sinapse-ai/development/tasks/github-devops-github-pr-automation.md +1 -1
- package/.sinapse-ai/development/tasks/gotcha.md +1 -1
- package/.sinapse-ai/development/tasks/gotchas.md +1 -1
- package/.sinapse-ai/development/tasks/next.md +2 -2
- package/.sinapse-ai/development/tasks/plan-execute-subtask.md +1 -1
- package/.sinapse-ai/development/tasks/po-backlog-add.md +2 -2
- package/.sinapse-ai/development/tasks/po-close-story.md +3 -3
- package/.sinapse-ai/development/tasks/po-stories-index.md +1 -1
- package/.sinapse-ai/development/tasks/project-status.md +1 -1
- package/.sinapse-ai/development/tasks/qa-after-creation.md +1 -1
- package/.sinapse-ai/development/tasks/qa-backlog-add-followup.md +3 -3
- package/.sinapse-ai/development/tasks/qa-create-fix-request.md +4 -4
- package/.sinapse-ai/development/tasks/qa-fix-issues.md +6 -6
- package/.sinapse-ai/development/tasks/qa-review-build.md +1 -1
- package/.sinapse-ai/development/tasks/qa-review-story.md +1 -1
- package/.sinapse-ai/development/tasks/qa-run-tests.md +1 -1
- package/.sinapse-ai/development/tasks/release-management.md +1 -1
- package/.sinapse-ai/development/tasks/run-workflow-engine.md +1 -1
- package/.sinapse-ai/development/tasks/spec-critique.md +1 -1
- package/.sinapse-ai/development/tasks/spec-gather-requirements.md +1 -1
- package/.sinapse-ai/development/tasks/spec-write-spec.md +2 -2
- package/.sinapse-ai/development/tasks/validate-next-story.md +4 -4
- package/.sinapse-ai/development/tasks/verify-subtask.md +1 -1
- package/.sinapse-ai/development/tasks/waves.md +1 -1
- package/.sinapse-ai/development/templates/code-intel-integration-pattern.md +1 -1
- package/.sinapse-ai/development/templates/subagent-step-prompt.md +1 -1
- package/.sinapse-ai/docs/standards/AGENT-PERSONALIZATION-STANDARD-V1.md +1 -2
- package/.sinapse-ai/docs/standards/SINAPSE-LIVRO-DE-OURO-V2.2-SUMMARY.md +3 -3
- package/.sinapse-ai/install-manifest.yaml +144 -144
- package/.sinapse-ai/product/checklists/story-draft-checklist.md +2 -2
- package/.sinapse-ai/product/templates/ide-rules/claude-rules.md +5 -5
- package/.sinapse-ai/product/templates/ide-rules/codex-rules.md +5 -5
- package/.sinapse-ai/product/templates/personalized-task-template-v2.md +1 -1
- package/.sinapse-ai/user-guide.md +19 -19
- package/.sinapse-ai/working-in-the-brownfield.md +6 -6
- package/README.en.md +182 -627
- package/README.md +181 -639
- package/docs/ORQX-PLAN.md +23 -17
- package/docs/SQUAD-COMMANDS-REFERENCE.md +206 -0
- package/docs/examples/squads/tool-overrides-example.yaml +55 -0
- package/docs/guides/IDS-CONCEITOS-EXPLICADOS.md +2 -2
- package/docs/guides/MEMORY-INTELLIGENCE-SYSTEM.md +2 -2
- package/docs/guides/template-engine-v2.md +2 -2
- package/docs/pt/guides/template-engine-v2.md +2 -2
- package/package.json +1 -1
- package/squads/squad-claude/agents/db-sage.md +152 -0
- package/squads/squad-claude/agents/tools-orqx.md +219 -0
- package/squads/squad-cloning/agents/content-capturer.md +2 -2
- package/squads/squad-cloning/agents/sop-extractor.md +61 -0
- package/squads/squad-cloning/knowledge-base/pipeline-session-planning.md +2 -2
- package/squads/squad-cloning/knowledge-base/source-classification.md +3 -3
- package/squads/squad-commercial/agents/legal-chief.md +199 -0
- package/squads/squad-copy/agents/copy-chief.md +162 -0
- package/squads/squad-cybersecurity/agents/cyber-chief.md +169 -0
- package/squads/squad-design/agents/brad-frost.md +46 -0
- package/squads/squad-design/agents/dan-mall.md +43 -0
- package/squads/squad-design/agents/dave-malouf.md +43 -0
- package/squads/squad-design/agents/design-chief.md +226 -0
- package/squads/squad-design/agents/design-system.md +210 -0
- package/squads/squad-design/agents/nano-banana-generator.md +42 -0
- package/squads/squad-design/agents/ux-designer.md +124 -0
- package/squads/squad-paidmedia/agents/traffic-masters-chief.md +211 -0
- package/squads/squad-research/agents/data-chief.md +198 -0
- package/squads/squad-storytelling/agents/story-chief.md +180 -0
package/README.en.md
CHANGED
|
@@ -1,733 +1,288 @@
|
|
|
1
|
-
|
|
1
|
+
# SINAPSE AI
|
|
2
2
|
|
|
3
|
-
>
|
|
3
|
+
> **English** | [Portugues](README.md)
|
|
4
4
|
|
|
5
|
-
[](https://github.com/SinapseAI/sinapse-ai/actions/workflows/ci.yml)
|
|
9
|
-
[](https://codecov.io/gh/SinapseAI/sinapse-ai)
|
|
10
|
-
[](https://sinapsesquad.ai)
|
|
5
|
+
[](https://www.npmjs.com/package/sinapse-ai)
|
|
6
|
+
[](LICENSE)
|
|
7
|
+
[](https://nodejs.org/)
|
|
11
8
|
[](LICENSE)
|
|
12
|
-
[](CONTRIBUTING.md)
|
|
13
|
-
[](CODE_OF_CONDUCT.md)
|
|
14
9
|
|
|
15
|
-
> **
|
|
10
|
+
> **151 AI agents. 19 specialized squads. One CLI.**
|
|
11
|
+
>
|
|
12
|
+
> SINAPSE AI is an open source framework that organizes AI agents into specialized squads to solve real problems in business, marketing, development, copywriting, design and more. Works directly in your terminal with Claude Code, Codex CLI or any compatible IDE.
|
|
16
13
|
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
If this is your first time with SINAPSE, follow this linear path:
|
|
20
|
-
|
|
21
|
-
1. Install in a new or existing project:
|
|
22
|
-
```bash
|
|
23
|
-
# new project
|
|
24
|
-
npx sinapse-ai init my-project
|
|
25
|
-
|
|
26
|
-
# existing project
|
|
27
|
-
cd your-project
|
|
28
|
-
npx sinapse-ai install
|
|
29
|
-
```
|
|
30
|
-
2. Choose your IDE/CLI and the activation path:
|
|
31
|
-
- Claude Code: `/agent-name`
|
|
32
|
-
- Gemini CLI: `/sinapse-menu` β `/sinapse-<agent>`
|
|
33
|
-
- Codex CLI: `/skills` β `sinapse-<agent-id>`
|
|
34
|
-
- Cursor/Copilot/AntiGravity: follow the limits and workarounds in `docs/ide-integration.md`
|
|
35
|
-
3. Activate 1 agent and confirm the greeting.
|
|
36
|
-
4. Run 1 initial command (`*help` or equivalent) to validate first-value.
|
|
37
|
-
|
|
38
|
-
First-value definition (binary): agent activation + valid greeting + initial command with useful output in <= 10 minutes.
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
## IDE Hook Compatibility (SINAPSE 4.2 Reality)
|
|
42
|
-
|
|
43
|
-
Many advanced SINAPSE features depend on lifecycle events (hooks). The table below shows the actual parity between IDEs/platforms:
|
|
14
|
+
---
|
|
44
15
|
|
|
45
|
-
|
|
46
|
-
| --- | --- | --- |
|
|
47
|
-
| Claude Code | Complete (reference) | Maximum context automation, guardrails, and auditing |
|
|
48
|
-
| Gemini CLI | High (native events) | Strong coverage of pre/post tool and session automations |
|
|
49
|
-
| Codex CLI | Partial/limited | Some automations depend on `AGENTS.md`, `/skills`, MCP, and operational flow |
|
|
50
|
-
| Cursor | No equivalent lifecycle hooks | Less pre/post tool automation; focus on rules, MCP, and agent flow |
|
|
51
|
-
| GitHub Copilot | No equivalent lifecycle hooks | Less session/tooling automation; focus on repository instructions + MCP in VS Code |
|
|
52
|
-
| AntiGravity | Workflow-based (not hook-based) | Integration via workflows, not via hook events equivalent to Claude |
|
|
16
|
+
## What is SINAPSE AI
|
|
53
17
|
|
|
54
|
-
|
|
18
|
+
SINAPSE AI is not another chatbot. It is an orchestration system where each agent has a clear role, each squad masters a discipline, and everything runs via CLI.
|
|
55
19
|
|
|
56
|
-
|
|
20
|
+
**What you get when you install:**
|
|
57
21
|
|
|
58
|
-
|
|
22
|
+
- **19 orchestrators (orqx)** ready to activate from the terminal
|
|
23
|
+
- **151 specialized agents** with their own knowledge bases
|
|
24
|
+
- **Complete workflows** for planning, development, QA and deploy
|
|
25
|
+
- **Story-Driven Development** with automatic progress tracking
|
|
26
|
+
- **Multi-IDE support**: Claude Code, Codex CLI, Cursor, Gemini CLI
|
|
59
27
|
|
|
60
|
-
|
|
28
|
+
### Architecture: CLI First
|
|
61
29
|
|
|
62
|
-
```
|
|
63
|
-
CLI First
|
|
30
|
+
```
|
|
31
|
+
CLI First > Observability Second > UI Third
|
|
64
32
|
```
|
|
65
33
|
|
|
66
|
-
|
|
67
|
-
| ----------------- | --------- | ------------------------------------------------------------------------------ | -------------------------------------------- |
|
|
68
|
-
| **CLI** | Highest | Where the intelligence lives. All execution, decisions, and automation happen here. | Agents (`@dev`, `@qa`), workflows, commands |
|
|
69
|
-
| **Observability** | Secondary | Observe and monitor what happens in the CLI in real time. | SSE Dashboard, logs, metrics, timeline |
|
|
70
|
-
| **UI** | Tertiary | Ad-hoc management and visualizations when needed. | Kanban, settings, story management |
|
|
71
|
-
|
|
72
|
-
**Derived principles:**
|
|
73
|
-
|
|
74
|
-
- The CLI is the source of truth - dashboards only observe
|
|
75
|
-
- New features must work 100% via CLI before having a UI
|
|
76
|
-
- The UI should never be a requirement for system operation
|
|
77
|
-
- Observability serves to understand what the CLI is doing, not to control it
|
|
34
|
+
All intelligence lives in the CLI. Dashboards observe. The UI is never a requirement.
|
|
78
35
|
|
|
79
36
|
---
|
|
80
37
|
|
|
81
|
-
|
|
82
|
-
|
|
83
|
-
**1. Agentic Planning:** Dedicated agents (analyst, pm, architect) collaborate with you to create detailed, consistent PRD and Architecture documents. Through advanced prompt engineering and human-in-the-loop refinement, these planning agents produce comprehensive specifications that go far beyond generic AI task generation.
|
|
84
|
-
|
|
85
|
-
**2. Engineering-Contextualized Development:** The sm (Scrum Master) agent then transforms these detailed plans into hyper-detailed development stories that contain everything the dev agent needs - complete context, implementation details, and architectural guidance embedded directly in the story files.
|
|
86
|
-
|
|
87
|
-
This two-phase approach eliminates both **planning inconsistency** and **context loss** - the biggest problems in AI-assisted development. Your dev agent opens a story file with full understanding of what to build, how to build it, and why.
|
|
88
|
-
|
|
89
|
-
**π [See the complete workflow in the User Guide](docs/guides/user-guide.md)** - Planning phase, development cycle, and all agent roles
|
|
90
|
-
|
|
91
|
-
## Prerequisites
|
|
92
|
-
|
|
93
|
-
- Node.js >=18.0.0 (v20+ recommended)
|
|
94
|
-
- npm >=9.0.0
|
|
95
|
-
- GitHub CLI (optional, required for team collaboration)
|
|
96
|
-
|
|
97
|
-
> **Installation issues?** See the [Troubleshooting Guide](docs/guides/installation-troubleshooting.md)
|
|
38
|
+
## Installation (2 minutes)
|
|
98
39
|
|
|
99
|
-
|
|
100
|
-
|
|
101
|
-
-
|
|
102
|
-
- π [Windows Installation Guide](docs/installation/windows.md)
|
|
103
|
-
- π [Linux Installation Guide](docs/installation/linux.md)
|
|
104
|
-
|
|
105
|
-
**Multilingual documentation available:** [PortuguΓͺs](docs/pt/installation/) | [EspaΓ±ol](docs/es/installation/)
|
|
106
|
-
|
|
107
|
-
## Quick Navigation
|
|
108
|
-
|
|
109
|
-
### Understanding the SINAPSE Workflow
|
|
110
|
-
|
|
111
|
-
**Before diving in, review these critical workflow diagrams that explain how SINAPSE works:**
|
|
112
|
-
|
|
113
|
-
1. **[Planning Workflow (Web Interface)](docs/guides/user-guide.md#the-planning-workflow-web-ui)** - How to create PRD and Architecture documents
|
|
114
|
-
2. **[Core Development Cycle (IDE)](docs/guides/user-guide.md#the-core-development-cycle-ide)** - How the sm, dev, and qa agents collaborate through story files
|
|
115
|
-
|
|
116
|
-
> β οΈ **These diagrams explain 90% of the confusion about the SINAPSE Agentic Agile workflow** - Understanding PRD+Architecture creation and the sm/dev/qa workflow and how agents pass notes through story files is essential - and it also explains why this is NOT taskmaster or just a simple task runner!
|
|
117
|
-
|
|
118
|
-
### What would you like to do?
|
|
119
|
-
|
|
120
|
-
- **[Install and Build software with a Full Stack AI Agile Team](#quick-start)** β Quick Start Instructions
|
|
121
|
-
- **[Learn how to use SINAPSE](docs/guides/user-guide.md)** β Complete user guide and walkthrough
|
|
122
|
-
- **[See available AI agents](#available-agents)** β Specialized roles for your team
|
|
123
|
-
- **[Explore non-technical uses](#-beyond-software-development---squads)** β Creative writing, business, wellness, education
|
|
124
|
-
- **[Create my own AI agents](#creating-your-own-squad)** β Build agents for your domain
|
|
125
|
-
- **[Browse ready-made Squads](docs/guides/squads-overview.md)** β See how to create and use AI agent teams
|
|
126
|
-
- **[Understand the architecture](docs/architecture/ARCHITECTURE-INDEX.md)** β Deep technical dive
|
|
127
|
-
- **[Report issues](https://github.com/SinapseAI/sinapse-ai/issues)** β Bug reports and feature requests
|
|
128
|
-
|
|
129
|
-
## Important: Keep Your SINAPSE Installation Updated
|
|
40
|
+
```bash
|
|
41
|
+
# New project
|
|
42
|
+
npx sinapse-ai init my-project
|
|
130
43
|
|
|
131
|
-
|
|
44
|
+
# Existing project
|
|
45
|
+
cd your-project && npx sinapse-ai install
|
|
132
46
|
|
|
133
|
-
|
|
47
|
+
# Update existing installation
|
|
134
48
|
npx sinapse-ai@latest install
|
|
135
49
|
```
|
|
136
50
|
|
|
137
|
-
|
|
138
|
-
|
|
139
|
-
- β
Automatically detect your existing installation
|
|
140
|
-
- β
Update only the files that have changed
|
|
141
|
-
- β
Create `.bak` backup files for any custom modifications
|
|
142
|
-
- β
Preserve your project-specific settings
|
|
143
|
-
|
|
144
|
-
This makes it easy to benefit from the latest improvements, bug fixes, and new agents without losing your customizations!
|
|
145
|
-
|
|
146
|
-
## Quick Start
|
|
147
|
-
|
|
148
|
-
### π Installation via NPX (Recommended)
|
|
149
|
-
|
|
150
|
-
**Install SINAPSE with a single command:**
|
|
51
|
+
The wizard detects your environment, configures your IDE and installs squads automatically.
|
|
151
52
|
|
|
152
53
|
```bash
|
|
153
|
-
#
|
|
154
|
-
npx sinapse-ai
|
|
54
|
+
# Diagnostics
|
|
55
|
+
npx sinapse-ai doctor
|
|
155
56
|
|
|
156
|
-
#
|
|
157
|
-
|
|
158
|
-
npx sinapse-ai install
|
|
159
|
-
|
|
160
|
-
# Or use a specific version
|
|
161
|
-
npx sinapse-ai@latest init my-project
|
|
57
|
+
# System info
|
|
58
|
+
npx sinapse-ai info
|
|
162
59
|
```
|
|
163
60
|
|
|
164
|
-
|
|
165
|
-
|
|
166
|
-
SINAPSE now includes a cutting-edge interactive installation experience, inspired by modern tools like Vite and Next.js:
|
|
61
|
+
**Requirements:** Node.js 18+ (v20+ recommended)
|
|
167
62
|
|
|
168
|
-
|
|
169
|
-
|
|
170
|
-
- π¨ **Modern Interface**: Colorful and visual prompts with @clack/prompts
|
|
171
|
-
- β
**Real-Time Validation**: Instant feedback on invalid inputs
|
|
172
|
-
- π **Progress Indicators**: Spinners for long operations (file copying, dependency installation)
|
|
173
|
-
- π¦ **Multi-Component Selection**: Choose which components to install with an intuitive interface
|
|
174
|
-
- βοΈ **Package Manager Choice**: Select between npm, yarn, or pnpm
|
|
175
|
-
- β¨οΈ **Cancellation Support**: Ctrl+C or ESC to exit gracefully at any time
|
|
176
|
-
- π **Installation Summary**: View all settings before proceeding
|
|
177
|
-
- β±οΈ **Duration Tracking**: See how long the installation took
|
|
63
|
+
---
|
|
178
64
|
|
|
179
|
-
|
|
65
|
+
## Available Squads
|
|
180
66
|
|
|
181
|
-
|
|
182
|
-
|
|
183
|
-
|
|
184
|
-
|
|
185
|
-
-
|
|
186
|
-
-
|
|
187
|
-
-
|
|
188
|
-
|
|
67
|
+
Each squad is a team of specialized agents with its own knowledge base, workflows and tasks. All squads are **free and open source**.
|
|
68
|
+
|
|
69
|
+
| Squad | Focus | Agents |
|
|
70
|
+
|-------|-------|--------|
|
|
71
|
+
| **squad-brand** | Brand strategy, archetypes, auditing | 15 |
|
|
72
|
+
| **squad-copy** | Persuasive copywriting, headlines, conversion | 13 |
|
|
73
|
+
| **squad-council** | Strategic advisors (Munger, Dalio, Thiel) | 11 |
|
|
74
|
+
| **squad-storytelling** | Narrative, scripts, story frameworks | 10 |
|
|
75
|
+
| **squad-commercial** | Sales, funnel, revenue, pipeline | 10 |
|
|
76
|
+
| **squad-animations** | Motion design, CSS, particles, 3D | 9 |
|
|
77
|
+
| **squad-paidmedia** | Meta Ads, Google Ads, campaigns, optimization | 9 |
|
|
78
|
+
| **squad-claude** | Claude Code, MCP, advanced integration | 8 |
|
|
79
|
+
| **squad-cloning** | Cognitive cloning, mind synthesis | 8 |
|
|
80
|
+
| **squad-courses** | Courses, curriculum, assessments, launch | 8 |
|
|
81
|
+
| **squad-cybersecurity** | Security, threat intel, pentest | 8 |
|
|
82
|
+
| **squad-design** | Design systems, components, tokens | 8 |
|
|
83
|
+
| **squad-content** | Editorial governance, content strategy | 7 |
|
|
84
|
+
| **squad-product** | Product discovery, strategy, operations | 7 |
|
|
85
|
+
| **squad-research** | Market analysis, competitive intelligence | 7 |
|
|
86
|
+
| **squad-growth** | Analytics, CRO, SEO, growth hacking | 7 |
|
|
87
|
+
| **squad-finance** | Budget, pricing, profitability analysis | 5 |
|
|
88
|
+
| **claude-code-mastery** | Advanced Claude Code mastery | 8 |
|
|
89
|
+
|
|
90
|
+
**Total: 19 squads, 151+ specialized agents**
|
|
189
91
|
|
|
190
|
-
|
|
92
|
+
---
|
|
191
93
|
|
|
192
|
-
|
|
94
|
+
## How to Use
|
|
193
95
|
|
|
194
|
-
###
|
|
96
|
+
### In Claude Code
|
|
195
97
|
|
|
196
|
-
|
|
98
|
+
Activate any orchestrator by name:
|
|
197
99
|
|
|
198
|
-
```bash
|
|
199
|
-
npx sinapse-ai@latest install
|
|
200
|
-
# The installer will detect your existing installation and update it
|
|
201
100
|
```
|
|
202
|
-
|
|
203
|
-
|
|
204
|
-
|
|
205
|
-
|
|
206
|
-
|
|
207
|
-
#### For Cursor:
|
|
208
|
-
|
|
209
|
-
1. Open Cursor settings
|
|
210
|
-
2. Navigate to **User Rules**
|
|
211
|
-
3. Copy the contents of `.cursor/global-rules.md`
|
|
212
|
-
4. Paste in the rules section and save
|
|
213
|
-
|
|
214
|
-
#### For Claude Code:
|
|
215
|
-
|
|
216
|
-
- β
Already configured! The `.claude/CLAUDE.md` file is loaded automatically
|
|
217
|
-
- Dedicated agent sync: `npm run sync:ide:claude`
|
|
218
|
-
- Dedicated validation: `npm run validate:claude-sync && npm run validate:claude-integration`
|
|
219
|
-
|
|
220
|
-
#### For Codex CLI:
|
|
221
|
-
|
|
222
|
-
- β
First-class integration in SINAPSE 4.2 (shared activation and greeting pipeline)
|
|
223
|
-
- β
Already configured! The `AGENTS.md` file at the root is loaded automatically
|
|
224
|
-
- Optional: sync auxiliary agents with `npm run sync:ide:codex`
|
|
225
|
-
- Recommended in this repository: generate and version local skills with `npm run sync:skills:codex`
|
|
226
|
-
- Use `npm run sync:skills:codex:global` only outside this project (to avoid duplication in `/skills`)
|
|
227
|
-
- Dedicated validation: `npm run validate:codex-sync && npm run validate:codex-integration`
|
|
228
|
-
- Skills/paths guardrails: `npm run validate:codex-skills && npm run validate:paths`
|
|
229
|
-
|
|
230
|
-
#### For Gemini CLI:
|
|
231
|
-
|
|
232
|
-
- β
Rules and agents syncable with `npm run sync:ide:gemini`
|
|
233
|
-
- Generated files in `.gemini/rules.md`, `.gemini/rules/SINAPSE/agents/`, and `.gemini/commands/*.toml`
|
|
234
|
-
- β
Local hooks and settings in the installation flow (`.gemini/hooks/` + `.gemini/settings.json`)
|
|
235
|
-
- β
Quick activation via slash commands (`/sinapse-menu`, `/sinapse-dev`, `/sinapse-architect`, etc.)
|
|
236
|
-
- Dedicated validation: `npm run validate:gemini-sync && npm run validate:gemini-integration`
|
|
237
|
-
- Multi-IDE parity in one command: `npm run validate:parity`
|
|
238
|
-
|
|
239
|
-
These rules provide:
|
|
240
|
-
|
|
241
|
-
- π€ Agent command recognition and integration
|
|
242
|
-
- π Story-driven development workflow
|
|
243
|
-
- β
Automatic checkbox tracking
|
|
244
|
-
- π§ͺ Testing and validation patterns
|
|
245
|
-
- π SINAPSE-specific code patterns
|
|
246
|
-
|
|
247
|
-
### Fastest Start with Web Interface (2 minutes)
|
|
248
|
-
|
|
249
|
-
1. **Install SINAPSE**: Run `npx sinapse-ai init my-project`
|
|
250
|
-
2. **Configure your IDE**: Follow the setup instructions for Codex CLI, Cursor, or Claude Code
|
|
251
|
-
3. **Start Planning**: Activate an agent like `@analyst` to begin creating your briefing
|
|
252
|
-
4. **Use SINAPSE commands**: Type `*help` to see available commands
|
|
253
|
-
5. **Follow the flow**: See the [User Guide](docs/guides/user-guide.md) for more details
|
|
254
|
-
|
|
255
|
-
### CLI Command Reference
|
|
256
|
-
|
|
257
|
-
SINAPSE offers a modern, cross-platform CLI with intuitive commands:
|
|
258
|
-
|
|
259
|
-
```bash
|
|
260
|
-
# Project Management (with interactive wizard)
|
|
261
|
-
npx sinapse-ai init <project-name> [options]
|
|
262
|
-
--force Force creation in non-empty directory
|
|
263
|
-
--skip-install Skip npm dependency installation
|
|
264
|
-
--template <name> Use specific template (default, minimal, enterprise)
|
|
265
|
-
|
|
266
|
-
# Installation and Configuration (with modern prompts)
|
|
267
|
-
npx sinapse-ai install [options]
|
|
268
|
-
--force Overwrite existing configuration
|
|
269
|
-
--quiet Minimal output during installation
|
|
270
|
-
--dry-run Simulate installation without modifying files
|
|
271
|
-
|
|
272
|
-
# System Commands
|
|
273
|
-
npx sinapse-ai --version Display installed version
|
|
274
|
-
npx sinapse-ai --help Display detailed help
|
|
275
|
-
npx sinapse-ai info Display system information
|
|
276
|
-
npx sinapse-ai doctor Run system diagnostics
|
|
277
|
-
npx sinapse-ai doctor --fix Automatically fix detected issues
|
|
278
|
-
|
|
279
|
-
# Maintenance
|
|
280
|
-
npx sinapse-ai update Update to latest version
|
|
281
|
-
npx sinapse-ai uninstall Remove SINAPSE
|
|
101
|
+
/sinapse # Main orchestrator
|
|
102
|
+
@brand-orqx # Brand squad
|
|
103
|
+
@copy-orqx # Copy squad
|
|
104
|
+
@research-orqx # Research squad
|
|
282
105
|
```
|
|
283
106
|
|
|
284
|
-
|
|
285
|
-
|
|
286
|
-
- β
**Comprehensive Help System**: `--help` on any command shows detailed documentation
|
|
287
|
-
- β
**Input Validation**: Immediate feedback on invalid parameters
|
|
288
|
-
- β
**Colored Messages**: Errors in red, successes in green, warnings in yellow
|
|
289
|
-
- β
**Cross-Platform**: Works seamlessly on Windows, macOS, and Linux
|
|
290
|
-
- β
**Dry-Run Support**: Test installations without modifying files
|
|
291
|
-
|
|
292
|
-
### π‘ Usage Examples
|
|
107
|
+
Or use the development agents:
|
|
293
108
|
|
|
294
|
-
#### Full Interactive Installation
|
|
295
|
-
|
|
296
|
-
```bash
|
|
297
|
-
$ npx sinapse-ai install
|
|
298
|
-
|
|
299
|
-
π SINAPSE Installation
|
|
300
|
-
|
|
301
|
-
β What is your project name?
|
|
302
|
-
β my-awesome-project
|
|
303
|
-
β
|
|
304
|
-
β Which directory should we use?
|
|
305
|
-
β ./my-awesome-project
|
|
306
|
-
β
|
|
307
|
-
β Choose components to install:
|
|
308
|
-
β β Core Framework (Required)
|
|
309
|
-
β β Agent System (Required)
|
|
310
|
-
β β Squads (optional)
|
|
311
|
-
β β Example Projects (optional)
|
|
312
|
-
β
|
|
313
|
-
β Select package manager:
|
|
314
|
-
β β npm
|
|
315
|
-
β β yarn
|
|
316
|
-
β β pnpm
|
|
317
|
-
β
|
|
318
|
-
β Initialize Git repository?
|
|
319
|
-
β Yes
|
|
320
|
-
β
|
|
321
|
-
β Install dependencies?
|
|
322
|
-
β Yes
|
|
323
|
-
β
|
|
324
|
-
βΈ Creating project directory...
|
|
325
|
-
βΈ Copying framework files...
|
|
326
|
-
βΈ Initializing Git repository...
|
|
327
|
-
βΈ Installing dependencies (this may take a minute)...
|
|
328
|
-
βΈ Configuring environment...
|
|
329
|
-
βΈ Running post-installation setup...
|
|
330
|
-
|
|
331
|
-
β Installation completed successfully! (34.2s)
|
|
332
|
-
|
|
333
|
-
Next steps:
|
|
334
|
-
cd my-awesome-project
|
|
335
|
-
sinapse-ai doctor # Verify installation
|
|
336
|
-
sinapse-ai --help # See available commands
|
|
337
109
|
```
|
|
338
|
-
|
|
339
|
-
|
|
340
|
-
|
|
341
|
-
|
|
342
|
-
#
|
|
343
|
-
|
|
344
|
-
|
|
110
|
+
@developer # Code implementation
|
|
111
|
+
@quality-gate # Testing and quality
|
|
112
|
+
@architect # Architecture and design
|
|
113
|
+
@sprint-lead # Story creation
|
|
114
|
+
@product-lead # Story validation
|
|
115
|
+
@project-lead # Product management
|
|
116
|
+
@analyst # Research and analysis
|
|
117
|
+
@data-engineer # Database design
|
|
118
|
+
@devops # CI/CD and git push (exclusive)
|
|
345
119
|
```
|
|
346
120
|
|
|
347
|
-
|
|
121
|
+
### In Codex CLI
|
|
348
122
|
|
|
349
|
-
```bash
|
|
350
|
-
# Test installation without modifying files
|
|
351
|
-
$ npx sinapse-ai install --dry-run
|
|
352
|
-
|
|
353
|
-
[DRY RUN] Would create: ./my-project/
|
|
354
|
-
[DRY RUN] Would copy: .sinapse-ai/ (45 files)
|
|
355
|
-
[DRY RUN] Would initialize: Git repository
|
|
356
|
-
[DRY RUN] Would install: npm dependencies
|
|
357
|
-
β Dry run completed - no files were modified
|
|
358
123
|
```
|
|
359
|
-
|
|
360
|
-
|
|
361
|
-
|
|
362
|
-
```bash
|
|
363
|
-
$ npx sinapse-ai doctor
|
|
364
|
-
|
|
365
|
-
π₯ SINAPSE System Diagnostics
|
|
366
|
-
|
|
367
|
-
β Node.js version: v20.10.0 (meets requirement: >=18.0.0)
|
|
368
|
-
β npm version: 10.2.3
|
|
369
|
-
β Git installed: version 2.43.0
|
|
370
|
-
β GitHub CLI: gh 2.40.1
|
|
371
|
-
β SINAPSE: v4.2.11
|
|
372
|
-
|
|
373
|
-
Configuration:
|
|
374
|
-
β .sinapse-ai/ directory exists
|
|
375
|
-
β Agent files: 11 found
|
|
376
|
-
β Workflow files: 8 found
|
|
377
|
-
β Templates: 15 found
|
|
378
|
-
|
|
379
|
-
Dependencies:
|
|
380
|
-
β @clack/prompts: ^0.7.0
|
|
381
|
-
β commander: ^12.0.0
|
|
382
|
-
β execa: ^9.0.0
|
|
383
|
-
β fs-extra: ^11.0.0
|
|
384
|
-
β picocolors: ^1.0.0
|
|
385
|
-
|
|
386
|
-
β
All checks passed! Your installation is healthy.
|
|
124
|
+
/skills # List all available agents
|
|
125
|
+
sinapse-dev # Activate the developer
|
|
126
|
+
sinapse-architect # Activate the architect
|
|
387
127
|
```
|
|
388
128
|
|
|
389
|
-
|
|
390
|
-
|
|
391
|
-
```bash
|
|
392
|
-
$ npx sinapse-ai --help
|
|
393
|
-
|
|
394
|
-
Usage: sinapse-ai [options] [command]
|
|
395
|
-
|
|
396
|
-
SINAPSE: AI-Orchestrated System for Full Stack Development
|
|
129
|
+
### Agent Commands
|
|
397
130
|
|
|
398
|
-
|
|
399
|
-
-V, --version output the version number
|
|
400
|
-
-h, --help display help for command
|
|
131
|
+
Inside any agent, use `*` for commands:
|
|
401
132
|
|
|
402
|
-
Commands:
|
|
403
|
-
init <project-name> Create new SINAPSE project with interactive wizard
|
|
404
|
-
install [options] Install SINAPSE in current directory
|
|
405
|
-
info Display system information
|
|
406
|
-
doctor [options] Run system diagnostics and health checks
|
|
407
|
-
help [command] display help for command
|
|
408
|
-
|
|
409
|
-
Run 'sinapse-ai <command> --help' for detailed information about each command.
|
|
410
133
|
```
|
|
411
|
-
|
|
412
|
-
|
|
413
|
-
|
|
414
|
-
|
|
415
|
-
|
|
416
|
-
```bash
|
|
417
|
-
# Clone the repository
|
|
418
|
-
git clone https://github.com/SinapseAI/sinapse-ai.git
|
|
419
|
-
cd sinapse-ai
|
|
420
|
-
|
|
421
|
-
# Install dependencies
|
|
422
|
-
npm install
|
|
423
|
-
|
|
424
|
-
# Run the installer
|
|
425
|
-
npm run install:sinapse
|
|
134
|
+
*help # Available commands
|
|
135
|
+
*create-story # Create development story
|
|
136
|
+
*task <name> # Execute specific task
|
|
137
|
+
*exit # Exit the agent
|
|
426
138
|
```
|
|
427
139
|
|
|
428
|
-
|
|
429
|
-
|
|
430
|
-
For team members joining the project:
|
|
431
|
-
|
|
432
|
-
```bash
|
|
433
|
-
# Install SINAPSE in the project
|
|
434
|
-
npx sinapse-ai@latest install
|
|
435
|
-
|
|
436
|
-
# This will:
|
|
437
|
-
# 1. Detect existing installation (if any)
|
|
438
|
-
# 2. Install/update SINAPSE framework
|
|
439
|
-
# 3. Configure agents and workflows
|
|
440
|
-
```
|
|
441
|
-
|
|
442
|
-
## π Beyond Software Development - Squads
|
|
443
|
-
|
|
444
|
-
The SINAPSE natural language framework works in ANY domain. Squads provide specialized AI agents for creative writing, business strategy, health and wellness, education, and more. Additionally, Squads can expand the SINAPSE core with domain-specific functionality that isn't generic for all use cases. [See the Squads Guide](docs/guides/squads-guide.md) and learn to create your own!
|
|
445
|
-
|
|
446
|
-
## Available Agents
|
|
447
|
-
|
|
448
|
-
SINAPSE comes with 12 specialized agents:
|
|
449
|
-
|
|
450
|
-
### Meta Agents
|
|
451
|
-
|
|
452
|
-
- **sinapse-orqx** - Master orchestration agent (includes framework development capabilities)
|
|
453
|
-
- **sinapse-orchestrator** - Workflow orchestrator and team coordination
|
|
454
|
-
|
|
455
|
-
### Planning Agents (Web Interface)
|
|
456
|
-
|
|
457
|
-
- **analyst** - Business analysis specialist and PRD creation
|
|
458
|
-
- **pm** (Product Manager) - Product manager and prioritization
|
|
459
|
-
- **architect** - System architect and technical design
|
|
460
|
-
- **ux-expert** - User experience design and usability
|
|
461
|
-
|
|
462
|
-
### Development Agents (IDE)
|
|
463
|
-
|
|
464
|
-
- **sm** (Scrum Master) - Sprint management and story creation
|
|
465
|
-
- **dev** - Developer and implementation
|
|
466
|
-
- **qa** - Quality assurance and testing
|
|
467
|
-
- **po** (Product Owner) - Backlog and story management
|
|
468
|
-
- **data-engineer** - Database design and data modeling
|
|
469
|
-
- **devops** - CI/CD, infrastructure, and git operations (exclusive push authority)
|
|
470
|
-
|
|
471
|
-
## Documentation and Resources
|
|
472
|
-
|
|
473
|
-
### Essential Guides
|
|
474
|
-
|
|
475
|
-
- π **[User Guide](docs/guides/user-guide.md)** - Complete walkthrough from conception to project completion
|
|
476
|
-
- ποΈ **[Core Architecture](docs/architecture/ARCHITECTURE-INDEX.md)** - Deep technical dive and system design
|
|
477
|
-
- π **[Squads Guide](docs/guides/squads-guide.md)** - Extend SINAPSE to any domain beyond software development
|
|
478
|
-
|
|
479
|
-
### Additional Documentation
|
|
480
|
-
|
|
481
|
-
- π€ **[Squads Guide](docs/guides/squads-guide.md)** - Create and publish AI agent teams
|
|
482
|
-
- π **[Getting Started](docs/getting-started.md)** - Step-by-step tutorial for beginners
|
|
483
|
-
- π§ **[Troubleshooting](docs/troubleshooting.md)** - Solutions for common issues
|
|
484
|
-
- π― **[Guiding Principles](docs/GUIDING-PRINCIPLES.md)** - SINAPSE philosophy and best practices
|
|
485
|
-
- ποΈ **[Architecture Overview](docs/architecture/ARCHITECTURE-INDEX.md)** - Detailed view of system architecture
|
|
486
|
-
- βοΈ **[Performance Tuning Guide](docs/performance-tuning-guide.md)** - Optimize your SINAPSE workflow
|
|
487
|
-
- π **[Security Best Practices](docs/security-best-practices.md)** - Security and data protection
|
|
488
|
-
- π **[Migration Guide](docs/migration-guide.md)** - Migration from previous versions
|
|
489
|
-
- π¦ **[Versioning and Releases](docs/versioning-and-releases.md)** - Versioning policy
|
|
490
|
-
|
|
491
|
-
## π€ SINAPSE Autonomous Development Engine (ADE)
|
|
492
|
-
|
|
493
|
-
SINAPSE introduces the **Autonomous Development Engine (ADE)** - a complete system for autonomous development that transforms requirements into working code.
|
|
140
|
+
---
|
|
494
141
|
|
|
495
|
-
|
|
142
|
+
## Development Agents
|
|
496
143
|
|
|
497
|
-
|
|
144
|
+
SINAPSE comes with 12 core agents for the complete development cycle:
|
|
498
145
|
|
|
499
|
-
|
|
|
500
|
-
|
|
501
|
-
|
|
|
502
|
-
|
|
|
503
|
-
|
|
|
504
|
-
|
|
|
505
|
-
|
|
|
506
|
-
|
|
|
507
|
-
|
|
|
146
|
+
| Agent | Persona | Scope |
|
|
147
|
+
|-------|---------|-------|
|
|
148
|
+
| `sinapse-orqx` | Imperator | Main orchestrator for all squads |
|
|
149
|
+
| `developer` | Dex | Code implementation |
|
|
150
|
+
| `quality-gate` | Quinn | Testing, QA and quality gates |
|
|
151
|
+
| `architect` | Aria | Architecture and technical design |
|
|
152
|
+
| `project-lead` | Morgan | Product management and epics |
|
|
153
|
+
| `product-lead` | Pax | Story validation and backlog |
|
|
154
|
+
| `sprint-lead` | River | Story creation and sprints |
|
|
155
|
+
| `analyst` | Alex | Business research and analysis |
|
|
156
|
+
| `data-engineer` | Dara | Database design and migrations |
|
|
157
|
+
| `ux-design-expert` | Uma | UX/UI design and experience |
|
|
158
|
+
| `devops` | Gage | CI/CD, git push (exclusive) |
|
|
159
|
+
| `squad-creator` | - | New squad creation |
|
|
508
160
|
|
|
509
|
-
###
|
|
161
|
+
### Development Workflow
|
|
510
162
|
|
|
511
|
-
```text
|
|
512
|
-
User Request β Spec Pipeline β Execution Engine β QA Review β Working Code
|
|
513
|
-
β
|
|
514
|
-
Recovery System
|
|
515
|
-
β
|
|
516
|
-
Memory Layer
|
|
517
163
|
```
|
|
518
|
-
|
|
519
|
-
### β‘ Quick Start ADE
|
|
520
|
-
|
|
521
|
-
```bash
|
|
522
|
-
# 1. Create spec from requirement
|
|
523
|
-
@project-lead *gather-requirements
|
|
524
|
-
@architect *assess-complexity
|
|
525
|
-
@analyst *research-deps
|
|
526
|
-
@project-lead *write-spec
|
|
527
|
-
@quality-gate *critique-spec
|
|
528
|
-
|
|
529
|
-
# 2. Execute approved spec
|
|
530
|
-
@architect *create-plan
|
|
531
|
-
@architect *create-context
|
|
532
|
-
@developer *execute-subtask 1.1
|
|
533
|
-
|
|
534
|
-
# 3. QA Review
|
|
535
|
-
@quality-gate *review-build STORY-42
|
|
164
|
+
@sprint-lead creates story > @product-lead validates > @developer implements > @quality-gate tests > @devops pushes
|
|
536
165
|
```
|
|
537
166
|
|
|
538
|
-
|
|
539
|
-
|
|
540
|
-
- **[Complete ADE Guide](docs/guides/ade-guide.md)** - Step-by-step tutorial
|
|
541
|
-
- **[Agent Changes](docs/architecture/ADE-AGENT-CHANGES.md)** - Commands and capabilities per agent
|
|
542
|
-
- **[Epic 1 - Worktree Manager](docs/architecture/ADE-EPIC1-HANDOFF.md)**
|
|
543
|
-
- **[Epic 2 - Migration V2βV3](docs/architecture/ADE-EPIC2-HANDOFF.md)**
|
|
544
|
-
- **[Epic 3 - Spec Pipeline](docs/architecture/ADE-EPIC3-HANDOFF.md)**
|
|
545
|
-
- **[Epic 4 - Execution Engine](docs/architecture/ADE-EPIC4-HANDOFF.md)**
|
|
546
|
-
- **[Epic 5 - Recovery System](docs/architecture/ADE-EPIC5-HANDOFF.md)**
|
|
547
|
-
- **[Epic 6 - QA Evolution](docs/architecture/ADE-EPIC6-HANDOFF.md)**
|
|
548
|
-
- **[Epic 7 - Memory Layer](docs/architecture/ADE-EPIC7-HANDOFF.md)**
|
|
549
|
-
|
|
550
|
-
### π New Commands per Agent
|
|
551
|
-
|
|
552
|
-
**@devops:**
|
|
553
|
-
|
|
554
|
-
- `*create-worktree`, `*list-worktrees`, `*merge-worktree`, `*cleanup-worktrees`
|
|
555
|
-
- `*inventory-assets`, `*analyze-paths`, `*migrate-agent`, `*migrate-batch`
|
|
556
|
-
|
|
557
|
-
**@pm:**
|
|
558
|
-
|
|
559
|
-
- `*gather-requirements`, `*write-spec`
|
|
560
|
-
|
|
561
|
-
**@architect:**
|
|
562
|
-
|
|
563
|
-
- `*assess-complexity`, `*create-plan`, `*create-context`, `*map-codebase`
|
|
564
|
-
|
|
565
|
-
**@analyst:**
|
|
566
|
-
|
|
567
|
-
- `*research-deps`, `*extract-patterns`
|
|
167
|
+
---
|
|
568
168
|
|
|
569
|
-
|
|
169
|
+
## Story-Driven Development
|
|
570
170
|
|
|
571
|
-
|
|
171
|
+
All SINAPSE development follows stories:
|
|
572
172
|
|
|
573
|
-
|
|
173
|
+
1. **Stories in** `docs/stories/` with clear acceptance criteria
|
|
174
|
+
2. **Progress tracked** via checkboxes `[ ]` > `[x]`
|
|
175
|
+
3. **File List** kept updated in the story
|
|
176
|
+
4. **Quality gates** run automatically before merge
|
|
574
177
|
|
|
575
|
-
|
|
178
|
+
---
|
|
576
179
|
|
|
577
180
|
## Creating Your Own Squad
|
|
578
181
|
|
|
579
|
-
|
|
580
|
-
|
|
581
|
-
```text
|
|
582
|
-
squads/your-squad/
|
|
583
|
-
βββ config.yaml # Squad configuration
|
|
584
|
-
βββ agents/ # Specialized agents
|
|
585
|
-
βββ tasks/ # Task workflows
|
|
586
|
-
βββ templates/ # Document templates
|
|
587
|
-
βββ checklists/ # Validation checklists
|
|
588
|
-
βββ data/ # Knowledge base
|
|
589
|
-
βββ README.md # Squad documentation
|
|
590
|
-
βββ user-guide.md # User guide
|
|
591
|
-
```
|
|
592
|
-
|
|
593
|
-
See the [Squads Guide](docs/guides/squads-guide.md) for detailed instructions.
|
|
182
|
+
Anyone can create a squad for any domain:
|
|
594
183
|
|
|
595
|
-
|
|
184
|
+
```
|
|
185
|
+
squads/my-squad/
|
|
186
|
+
squad.yaml # Squad manifest
|
|
187
|
+
agents/ # Specialized agents
|
|
188
|
+
knowledge-base/ # Knowledge base
|
|
189
|
+
tasks/ # Executable tasks
|
|
190
|
+
workflows/ # Squad workflows
|
|
191
|
+
```
|
|
596
192
|
|
|
597
|
-
|
|
193
|
+
Use `@squad-creator` or see the [Squads Guide](docs/guides/squads-guide.md).
|
|
598
194
|
|
|
599
|
-
|
|
195
|
+
---
|
|
600
196
|
|
|
601
|
-
|
|
197
|
+
## IDE Configuration
|
|
602
198
|
|
|
603
|
-
|
|
199
|
+
| IDE | Status | Activation |
|
|
200
|
+
|-----|--------|------------|
|
|
201
|
+
| **Claude Code** | Reference | `@agent-name` or `/sinapse` |
|
|
202
|
+
| **Codex CLI** | First-class | `/skills` > `sinapse-<agent>` |
|
|
203
|
+
| **Gemini CLI** | Supported | `/sinapse-menu` > `/sinapse-<agent>` |
|
|
204
|
+
| **Cursor** | Partial | Rules + MCP |
|
|
205
|
+
| **GitHub Copilot** | Partial | Repository instructions + MCP |
|
|
604
206
|
|
|
605
|
-
|
|
207
|
+
Details: `docs/ide-integration.md`
|
|
606
208
|
|
|
607
|
-
|
|
209
|
+
---
|
|
608
210
|
|
|
609
|
-
|
|
211
|
+
## CLI
|
|
610
212
|
|
|
611
213
|
```bash
|
|
612
|
-
|
|
214
|
+
npx sinapse-ai init <project> # Create project
|
|
215
|
+
npx sinapse-ai install # Install in current project
|
|
216
|
+
npx sinapse-ai update # Update
|
|
217
|
+
npx sinapse-ai doctor # Diagnostics
|
|
218
|
+
npx sinapse-ai doctor --fix # Fix issues
|
|
219
|
+
npx sinapse-ai info # System info
|
|
220
|
+
npx sinapse-ai uninstall # Remove
|
|
613
221
|
```
|
|
614
222
|
|
|
615
|
-
|
|
616
|
-
|
|
617
|
-
- **Advanced Squads** - Specialized squads with expanded capabilities
|
|
618
|
-
- **Memory Layer** - Persistent memory of patterns and insights across sessions
|
|
619
|
-
- **Metrics & Analytics** - Productivity dashboard and development metrics
|
|
620
|
-
- **Enterprise Integrations** - Connectors for Jira, Linear, Notion, and more
|
|
621
|
-
- **Layered Configuration** - L1-L4 configuration system with inheritance
|
|
622
|
-
- **Licensing** - License management via `sinapse pro activate --key <KEY>`
|
|
623
|
-
|
|
624
|
-
For more information, run `npx sinapse-ai pro --help` after installation.
|
|
625
|
-
|
|
626
|
-
## Support
|
|
627
|
-
|
|
628
|
-
- π [Issue Tracker](https://github.com/SinapseAI/sinapse-ai/issues) - Bug reports and feature requests
|
|
629
|
-
- π‘ [Feature Process](docs/FEATURE_PROCESS.md) - How to propose new features
|
|
630
|
-
- π [How to Contribute](CONTRIBUTING.md)
|
|
631
|
-
- πΊοΈ [Roadmap](docs/roadmap.md) - See what we're building
|
|
632
|
-
- π€ [Squads Guide](docs/guides/squads-guide.md) - Create AI agent teams
|
|
633
|
-
|
|
634
|
-
## Git Workflow and Validation
|
|
635
|
-
|
|
636
|
-
SINAPSE implements a multi-layer validation system to ensure code quality and consistency:
|
|
637
|
-
|
|
638
|
-
### π‘οΈ Defense in Depth - 3 Validation Layers
|
|
639
|
-
|
|
640
|
-
**Layer 1: Pre-commit (Local - Fast)**
|
|
641
|
-
|
|
642
|
-
- β
ESLint - Code quality
|
|
643
|
-
- β
TypeScript - Type checking
|
|
644
|
-
- β‘ Performance: <5s
|
|
645
|
-
- πΎ Cache enabled
|
|
646
|
-
|
|
647
|
-
**Layer 2: Pre-push (Local - Story Validation)**
|
|
648
|
-
|
|
649
|
-
- β
Story checkbox validation
|
|
650
|
-
- β
Status consistency
|
|
651
|
-
- β
Required sections
|
|
652
|
-
|
|
653
|
-
**Layer 3: CI/CD (Cloud - Required for merge)**
|
|
654
|
-
|
|
655
|
-
- β
All tests
|
|
656
|
-
- β
Test coverage (80% minimum)
|
|
657
|
-
- β
Complete validations
|
|
658
|
-
- β
GitHub Actions
|
|
659
|
-
|
|
660
|
-
### π Detailed Documentation
|
|
661
|
-
|
|
662
|
-
- π **[Complete Git Workflow Guide](docs/git-workflow-guide.md)** - Detailed workflow guide
|
|
663
|
-
- π **[CONTRIBUTING.md](CONTRIBUTING.md)** - Contribution guide
|
|
223
|
+
---
|
|
664
224
|
|
|
665
|
-
|
|
225
|
+
## Quality and Validation
|
|
666
226
|
|
|
667
227
|
```bash
|
|
668
|
-
# Local validations
|
|
669
228
|
npm run lint # ESLint
|
|
670
229
|
npm run typecheck # TypeScript
|
|
671
|
-
npm test
|
|
672
|
-
npm run test:coverage
|
|
673
|
-
|
|
674
|
-
# SINAPSE Validator
|
|
675
|
-
node .sinapse-ai/utils/sinapse-validator.js pre-commit # Pre-commit validation
|
|
676
|
-
node .sinapse-ai/utils/sinapse-validator.js pre-push # Pre-push validation
|
|
677
|
-
node .sinapse-ai/utils/sinapse-validator.js stories # Validate all stories
|
|
230
|
+
npm test # Tests
|
|
231
|
+
npm run test:coverage # Coverage
|
|
678
232
|
```
|
|
679
233
|
|
|
680
|
-
|
|
234
|
+
Pre-commit and pre-push hooks validate automatically.
|
|
681
235
|
|
|
682
|
-
|
|
236
|
+
---
|
|
683
237
|
|
|
684
|
-
|
|
685
|
-
node scripts/setup-branch-protection.js
|
|
686
|
-
```
|
|
238
|
+
## Documentation
|
|
687
239
|
|
|
688
|
-
|
|
240
|
+
| Resource | Link |
|
|
241
|
+
|----------|------|
|
|
242
|
+
| User Guide | [docs/guides/user-guide.md](docs/guides/user-guide.md) |
|
|
243
|
+
| Architecture | [docs/architecture/](docs/architecture/) |
|
|
244
|
+
| Squads Guide | [docs/guides/squads-guide.md](docs/guides/squads-guide.md) |
|
|
245
|
+
| Getting Started | [docs/getting-started.md](docs/getting-started.md) |
|
|
246
|
+
| Troubleshooting | [docs/troubleshooting.md](docs/troubleshooting.md) |
|
|
247
|
+
| Guiding Principles | [docs/GUIDING-PRINCIPLES.md](docs/GUIDING-PRINCIPLES.md) |
|
|
689
248
|
|
|
690
|
-
|
|
691
|
-
- Admin access to the repository
|
|
249
|
+
---
|
|
692
250
|
|
|
693
251
|
## Contributing
|
|
694
252
|
|
|
695
|
-
|
|
696
|
-
|
|
697
|
-
|
|
253
|
+
```bash
|
|
254
|
+
git clone https://github.com/SinapseAI/sinapse-ai.git
|
|
255
|
+
cd sinapse-ai && npm install
|
|
256
|
+
```
|
|
698
257
|
|
|
699
258
|
1. Fork the repository
|
|
700
|
-
2. Create
|
|
701
|
-
3. Commit
|
|
702
|
-
4. Push
|
|
259
|
+
2. Create your branch (`git checkout -b feat/my-feature`)
|
|
260
|
+
3. Commit (`git commit -m 'feat: description'`)
|
|
261
|
+
4. Push (`git push origin feat/my-feature`)
|
|
703
262
|
5. Open a Pull Request
|
|
704
263
|
|
|
705
|
-
See
|
|
264
|
+
See [CONTRIBUTING.md](CONTRIBUTING.md) for details.
|
|
706
265
|
|
|
707
|
-
|
|
708
|
-
|
|
266
|
+
---
|
|
267
|
+
|
|
268
|
+
## Legal
|
|
709
269
|
|
|
710
|
-
|
|
270
|
+
| Doc | Link |
|
|
271
|
+
|-----|------|
|
|
272
|
+
| License | [MIT](LICENSE) |
|
|
273
|
+
| Privacy | [Privacy](docs/legal/privacy.md) |
|
|
274
|
+
| Terms | [Terms](docs/legal/terms.md) |
|
|
275
|
+
| Conduct | [Code of Conduct](CODE_OF_CONDUCT.md) |
|
|
276
|
+
| Security | [Security](docs/security.md) |
|
|
711
277
|
|
|
712
|
-
|
|
713
|
-
| --------------------- | ------------------------------------------- | ------------------------------------- |
|
|
714
|
-
| **License** | [MIT License](LICENSE) | - |
|
|
715
|
-
| **License Model** | [Core vs Pro](docs/legal/license-clarification.md) | - |
|
|
716
|
-
| **Privacy** | [Privacy Policy](docs/legal/privacy.md) | - |
|
|
717
|
-
| **Terms of Use** | [Terms of Use](docs/legal/terms.md) | - |
|
|
718
|
-
| **Code of Conduct** | [Code of Conduct](CODE_OF_CONDUCT.md) | [PT-BR](docs/pt/code-of-conduct.md) |
|
|
719
|
-
| **Contributing** | [Contributing](CONTRIBUTING.md) | [PT-BR](docs/pt/contributing.md) |
|
|
720
|
-
| **Security** | [Security](docs/security.md) | [PT-BR](docs/pt/security.md) |
|
|
721
|
-
| **Community** | [Community](docs/community.md) | [PT-BR](docs/pt/community.md) |
|
|
722
|
-
| **Roadmap** | [Roadmap](docs/roadmap.md) | [PT-BR](docs/pt/roadmap.md) |
|
|
723
|
-
| **Changelog** | [Version History](CHANGELOG.md) | - |
|
|
278
|
+
---
|
|
724
279
|
|
|
725
280
|
## Contributors
|
|
726
281
|
|
|
727
282
|
[](https://github.com/SinapseAI/sinapse-ai/graphs/contributors)
|
|
728
283
|
|
|
729
|
-
<sub>Built with β€οΈ for the AI-assisted development community</sub>
|
|
730
|
-
|
|
731
284
|
---
|
|
732
285
|
|
|
733
|
-
|
|
286
|
+
Built for builders.
|
|
287
|
+
|
|
288
|
+
**[Back to top](#sinapse-ai)**
|