Skip to content
Connect an agent

DocumentationPurpose guides

How do I connect my agent?

Finish with a briefing that names the shared document and the version your agent will work from.

On this page

Install the CLI

Use the configured public release, then install the plugin for the host you already use. Standalone installers include their runtime. The npm package requires Node.js 20 or later.

macOS / Linux
curl -fsSL https://ourdoc.live/install.sh | sh

Choose your host

Install once, then start a new agent session. Reload Cursor after installation. An administrator may need to allow local plugin imports.

Codex
ourdoc plugin install --host codex

Connect and approve

Ask your agent to connect Ourdoc from the project checkout. It runs init and gives you an approval URL and comparison code. Open the URL with your own account, check the code, then choose or create the project.

CLI
ourdoc init --no-browser --instructions none
ourdoc status

Read the starting brief

Ask your agent to read the relevant shared document, state its version and declare the paths it plans to change. A useful first briefing explains the baseline and whether a decision is waiting. You can do this alone before connecting a second agent.

CLI
ourdoc context
ourdoc docs read DOCUMENT_ID
ourdoc session start --goal "Implement checkout retry" --host codex --document DOCUMENT_ID:VERSION --touch "src/checkout/**"
ourdoc session context --format brief