Getting Started

April 9, 2026 ยท View on GitHub

Goal: go from zero to a first working chat with minimal setup.

Fastest chat: open the Control UI (no channel setup needed). Run `opencrabs dashboard` and chat in the browser, or open `http://127.0.0.1:18789/` on the gateway host. Docs: [Dashboard](/web/dashboard) and [Control UI](/web/control-ui).

Prereqs

  • Rust 1.85.0 or later (edition 2024 support required)
Check your Rust version with `rustc --version` if you are unsure.

Quick setup (CLI)

```bash curl -fsSL https://opencrabs.com/install.sh | bash ``` Install Script Process ```powershell iwr -useb https://opencrabs.com/install.ps1 | iex ``` 
<Note>
Other install methods and requirements: [Install](/install).
</Note>
```bash opencrabs onboard --install-daemon ``` 
The wizard configures auth, gateway settings, and optional channels.
See [Onboarding Wizard](/start/wizard) for details.
If you installed the service, it should already be running: 
```bash
opencrabs gateway status
```
```bash opencrabs dashboard ``` If the Control UI loads, your Gateway is ready for use.

Optional checks and extras

Useful for quick tests or troubleshooting. 
```bash
opencrabs gateway --port 18789
```
Requires a configured channel. 
```bash
opencrabs message send --target +15555550123 --message "Hello from opencrabs"
```

Useful environment variables

If you run opencrabs as a service account or want custom config/state locations:

  • OPENCRABS_HOME sets the home directory used for internal path resolution.
  • OPENCRABS_STATE_DIR overrides the state directory.
  • OPENCRABS_CONFIG_PATH overrides the config file path.

Full environment variable reference: Environment vars.

Go deeper

Full CLI wizard reference and advanced options. First run flow for the macOS app.

What you will have

  • A running Gateway
  • Auth configured
  • Control UI access or a connected channel

Next steps

  • DM safety and approvals: Pairing
  • Connect more channels: Channels
  • Advanced workflows and from source: Setup