Skip to content

Quickstart

Get Stockroom installed and running in a few minutes.

Prerequisites

  • Cursor or Claude Code
  • A POSIX shell and network access for the first-time setup (torch wheel + first ingest)

Install and initialize

  1. Add the txrk9-agent-plugins marketplace (that README shows the Cursor and Claude Code UI steps), then install the stockroom plugin from it.
  2. Cursor only: ensure Include third-party Plugins, Skills, and other configs (Cursor Settings → Rules, Skills, Subagents) is enabled. Plugin hooks do not register without this until Cursor's plugin-hooks bug is fixed:

Include third-party Plugins, Skills, and other configs — toggle on

  1. Run first-time setup:
    • Cursor: /sr-initialize
    • Claude Code: /stockroom:sr-initialize
  2. Ask the agent something about past work, or slash-invoke /sr-search:
    /sr-search "What was the most-recent time I had to correct an agent's behavior?"

sr-initialize checks prerequisites, provisions the per-machine torch wheel, puts stockroom on your PATH, offers nightly ingest+embed scheduling, and runs the first full ingest + embed. Re-runs are safe & idempotent: it re-probes and only does what is still missing.

What to try next

  • Prefer sr-search when you are unsure whether the question is structured SQL or meaning-based recall — Search.
  • Open the local metrics UI with sr-dashboard (also launched automatically on session start - click here! - when hooks are registered) — Dashboard.
  • Curious what landed on disk? See Installed layout.
  • If something fails and your agent can't figure it out, see Troubleshooting (sections follow this guide's order).