All pages

Quickstart

From install to your first captured session.

Three steps on Linux or macOS (or WSL on Windows). You need one supported tool installed. You do not need a model, a database or an account.

  1. Install rh

    The installer picks the archive for your machine, verifies it against the release’s SHA256SUMS, puts rh and rivethub-migrate in ~/.local/bin and starts a standalone node. --no-start installs only, --no-service skips the service, --version pins a release, and --dir picks another directory.

    Linux or macOS
    $ curl -fsSL https://get.rivethub.io/local.sh | bash

    Read the installer first if you like. Linux builds need glibc 2.35 or newer.

    Install by hand instead

    Every release publishes one archive per target and a SHA256SUMS file.

    version=0.8.12
    target=x86_64-unknown-linux-gnu    # or aarch64-unknown-linux-gnu, universal-apple-darwin
    base=https://github.com/Rivethub/rivethub-runtime/releases/download/v$version
    curl -fL -O "$base/rh-$version-$target.tar.gz" -O "$base/SHA256SUMS"
    sha256sum --ignore-missing -c SHA256SUMS      # Linux; use the installer on macOS
    mkdir -p ~/.local/bin
    tar -xzf "rh-$version-$target.tar.gz" -C ~/.local/bin rh rivethub-migrate
    rh version

    Then start a node:

    $ rh local --ensure

    The node keeps everything in ~/.rivethub/memory.sqlite and serves plain HTTP on 127.0.0.1:5174 only. rh status reports its health.

  2. Connect a tool

    rh harness status lists the tools it finds on this machine. rh harness connect adds capture and recall where supported; it prints the diff and backs the file up before it writes.

    $ rh harness connect claude-code

    For DeepSeek Harness on 0.8.4, run rh harness connect dsh for capture and recall. Other ids: codex, grok-build, opencode. Add --dry-run to see the change without making it, --capture or --recall to do one half, and rh harness disconnect to undo it. Capture has the per-tool details.

    Codex: Open Codex in a terminal after connecting. When it says “Hooks need review”, choose “Trust all and continue”. Until you trust the hooks, codex exec silently skips them. Connecting again can require another review. From rh 0.8.6, rh harness status says whether Codex trusts the hooks and rh harness connect codex says what to answer.

    OpenCode: OpenCode 2 (@opencode/cli) is the supported OpenCode. OpenCode 1.x is captured from rh 0.8.6: update rh, then run rh harness connect opencode again; rh harness status says when the installed plug-in is out of date. On older rh, 1.x refused the plug-in (opencode run --print-logs shows failed to load plugin). OpenCode 1.x gets no further work.

  3. See your first captured session

    Do a short task in the tool you connected, then read the capture log. Each capture appends one line:

    Claude Code; other tools write codex-capture.log, grok-capture.log, opencode-capture.log, dsh-capture.log
    $ tail -n 3 ~/.rivethub/claude-capture.log

    Confirm the stored session, title and message count through the authenticated API (never paste the token into a report):

    $ curl -fsS -H "Authorization: Bearer $(cat "$(rh auth token-path)")" http://127.0.0.1:5174/api/sessions

    In a new session, ask the agent to search RivetHub memory for something you said in the first one. It calls memory_search and gets your own words back. Inspect its actual memory_search call and result: the agent’s own memory can mask a failure. With no embedding endpoint, results begin “Keyword search. Meaning-based search needs an embedding endpoint.” This is normal and has no warning mark. The sessions field in /healthz still reports 0; it is not a captured-session counter. If nothing appears, follow troubleshooting.

    Did it work? One click tells us whether this page does its job. After analytics consent, it records an anonymous event (privacy).

    Stuck? rh doctor checks the node, and support lists what to include when you ask for help.

Recall from any other MCP client

Anything that speaks MCP can read the record. Add this entry to the client’s MCP configuration:

{ "mcpServers": { "rivethub": { "command": "rh", "args": ["mcp"] } } }

API and MCP lists the tools it serves.

Next

On Linux with a usable systemd user session, the installer leaves the node running as an enabled rivethub.service. It says whether the node starts at login or at boot and prints the lingering command when needed; it does not run it. On macOS, WSL without systemd, containers without a usable systemd user session, or with --no-service, the node does not restart by itself. Read keeping the node running for older installs, manual setup and these exceptions. The desktop app is a preview with no release. A site-installed 0.8.4 node has no bundled browser UI. rh open explains this instead of printing a broken link; GET / returns 200 with an explanation. Use the API and MCP checks above.

For no cloud at first install, append -s -- --no-cloud to the installer’s bash command. rh local --no-cloud writes the policy only for a new config. Existing configs need cloud.disabled: true added by you and a restart; it never silently edits them. See cloud policy.