@eidola/cli
v0.4.4
Published
Portable AI personality runtime — MCP server, Shrine display, and reactive Vessel control (requires eidola setup-hooks).
Maintainers
Readme
@eidola/cli
The unified eidola CLI: MCP server, Shrine display, and reactive Vessel
control for Eidola — middleware that gives AI personas
a visible, reactive presence inside Cursor and Claude Code.
Local-first: runs over stdio (eidola mcp) or serves a browser Shrine
(eidola launch shrine). Binds locally; never proxies API keys. Single
install — there are no peer packages to install separately.
Install
npm install -g "@eidola/cli"Requires Node.js 20 or later.
Setup
1. Create your Eidola folder
Create a folder called Eidola anywhere on your computer (e.g.
~/Documents/Eidola/) and unzip a downloaded Engram directly inside it.
2. Connect your AI editor
Run once, then fully quit and relaunch your editor:
eidola setup-claude # Claude Code
eidola setup-cursor # Cursorsetup-claude writes the MCP server entry and hook relay config into
.claude/settings.json. setup-cursor writes the MCP server entry to
.cursor/mcp.json plus the hook relay config — equivalent to:
{
"mcpServers": {
"eidola": {
"command": "eidola",
"args": ["mcp"],
"env": {
"EIDOLA_ROOT": "/absolute/path/to/your/Eidola-folder"
}
}
}
}Either command writes to the current workspace by default; pass --global
to install to your home directory instead.
3. Launch the Shrine
eidola launch shrineOpen the shrine in your browser at http://127.0.0.1:9743/shrine/. Or just
ask your editor's agent to "launch the shrine."
4. Awaken
In the Shrine UI: choose your Eidola folder → pick an Engram → click Awaken. Optionally press F11 for fullscreen.
You can do the same thing from chat instead — ask your agent to "Awaken
<engram-id>" — it's equivalent to clicking Awaken in the UI.
Commands
| Command | Description |
|---|---|
| eidola mcp | MCP server over stdio |
| eidola launch shrine | Start Shrine HTTP server at http://127.0.0.1:9743/shrine |
| eidola kill shrine | Stop a running Shrine HTTP server |
| eidola setup-cursor [--global] | Add Eidola MCP server to Cursor + install hooks for a reactive Vessel (workspace-scoped by default; --global for ~/.cursor) |
| eidola setup-claude [--global] | Add Eidola MCP server to Claude Code + install hooks for a reactive Vessel (workspace-scoped by default; --global for ~/.claude) |
| eidola uninstall [--global] | Remove the Eidola MCP server entry + hooks from Cursor and Claude Code (workspace-scoped by default; --global to remove the home-directory install), plus any awaken-written personality files still active in the workspace |
MCP tools
A chat-based alternative to the Shrine UI, for calling from your editor's agent:
| Tool | Input | What it does |
|---|---|---|
| awaken | engram_id | Loads an Engram, binds its Vessel, wires up Soul delivery, and shows it on the Shrine display. |
| sleep | (none) | Puts the active Engram to sleep and clears the Shrine display. |
| launch_shrine | surface (optional) | Starts the Shrine display if it isn't already running. |
Environment
| Variable | Default | Description |
|---|---|---|
| EIDOLA_ROOT | cwd (published) or monorepo root (dev) | Your Eidola folder |
| EIDOLA_ENGRAMS_DIR | $EIDOLA_ROOT (published) or $EIDOLA_ROOT/engrams (monorepo dev) | Engram scan path |
| EIDOLA_VESSELS_DIR | $EIDOLA_ROOT/vessels | Vessel pack path |
Learn more
Full source, the Engram spec, and other runtime packages (hook relays, Shrine, Cursor extension) live in the eidola-runtime repo.
