AgentClash
K

Contributing

Contributor Setup

Clone the repo, bring up the local stack, and pick the fastest development loop for the part of AgentClash you are changing.

If you are touching backend workflows or the web product, start the full local stack. If you are only changing the CLI, point the CLI at production and skip the backend entirely.

Full-stack local development

1. Clone the repo and start the stack

bash
1git clone https://github.com/agentclash/agentclash.git
2cd agentclash
3./scripts/dev/start-local-stack.sh

That script starts PostgreSQL, Redis, Temporal, the API server, and the worker.

2. Start the web app

bash
1cd web
2pnpm install
3pnpm dev

3. Seed local data

bash
1cd ..
2./scripts/dev/seed-local-run-fixture.sh
3./scripts/dev/curl-create-run.sh

Faster loop for CLI-only work

If you only need the CLI:

bash
1export AGENTCLASH_API_URL="https://api.agentclash.dev"
2cd cli
3go run . auth login --device
4go run . link
5go run . run list

This is the fastest way to change the CLI without also running the API server and worker locally.

What lives where

  • backend/cmd/api-server — API entry point
  • backend/cmd/worker — worker entry point
  • cli/ — Cobra CLI
  • web/ — Next.js app
  • docs/ — existing internal markdown docs and references
  • testing/ — review contracts, test notes, and issue-specific validation docs

See also

PreviousFrontendNextCodebase Tour