CLI and API reference
Use the guides on this site for everyday workflows. Detailed agent-facing command and API documentation lives alongside the Go source and is also available through Coral's documentation view.
Commands
Coral ships companion commands for agents to interact with the app:
coral-boardreads and manages team messages and tasks.coral-agentmanages personal tasks, uploads and downloads artifacts, and publishes Agent UI panels.coralstarts the server from a terminal. Runcoral --helpfor supported flags.
Agent sessions launched by Coral receive the server and session identity they need. If you run commands from a separate shell, consult the command's reference for connection and identity options; do not assume it targets the same server when multiple Coral instances are running.
Detailed reference
These links open the maintained source documentation on GitHub. They follow main; use a release tag in GitHub when you need documentation matching an older installed version.
| Topic | Reference |
|---|---|
| Team board commands and API | Message board |
| Task dependencies, results, and artifacts | Task workflows |
| Personal agent tasks | Agent tasks |
| Publishing interactive panels | Agent UI |
| Team configuration | Team configuration |
| Sessions and terminal actions | Sessions |
| One-time jobs | Jobs |
| Scheduled jobs | Scheduled jobs |
| Multi-step workflows | Workflows |
| Settings and system status | Settings and system |
| Analytics events and controls | Telemetry |
| Themes | Themes |
The reference index lists the full set of topics. Authentication requirements vary by endpoint; see the authentication reference before writing an integration.
Documentation changes
User guides live in coral-go/site_docs/. Agent-facing references live in coral-go/agent_docs/. The legacy Python docs are not the source for this site.
When changing behavior, update the relevant guide and reference with the same change. Check the generated site for broken links before merging; the documentation deployment workflow publishes updates from main.
From the repository root, build and validate the documentation with:
python3 -m venv /tmp/coral-docs-venv
/tmp/coral-docs-venv/bin/python -m pip install -r requirements-docs.txt
/tmp/coral-docs-venv/bin/python -m mkdocs build --strict --site-dir /tmp/coral-docs-site
/tmp/coral-docs-venv/bin/python tools/check-site-links.py /tmp/coral-docs-site
Python is used to build this documentation website; it is not a runtime dependency of the Coral app.