← Docs

Getting Started

From zero to running agent in under 5 minutes.

1. Clone and build

$ git clone https://github.com/aegntic/clawreform.git
$ cd clawreform
$ cargo build --release

Requires Rust 1.75+ and a C linker. Takes 2-4 minutes.

2. Start the daemon

$ export GROQ_API_KEY=your-key-here   # or OPENAI_API_KEY
$ ./target/release/clawreform start

The daemon starts the API on http://127.0.0.1:4332 and the embedded dashboard at the same address.

3. Verify

$ curl http://127.0.0.1:4332/api/health
{"status":"ok","version":"0.3.0"}

4. Open the dashboard

Navigate to http://127.0.0.1:4332/ in your browser. The embedded Alpine.js dashboard shows agents, budgets, skills, and network status in real time.

5. Send a message

$ curl -X POST http://127.0.0.1:4332/api/agents/default/message \
  -H "Content-Type: application/json" \
  -d '{"message": "Hello, clawREFORM!"}'

This sends a message to the default agent, which routes to your configured LLM provider and returns a response.