Reliquary Alpha
MenuClose

Alpha: things change and may break; data is backed up daily. See the roadmap.

Docs menu

Docs / Tutorials

Getting started

Create a vault, connect Claude Code, approve your agent's first proposal, then run a command with your first environment variable.

This takes about 15 minutes. You need a Reliquary account: sign in with your email and the same step makes one (new accounts are let in steadily, so you may wait a while before creating a vault; an invite link gets you in at once), Claude Code, and Node 20 or later for the CLI.

1. Sign in

Open https://app.reliquary.redmage.cc (or choose Sign in on https://reliquary.redmage.cc). Enter your email, tick the box to agree to the Terms and Privacy Policy and confirm you're not based in the EU, EEA, UK or Switzerland (the hosted alpha isn't offered there yet), then choose Email me a code. Enter the 6-digit code from the email (or open its link on the same device).

2. Create a vault

A vault holds files, variables and members. See Vaults, files and folders.

  1. On Home, choose New vault.
  2. Name it My project.
  3. Under Start from, leave Blank chosen for this tutorial. For real work, a template like Client engagement or Product team starts the vault with folders, rules and a README that tells your agents how to work in it.
  4. Under Files without a rule are, choose Canon, so every change to a file is a proposal a person approves. (Open would let editors and their agents write files directly. You can change this later, and set it per folder with rules.)
  5. Choose Create vault. You are its owner.

3. Connect Claude Code

In a terminal, add Reliquary once for your user:

claude mcp add --transport http --scope user reliquary https://mcp.reliquary.redmage.cc/mcp

Start Claude Code, run /mcp, choose reliquary, then Authenticate. Your browser opens Reliquary's consent page:

  1. If All my vaults, including ones I join later is already chosen, which it is when you have one vault, leave it.
  2. Choose Read and write, so the agent can propose changes.
  3. Choose Allow.

Claude Code keeps the connection and refreshes it by itself. It shows on your Connections page, where you can revoke it at any time.

4. Let your agent propose a file

Ask Claude Code:

Using Reliquary, list my vaults. Then propose a new file notes/hello.md in "My project"
that says what this project is, with the reason "first note".

It calls list_vaults, then propose. Because the vault is canon, nothing is written yet: the change waits for you. An agent can never approve its own proposal, or anyone's. See Agents and the ceiling.

5. Approve it

In the web app, the Inbox in the top bar now shows a count of 1.

  1. Open the proposal. The diff comes first, then the agent's stated reason, marked unverified.
  2. Choose Approve.

The vault needs one approval (its quorum), so the file is written at once. Open My project, then Files in its sidebar: notes/hello.md is there, credited to your agent, and the change is in Updates. See Proposals and review for requesting changes, comments and snooze.

6. Add your first variable

  1. In My project, open Variables in the sidebar.
  2. Choose Add a variable.
  3. Name it GREETING, pick the development environment, and type a harmless value, like hello.
  4. Choose Save variable.

The value is encrypted before it is stored. Your agent can see the name GREETING through list_variables, never the value. See Environment variables.

7. Run a command with it

Connect the Reliquary CLI to your account. Your browser opens a consent page; choose the vaults it may read, then Allow:

npx @reliquary-ai/cli login

Run a command with the development variables in its environment. This one prints the value's length, not the value:

npx @reliquary-ai/cli run --vault "My project" --env development -- sh -c 'echo "GREETING has ${#GREETING} characters"'

Nothing is written to disk. Back in the web app, Variables, Access log shows the read, by you, through the Reliquary CLI.

What's next

For agents: this page as Markdown, and every page at /llms.txt.