Getting Started
Goal: go from zero to a first working chat with minimal setup.
Fastest chat: open the Control UI (no channel setup needed). Run `coderclaw dashboard`
and chat in the browser, or open `http://127.0.0.1:18789/` on the
gateway host.
Docs: [Dashboard](/web/dashboard) and [Control UI](/web/control-ui).
Prereqs
Check your Node version with `node --version` if you are unsure.
Quick setup (CLI)
```bash
curl -fsSL https://coderclaw.ai/install.sh | bash
```
```powershell
iwr -useb https://coderclaw.ai/install.ps1 | iex
```
Other install methods and requirements: [Install](/install).
Built on [CoderClaw](https://github.com/SeanHogg/coderClaw)'s multi-channel gateway with Phase 2 enhancements.
```bash
coderclaw onboard --install-daemon
```
The wizard configures auth, gateway settings, and optional channels.
See [Onboarding Wizard](/start/wizard) for details.
If you installed the service, it should already be running:
```bash
coderclaw gateway status
```
```bash
coderclaw dashboard
```
If the Control UI loads, your Gateway is ready for use.
Optional checks and extras
Useful for quick tests or troubleshooting.
```bash
coderclaw gateway --port 18789
```
Requires a configured channel.
```bash
coderclaw message send --target +15555550123 --message "Hello from CoderClaw"
```
Useful environment variables
If you run CoderClaw as a service account or want custom config/state locations:
CODERCLAW_HOME sets the home directory used for internal path resolution.CODERCLAW_STATE_DIR overrides the state directory.CODERCLAW_CONFIG_PATH overrides the config file path.
Full environment variable reference: Environment vars.
CoderClaw dev workflows (quick start)
Once your Gateway is running, initialize CoderClaw in any project and start running multi-agent workflows.
```bash
cd my-project
coderclaw init
```
This creates a `.coderClaw/` directory with persistent project context:
```
.coderClaw/
├── context.yaml # project metadata (languages, frameworks, dependencies)
├── architecture.md # design docs
├── rules.yaml # coding standards
├── agents/ # custom agent roles
├── skills/ # project-specific skills
├── memory/ # knowledge base
└── sessions/ # session handoff docs
```
Run the **Planning workflow** before writing any code. It produces a PRD, architecture spec, and ordered task list.
```bash
coderclaw agent --message "Plan a real-time collaboration feature" --thinking high
```
```bash
# Feature: Architecture Advisor → Code Creator → Test Generator + Code Reviewer
coderclaw agent --message "Implement the authentication module" --thinking high
# Bug fix: Bug Analyzer → Code Creator → Test Generator + Code Reviewer
coderclaw agent --message "Fix the memory leak in the parser" --thinking high
# Adversarial review (built-in critique pass):
coderclaw agent --message "Adversarially review the API design" --thinking high
```
At the end of each session, save a handoff so the next one resumes instantly.
```bash
coderclaw agent --message "Save a session handoff for today's work" --thinking low
```
CoderClaw writes a structured YAML to `.coderClaw/sessions/` covering decisions, next steps, and open questions. The next session loads it automatically.
Full workflow reference: CoderClaw Workflows
Go deeper
Full CLI wizard reference and advanced options.
First run flow for the macOS app.
What you will have
- A running Gateway
- Auth configured
- Control UI access or a connected channel
Next steps