Setup Guide

Install Eidola

  1. 1

    Install the runtime

    npm install -g "@eidola/cli"

    Requires Node.js 20 or later.

  2. 2

    Create your Eidola folder

    Create a folder called Eidola anywhere on your computer (e.g. ~/Documents/Eidola/) and download an Engram into it — unzip it directly inside.

  3. 3

    Connect your AI editor

    Run one of these once, then fully quit and relaunch your editor:

    Claude Codeeidola setup-claude
    Cursoreidola setup-cursor

    Each writes the Eidola MCP server entry plus the hook relay config that drives a reactive Vessel from tool activity. Workspace-scoped by default — pass --global to install to your home directory instead.

  4. 4

    Launch the Shrine

    eidola launch shrine

    Open the shrine in your browser at http://127.0.0.1:9743/shrine/. Or just ask your editor's agent to “launch the shrine.”

  5. 5

    Awaken

    In the Shrine UI: choose your Eidola folder → pick an Engram → click Awaken. Press F11 for fullscreen.

Setup — Eidola