forked from bots-garden/ori
Ori — documentation (English)
Ori is a web application that acts as an ACP (Agent Client Protocol) 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.
This documentation follows the Diátaxis structure — pick the section matching what you need right now:
| You want to… | Go to |
|---|---|
| Learn by doing: run Ori and hold your first conversation | Tutorial: getting started |
| Run Ori with Claude Code | How to run Ori with Claude Code |
| Connect a different ACP agent | How to use another ACP agent |
| Package and run Ori in a Docker sandbox | How to run Ori in a Docker sandbox |
| Browse, preview (code, Markdown, AsciiDoc, images, draw.io), edit files and use the terminal | How to use the workspace panel |
Mention files with @ and invoke skills with / in the composer |
How to mention files and invoke skills |
| Switch between the light and dark themes | How to switch the theme |
| Run the test suites | How to run the tests |
| Look up the CLI flags | Reference: the ori command |
| Look up the browser ⇆ backend protocol | Reference: WebSocket protocol |
| Look up the file API, the skills endpoint and the terminal | Reference: workspace API |
| Understand the architecture and its trade-offs | Explanation: architecture |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 |
|