​
Prerequisites

  • A terminal (macOS Terminal, iTerm2, Windows Terminal, WSL)
  • Internet connection for installation and API calls
  • An API key for your preferred AI provider (or use SynapseX built-in credentials)

​
Step-by-Step Guide

1

Install the SynapseX CLI

Run the installation script for your platform:
curl -fsSL https://synapsex.ai/install | bash
Verify the installation:
synapsex --version
2

Configure Your Provider and API Key

Run the interactive configuration wizard:
synapsex configure
You will be prompted to select a provider:
? Select your AI provider:
❯ SynapseX (recommended — built-in credentials)
  Claude (Anthropic)
  OpenAI / Codex
  Gemini (Google)
  Goose (Block)
  OpenCode
  Qwen (Alibaba Cloud)
Then enter your API key for the selected provider, or press Enter to use SynapseX built-in credentials (requires a SynapseX account).Finally, select your default model:
? Select default model:
❯ claude-sonnet-4-5 (recommended)
  claude-opus-4
  gpt-4o
  gemini-2.5-pro
  deepseek-r1
3

Start a Session

Launch an interactive chat session in your terminal:
synapsex session
You will enter the SynapseX interactive REPL where you can type queries and receive responses in real time. Use exit or Ctrl+C to end the session.
4

Ask Your First Question

In the interactive session (or directly from the command line), ask a question:
# Interactive session
> what does the main function in this project do?

# Or directly from CLI (single query)
synapsex "explain the purpose of the auth middleware in this project"
SynapseX will read the relevant files in your current directory and respond with a detailed, context-aware answer.
5

Create Your First Project

Navigate to a new directory and ask SynapseX to create a project:
mkdir my-api && cd my-api

synapsex "create a Node.js REST API with TypeScript, Express, and JWT authentication.
Include user registration, login, and profile endpoints. Add error handling middleware."
SynapseX will generate all files, install dependencies, and configure the project for immediate use.
6

Request Code Improvements

Ask SynapseX to improve existing code:
synapsex "add input validation to all API endpoints using Zod schemas"
synapsex "add comprehensive JSDoc comments to all exported functions"
synapsex "optimize the database queries to use connection pooling"
SynapseX will read the current files and apply targeted improvements while preserving your existing logic and structure.
7

Debug an Error

Paste an error or describe a problem:
synapsex "I'm getting 'Cannot read properties of undefined (reading map)' on line 42
of src/routes/users.ts when the database returns an empty result set. Fix it."
SynapseX will locate the error, trace the cause, and apply the fix with an explanation.
8

Explore Advanced Features

Once comfortable with basic usage, try advanced workflows:
# Multi-agent parallel execution
synapsex "/multi-agent build a full-stack app with React frontend and Node.js API"

# Web search augmented queries
synapsex "/search what is the latest stable version of Prisma and update our package.json"

# Background CLI task from VS Code Agent
synapsex /cli run the build and fix any TypeScript errors that appear

​
Essential Commands

CommandDescription
synapsex sessionStart an interactive REPL session
synapsex configureSet up or update provider and API key
synapsex "query"Run a single query in the current directory
synapsex projectManage the current project context
synapsex projectsList all saved project contexts
synapsex run <script>Run a project script with AI assistance
synapsex infoDisplay current configuration and version
synapsex updateUpdate the CLI to the latest version
synapsex /multi-agentSpawn parallel sub-agents for complex tasks
synapsex /searchRun a web-augmented query
synapsex /cliExecute a background CLI task (from VS Code Agent)

​
Provider Configuration Reference

No external API key needed. Uses SynapseX’s managed inference infrastructure: 
synapsex configure --provider synapsex
# Log in with your SynapseX account

​
Anthropic Claude

synapsex configure --provider claude --api-key sk-ant-...

​
OpenAI / Codex

synapsex configure --provider openai --api-key sk-...

​
Google Gemini

synapsex configure --provider gemini --api-key AIza...

​
Multiple Providers

Configure multiple providers and switch between them: 
synapsex configure --add-provider gemini
synapsex session --provider gemini   # use Gemini for this session

​
Next Steps

Key Features

Explore all CLI capabilities

Common Use Cases

Real-world project examples

VS Code Agent

Use SynapseX inside VS Code

API Reference

Integrate SynapseX programmatically