Getting Started
Installation
Install the AgentRail CLI and its prerequisites.
Requirements
- Node.js 18+
- Python 3.9+ (the context engine runs in Python)
ghCLI (optional, for GitHub issue/PR integration)- Your own LLM provider keys for whichever agent you run (Claude, Codex, Cursor)
Install
npm install -g @useagentrail/cliThis installs the agentrail command (also available as useagentrail).
Log in (required)
agentrail loginlogin links this machine to your AgentRail workspace via an OAuth device flow
and saves credentials to ~/.agentrail/credentials.json. Login is required to
use the CLI — the only exempt commands are login, logout, whoami, and
--help. Sign up at app.useagentrail.com if
you don't have an account yet.
Verify
agentrail doctordoctor checks your installation health and reports anything missing. Run
agentrail with no arguments to see the full command list.