Getting Started

Installation

Install EGC once and it works across every AI coding tool you already use.

Requirements

Scroll the table horizontally for all columns.

Requirement	Version	Check
Node.js	`20+`	node --version
Git	`any`	git --version
OS	Linux, macOS, Windows

Choose your method

Use npm on any supported system, or select your operating system for the source installer.

03 /Run the installation

Fastest

Works on Linux, macOS, and Windows. No git clone needed.

Using mise, nvm, asdf, or fnm? Install EGC under your default Node version, the one active outside any project directory, to avoid version conflicts.

terminal

$ npm install -g @egchq/egc
$ egc install

Permissions: if npm install -g fails with EACCES (Node from your distro's package manager, or any root-owned global prefix), run only the npm install -g step with sudo and everything else as your normal user. A Node version manager such as nvm, mise or fnm never needs sudo.

Then wake up the brain: the bare install prepares the runtime only. Inside a real project, run egc init once so your AI tools restore its memory on their very first prompt. egc doctor should end with errors=0.

You need Node.js 20+. Not sure? Run node --version.

bash

$ git clone https://github.com/Fmarzochi/EGC.git
$ cd EGC
$ sh scripts/install.sh

You need Node.js 20+. Not sure? Run node --version.

zsh

$ git clone https://github.com/Fmarzochi/EGC.git
$ cd EGC
$ sh scripts/install.sh

You need Node.js 20+ and PowerShell. Run as Administrator if prompted.

powershell

PS> git clone https://github.com/Fmarzochi/EGC.git
PS> cd EGC
PS> .\scripts\install.ps1

Upgrading later with npm install -g @egchq/egc@latest: close the AI tools and terminals that run EGC first. npm renames the package folder during the update, and Windows refuses while any process holds a file inside it (an AI tool running the EGC MCP servers is enough). The failure reads EBUSY: resource busy or locked; closing the tools clears it, and so does a reboot.

What the installer does

Prepares the MCP servers

The npm package ships egc-guardian and egc-memory prebuilt; a clone from source builds them from TypeScript.

Initializes the store

Creates the local SQLite store under ~/.egc/ for decisions, lessons and the session bus. State documents live under ~/.egc/state/, one per project branch, encrypted at rest.

Cognitive bootstrap

Writes the memory protocol into the global instruction files for each detected tool (CLAUDE.md, GEMINI.md, cursor.rules, etc.).

Registers MCP servers and hooks

Writes both servers into the MCP config of the ten tools that take it (Antigravity, Claude Code, Cursor, Kiro, Codex CLI, OpenCode, Zed, Kimi Code CLI, Crush, Auggie) and wires native hooks in every tool that has them. For Claude Code, also installs a SessionStart hook (loads state automatically) and a Stop hook (saves state automatically at session end). Runs once per tool, idempotent.

Prompt library (optional)

Asks whether to install 232 skills, 77 commands, and 61 agents; the default is no. From v1.1.22, egc install --prompt-library answers yes without asking and --no-prompt-library skips the question. Skipped automatically in CI.

Token Crusher binary shim

Installs a PATH-level shim (git, npm, gh, and more) under ~/.egc/bin as a best-effort step. Covers a known gap where the automatic hook never fires for commands the AI assistant itself issues on Claude Code.

Expected output

terminal

EGC install
  node v22.0.0
  building egc-guardian...
  building egc-memory...
  initializing database...
  bootstrapping cognitive protocol...
  ✓ ~/.claude/CLAUDE.md updated
  ✓ ~/.gemini/GEMINI.md updated
  registering MCP servers...
  ✓ registered in Antigravity CLI
  ✓ registered in Claude Code (global)
  ✓ registered in Cursor
  ✓ registered in Codex CLI
  ✓ registered in OpenCode
  ✓ registered in Zed

Install prompt library? (61 agents, 232 skills, 77 commands) [y/N]:

  Installing Token Crusher binary shim...
  ✓ Installed: git, npm, gh, ...

Installation complete.
Run 'egc doctor' to verify.

Verify the installation

$ egc doctor

egc-guardian  running
egc-memory    running
database      ok
claude code   registered
cursor        registered

If a tool shows not found, it either isn't installed or wasn't detected. You can re-run egc install (or egc init inside a project) after installing the tool.

Next steps

egc-memory

Learn how get_state and update_state work.

egc-guardian

Understand the validation and safety layer.

Features

Full feature overview and prompt library details.

CLI Reference

All egc commands explained.