Getting started
This section takes you from a fresh clone to a working apomesh setup, one step at a time. Each page builds on the one before it, and every command is copy-paste runnable.
What you’ll have at the end
Section titled “What you’ll have at the end”- The local stack running under Docker — orchestrator, worker, Postgres, and Redis.
- A first deep-research session you can watch complete without any API keys.
- A live session against a real LLM provider.
- The operator console open, connected to your stack.
- Your own Python script dispatching a session through the SDK.
Who this is for
Section titled “Who this is for”Anyone meeting apomesh for the first time — an operator who will run the stack, an engineer who will build on the SDK, or a contributor sizing up the platform. No prior apomesh knowledge is assumed. You reach a running session without reading anything outside this section.
Before you start
Section titled “Before you start”You need a few tools installed. Each page names the ones it uses, but the full set is:
- Docker with the
docker composeplugin — runs the stack. just— the operator command runner (brew install juston macOS).- Python 3.11+ and
uv— for the SDK and the first-session replay. - An LLM provider credential (Anthropic) — only for the real-provider and SDK-dispatch steps. The first session needs nothing.
The five steps
Section titled “The five steps”- Install & prerequisites — clone the repo, materialize local config, and bring the stack up.
- First session (no API keys) — replay a recorded deep-research session with no keys and no network.
- Real-provider session — add a credential and dispatch a live session.
- The operator console — open the console and find your way around.
- First SDK dispatch — write your own dispatch in Python.
Work through them in order.
Start with Install & prerequisites.