Installation Options

🌐 Interactive Web Tour: Explore the memory pipeline simulator, live architecture explorer, and MCP tool tester on the Hermes Brain Showcase Website.

🚀 Option 1 — One-Line Terminal Install (Fastest, directly from GitHub) link

Open your terminal and run the one-liner. It automatically clones or downloads the latest template directly from GitHub, sets up your vault, configures your Hermes CLI environment (HERMES_VAULT_PATH), and optionally registers the hourly session archiver:

Linux / macOS / WSL:

  curl -fsSL https://raw.githubusercontent.com/mistrysiddh/hermes-brain-template/main/_System/Scripts/Installers/install.sh | bash
  

Windows (PowerShell):

  irm https://raw.githubusercontent.com/mistrysiddh/hermes-brain-template/main/_System/Scripts/Installers/install.ps1 | iex
  

Non-interactive flags are supported: --dest <path> --backend <ollama|python|skip> --test (PowerShell: -Dest <path> -Backend <ollama|python|skip> -Test).

📦 Option 2 — GitHub “Use this template” or Clone link

If you want your own private/custom git repository:

1. Click the green Use this template button on GitHub to create your personal vault repository.
2. Clone your repository:

     git clone https://github.com/<your-username>/<your-vault-repo>.git
   cd <your-vault-repo>
     

3. Run the interactive installer from inside the cloned folder:
   • Linux / macOS:

       chmod +x _System/Scripts/Installers/install.sh
     ./_System/Scripts/Installers/install.sh
       

   • Windows (PowerShell):

       powershell -ExecutionPolicy Bypass -File .\_System\Scripts\Installers\install.ps1
       

The installer guides you through destination selection, optional local embeddings (Ollama / sentence-transformers), and registering your vault with the Hermes CLI.

🤖 Option 3 — One Paste into Hermes Agent (Easiest for Hermes users) link

If you already run a Hermes agent, skip cloning and manual scripting entirely: open INSTALL_PROMPT.md and paste the master prompt straight into your Hermes chat:

• Prompt 1 — installs the vault only
• Prompt 2 — sets up the hourly archiving cron job only (vault must already exist)
• Prompt 3 (master) — does both in one paste: install the vault, then set up the hourly cron job, no follow-up needed

🧪 Option 4 — Zero-Commitment Trial (Scratch Vault) link

Not ready to install anything yet? Copy the template into a temporary scratch directory and open it in Obsidian without touching your real config or registering anything with Hermes:

Linux / macOS:

  ./_System/Scripts/Installers/try.sh
  

Windows (PowerShell):

  powershell -ExecutionPolicy Bypass -File .\_System\Scripts\Installers\try.ps1
  

Delete the scratch copy any time. Run Option 1 or 2 when you are ready to keep it for real.

🛠️ Option 5 — Full Manual Control link

Prefer configuring everything by hand? Follow SETUP.md step by step.

🌐 Option 6 — GitHub Codespaces (Zero-Local-Setup Trial) link

No local install needed. Click the badge below to spin up a ready-to-run environment in your browser:

Once the Codespace loads, run the scratch-vault trial:

  ./_System/Scripts/Installers/try.sh
  

This creates a temporary vault at /tmp/hermes-brain-trial that you can open in Obsidian (via the Obsidian URI scheme or by copying files out). When you’re done, just delete the Codespace — no cleanup needed on your machine.

Tip: Codespaces gives you 60 hours/month free on the GitHub Free plan — plenty for evaluating the template.