forked from bots-garden/ori
| ✨ Workspace panel, selectors, previews, desktop app, sandbox template, resizable file tree, light/dark theme | 1 | # Ori — documentation (English) |
| 2 | ||
| 3 | Ori is a web application that acts as an [ACP (Agent Client Protocol)](https://agentclientprotocol.com) client for AI code agents: a Go backend serves a React single-page application and connects, over ACP, to an agent such as Claude Code. The browser gets an agent-panel experience in the spirit of Zed's: streamed answers, visible tool calls, plans and permission prompts. | |
| 4 | ||
| 5 | This documentation follows the [Diátaxis](https://diataxis.fr) structure — pick the section matching what you need right now: | |
| 6 | ||
| 7 | | You want to… | Go to | | |
| 8 | | --- | --- | | |
| 9 | | Learn by doing: run Ori and hold your first conversation | [Tutorial: getting started](tutorials/getting-started.md) | | |
| 10 | | Run Ori with Claude Code | [How to run Ori with Claude Code](how-to/run-with-claude-code.md) | | |
| 11 | | Connect a different ACP agent | [How to use another ACP agent](how-to/use-another-agent.md) | | |
| 12 | | Package and run Ori in a Docker sandbox | [How to run Ori in a Docker sandbox](how-to/run-in-a-sandbox.md) | | |
| 13 | | Browse, preview (code, Markdown, AsciiDoc, images, draw.io), edit files and use the terminal | [How to use the workspace panel](how-to/use-the-workspace.md) | | |
| 14 | | Mention files with `@` and invoke skills with `/` in the composer | [How to mention files and invoke skills](how-to/mention-files-and-skills.md) | | |
| 15 | | Switch between the light and dark themes | [How to switch the theme](how-to/switch-the-theme.md) | | |
| 16 | | Run the test suites | [How to run the tests](how-to/run-the-tests.md) | | |
| 17 | | Look up the CLI flags | [Reference: the ori command](reference/cli.md) | | |
| 18 | | Look up the browser ⇆ backend protocol | [Reference: WebSocket protocol](reference/websocket-protocol.md) | | |
| 19 | | Look up the file API, the skills endpoint and the terminal | [Reference: workspace API](reference/workspace-api.md) | | |
| 20 | | Understand the architecture and its trade-offs | [Explanation: architecture](explanation/architecture.md) | |