Getting Started

Installation

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

Requirements

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

Node.js 20+

node --version

Git any

git --version

OS Linux, macOS, Windows

Choose your method

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

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

What the installer does

Compiles MCP servers

Builds egc-guardian and egc-memory from TypeScript source.

Initializes the database

Creates the local SQLite database at ~/.egc/ for persistent memory.

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

Adds both servers to every detected tool's MCP config. 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 230 skills, 77 commands, and 63 agents. Skipped automatically in CI.

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 Continue.dev
  ✓ registered in Cursor
  ✓ registered in Windsurf
  ✓ registered in Amp
  ✓ registered in VS Code Copilot

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

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 sh scripts/install.sh 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.