Setup
Setup step by step
A checklist from an empty machine to a working team — every action links to the page of this section, in the order you do them.
This section follows the order in which the system is set up. Every page answers five questions: what to do, where, how to check the result, what you should see, and what to do if it did not work. Every command and name was checked against the code of version 0.9.2.
Checklist
- Choose where the server will run and install it with one command — Install and update.
- Log the CLI in with the installer's key and check
cradle health— Install and update. - Open the console and connect the cradle ("This computer" or "Add cradle") — Sign-in, people and keys.
- Check who became the owner and invite people with
cradle members add— Sign-in, people and keys. - Issue an API key for bots and integrations with
cradle keys create— Sign-in, people and keys. - Download a chat model and an embedding model — Keys and models.
- If needed, connect provider keys or a GPU server and switch the team contour to
cloud— Keys and models. - Create a team ("Add team") and check that its agents have models — Team.
- Create a knowledge base, upload files and bind it to agents — Knowledge bases.
- Turn on a channel: HTTP API, Telegram, widget or MCP — Channels.
- Send the first message and resolve the ticket in "Waiting for decision" — Waiting for decision.
- Optionally connect an external code agent (GitHub Actions) — External code agent.
- Update the server with
cradle update— Install and update.
Conventions
cradle …commands work aftercradle login; the examples use the server addresshttp://127.0.0.1:31416.- Console buttons and menu items are given as they are written in the interface; some labels in the console are in English ("Save", "Start", "Approve & send") and are given as they are.
- Where a step has neither a screen in the console nor a CLI command, a
POST /api/v1/rpc/<channel>call is given: body{"args": [...]}, answer{"result": ...}, headersAuthorization: Bearer <key>andX-Cradle-Team: <team slug>. - How things are built and why is in Architecture and Reference; this section is only the order of actions.