Deploy GoClaw in minutes. Choose between compiling from source for local development, or starting container stacks via Docker Compose.
Ideal for Go developers wishing to build locally. Compiles dependencies into one static executable.
Pull the main stable release branch locally.
$ git clone -b main https://github.com/nextlevelbuilder/goclaw.git $ cd goclaw
Use Makefile to build the optimized binary.
$ make build
Initialize configuration files, database profiles, and providers.
$ ./goclaw onboard
Boot the server locally.
$ source .env.local $ ./goclaw
Deploy GoClaw alongside isolated PostgreSQL, vector indexes, and caching services quickly.
Execute setup scripts to generate local secrets files.
$ chmod +x prepare-env.sh $ ./prepare-env.sh
Edit the generated .env file and configure keys.
# Open .env and write your target API keys
GOCLAW_ANTHROPIC_API_KEY=your_key_here
Launch services in the background.
$ make up
Open the console in your browser, or ping health checkpoints.
# Console Dashboard: http://localhost:18790 $ curl http://localhost:18790/health
Quick command aliases to manage your running Docker containers.
Initializes and spins up GoClaw Server and database nodes in the background.
Safely stops active container nodes, freeing local network ports.
Streams continuous server logs from both the gateway processes and database hooks.
Tears down running container volumes, resetting PostgreSQL databases back to schema zero.
Configure optional backend parameters in your environment config to enable rich tool capabilities.
| Environment Flag | Service Details | Prerequisites |
|---|---|---|
| WITH_BROWSER=1 | Enables browser scraping and web rendering tools via isolated headless Chrome nodes. | Chrome service container node active. |
| WITH_OTEL=1 | Collects and exports span tracers to Jaeger nodes for visual query timing audits. | Jaeger collector active. |
| WITH_SANDBOX=1 | Launches isolated sandbox execution zones for safe, restricted command line runs. | Docker sandbox driver configured. |
| WITH_TAILSCALE=1 | Securely binds your gateway stack to private Tailscale secure overlay networks. | Tailscale credentials. |
| WITH_REDIS=1 | Plugs in Redis clusters to manage high-speed API limits and distributed cache locks. | Active Redis cache container. |