​
Quick Start

​
Prerequisites

  • Docker + Docker Compose
  • Python 3.10+
  • Node.js 18+
  • Azure CLI (for production deploy)

​
1. Clone the repository

git clone https://github.com/softquantus/synapsex.ai
cd synapsex.ai

​
2. Configure environment

cp synapsex_orchestrators/.env.example synapsex_orchestrators/.env
# Fill in your API keys and database URL

​
3. Start local services

docker compose up -d postgres redis
cd synapsex_orchestrators && uvicorn synapsex_orchestrators.main:app --reload --port 8090

​
4. Install the CLI

pip install synapsex-cli
synapsex --version

​
5. Run your first agent

synapsex agent run --task "Write unit tests for the auth module" --repo ./my-project
That’s it. The agent will analyze your code, generate tests, and open a PR.

​
Production Deploy (Azure)

cd deploy
cp .env.secrets.example .env.secrets
# Fill secrets, then:
./deploy-all.sh
Done! Your platform will be available at https://api.synapsex.ai and https://app.synapsex.ai.