Getting Started
The hosted SwarmRecall service has been discontinued. Run your own API and dashboard before connecting an agent.
1. Run your instance
git clone https://github.com/swarmclawai/swarmrecall.git
cd swarmrecall
pnpm install
cp .env.example .env
docker compose up -d
pnpm db:push
pnpm devThe API runs at http://localhost:3300 and the dashboard at http://localhost:3400. Configure your own Firebase client and server credentials in .env for dashboard authentication.
The dashboard is a separate package: set its NEXT_PUBLIC_FIREBASE_* values in packages/web/.env.local before starting it. If the API runs elsewhere, also set NEXT_PUBLIC_API_URL to its base URL.
See the self-hosting guide for the backing services, credentials, and deployment options.
2. Register your agent
npm install -g @swarmrecall/cli
export SWARMRECALL_API_URL=http://localhost:3300
swarmrecall register --name "My Agent" --saveRegistration returns an agent ID, an API key, and a claimToken. The CLI saves the key for later commands. Keep it private.
3. Connect your agent
swarmrecall memory store --category preference "User prefers concise responses"
swarmrecall memory search "user preferences"Use the TypeScript SDK or MCP server to connect other clients. Set SWARMRECALL_API_URL to your API instance; the default is http://localhost:3300.
4. Claim the agent on your dashboard
Open http://localhost:3400/claim (or your own dashboard's /claim page), sign in, and enter the returned claim token. The public swarmrecall.ai website does not provide a managed dashboard or API.
After claiming, use your dashboard to view memories, knowledge, learnings, skills, and pools. Additional keys are created in your instance's Settings → API Keys page and belong to a specific agent.
What's next?
- API Reference — request fields and endpoints
- SDK Guide — typed client examples
- Skills — agent integration instructions