nandi/oripublic Fork 0
3d1f70c3b1e0d8c9a0b27adcc1bd1a9f053c050e
Commits
Clone
git clone https://git.rickub.com/nandi/ori.git
git clone ssh://git@rickub.com/nandi/ori.git

Host key fingerprint (ed25519): SHA256:iycHnxEyq0Q7uyVpB7JlznP0G7JrTPXLYRcAU5CSLhc — verify it before your first connect.

forked from bots-garden/ori

README.md · 20 lines · 1.9 KBmarkdown
Blame HistoryOpen raw

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
# Ori — documentation (English)

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.

This documentation follows the [Diátaxis](https://diataxis.fr) 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](tutorials/getting-started.md) |
| Run Ori with Claude Code | [How to run Ori with Claude Code](how-to/run-with-claude-code.md) |
| Connect a different ACP agent | [How to use another ACP agent](how-to/use-another-agent.md) |
| Package and run Ori in a Docker sandbox | [How to run Ori in a Docker sandbox](how-to/run-in-a-sandbox.md) |
| 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) |
| Mention files with `@` and invoke skills with `/` in the composer | [How to mention files and invoke skills](how-to/mention-files-and-skills.md) |
| Switch between the light and dark themes | [How to switch the theme](how-to/switch-the-theme.md) |
| Run the test suites | [How to run the tests](how-to/run-the-tests.md) |
| Look up the CLI flags | [Reference: the ori command](reference/cli.md) |
| Look up the browser ⇆ backend protocol | [Reference: WebSocket protocol](reference/websocket-protocol.md) |
| Look up the file API, the skills endpoint and the terminal | [Reference: workspace API](reference/workspace-api.md) |
| Understand the architecture and its trade-offs | [Explanation: architecture](explanation/architecture.md) |