Guides
Step-by-step how-to guides for common CodeSpar tasks including linking repositories, reviewing PRs, deploying, multi-channel setup, and multi-tenant configuration.
Guides
Practical, step-by-step guides for common CodeSpar tasks. Each guide covers prerequisites, configuration, and verification.
Available Guides
Getting Connected
| Guide | Description | Time |
|---|---|---|
| Link a Repository | Connect a GitHub repository to your CodeSpar agent with auto-webhook configuration | 5 min |
| Multi-Channel Setup | Enable multiple messaging channels and link user identities across them | 10 min |
Development Workflow
| Guide | Description | Time |
|---|---|---|
| Review Pull Requests | Set up automated PR review with the Review Agent, including auto-approve configuration | 5 min |
| Deploy Pipeline | Orchestrate deployments with approval flows, cross-channel approval, cascading deploys, and rollback | 10 min |
Administration
| Guide | Description | Time |
|---|---|---|
| Multi-Tenant / Organizations | Set up organizations for multi-tenant deployments with project isolation | 10 min |
Prerequisites
Before following any guide, make sure you have:
- CodeSpar running — via Docker or Railway
- Environment variables set — at minimum
ANTHROPIC_API_KEYandGITHUB_TOKEN(see Configuration) - At least one channel enabled — Slack, Discord, Telegram, or WhatsApp (see Configuration)
Recommended Order
If you are setting up CodeSpar for the first time, follow these guides in order:
- Link a Repository — connect your project
- Multi-Channel Setup — add your team's channels
- Review Pull Requests — automate code review
- Deploy Pipeline — set up deployment orchestration
- Multi-Tenant / Organizations — (if managing multiple projects or teams)
Need Help?
- Command Reference — Full list of all 17 commands
- REST API — Programmatic access to all CodeSpar features
- Configuration — All environment variables
- Security — RBAC, approvals, and audit