ormah/docs
GitHub

Getting Started

Quickstart

Give your agents proactive memory in under 5 minutes.

Ormah is designed to feel more like memory than search. Instead of waiting for your agent to ask for context, it can surface the right memory before the next prompt is processed, so the agent starts with the preferences, constraints, and context that matter.

1. Install

Run the shell installer:

bash <(curl -fsSL https://ormah.me/install.sh)

This installs the ormah binary and runs the initial setup flow automatically.

Claude Code users — you can also install via the Claude Code plugin. See Installation for details.

By default, the installer will:

  • configure Ormah for local use
  • enable auto-start
  • wire in supported integrations if they are present
  • ask whether you want agent-backed maintenance

tip If you choose agent-backed maintenance, Ormah will delegate graph cleanup tasks to your agent rather than running a local LLM. This is the recommended option if you use Claude Code or Codex regularly.

If you install with --no-setup, run ormah setup manually afterward.

2. Check that the server is running

ormah server status

You should see the server responding on localhost:8787. You can also check directly:

curl http://localhost:8787/admin/health

If you want a visual check, you can also open the local UI at http://localhost:8787/ui.

3. Test remember and recall

ormah remember "I prefer short, clear explanations"

Then retrieve it:

ormah recall "how do I like explanations"

If recall returns the memory you just stored, Ormah is working.

4. Use Ormah from your agent

If your agent was detected during setup, Ormah may already be connected.

Open a new session in your agent and ask it to recall the preference you just stored. If it can retrieve that memory, the integration is active.

If whisper hooks are enabled for that client, Ormah will also inject relevant memories automatically before replies.

See Supported Agents for currently supported clients and upcoming integrations.

Memories are stored as markdown files at ~/.local/share/ormah/memory/nodes/.

What's next