Skip to main content

Getting Started

Get SynapSync running in your project in under 2 minutes.

Prerequisites​

  • Node.js 20.0.0 or higher
  • npm 10.0.0 or higher
node --version  # Should be v20+

Installation​

npm install -g @synapsync/cli

Verify the installation:

synapsync --version

Initialize Your Project​

Navigate to your project and run:

synapsync init

This creates:

  • synapsync.config.yaml — Project configuration
  • .synapsync/ — Central cognitive storage
  • .synapsync/manifest.json — Installed cognitives tracker

Non-interactive Mode​

synapsync init --yes

Uses defaults: project name from directory, Claude provider enabled.

Install Your First Cognitive​

Browse available cognitives:

synapsync list --remote

Install one:

synapsync add code-reviewer

Your cognitive is automatically synced to your configured providers.

Verify Setup​

Check your project status:

synapsync status
Project Status
──────────────

Initialized:    Yes
Config:         synapsync.config.yaml
Storage:        .synapsync/

Cognitives:     1 installed
  Skills:       1
  Agents:       0
  ...

Providers:
  claude:       enabled (.claude/)

Project Structure​

After setup, your project looks like:

your-project/
├── synapsync.config.yaml    # Configuration
├── .synapsync/
│   ├── manifest.json        # Tracks installed cognitives
│   └── skills/
│       └── general/
│           └── code-reviewer/
│               └── SKILL.md
└── .claude/                  # Provider directory (symlinked)
    └── skills/
        └── code-reviewer/    # → ../.synapsync/skills/general/code-reviewer/

Next Steps​