Installation
The fastest path — run in your project and follow the wizard:
npx -y @event4u/agent-config initOn a terminal with a display this auto-launches a browser wizard; the same installer runs behind it. All install paths run the same installer and produce identical results.
Install paths
Section titled “Install paths”Two you would choose, and one fallback for when the registry will not resolve.
| Path | Command | Notes |
|---|---|---|
| npx (canonical) | npx -y @event4u/agent-config init |
Recommended; opens the wizard on a TTY |
| npm dependency | install as a dependency, then agent-config … |
bin.agent-config → the bundled CLI |
| curl one-liner (fallback) | curl -sSL https://raw.githubusercontent.com/event4u-app/agent-config/main/setup.sh | bash |
Reach for this only when npm cannot resolve — a lagging or private mirror, a restricted network, a corrupted cache. It fetches a GitHub tarball and runs a dependency-inlined bundle, so it performs no npm dependency resolution. Needs Node ≥ 20 like the others: what it avoids is resolution, not Node |
npx flags: --profile=<minimal|balanced|full>, --tools=<list>,
--dry-run (preview writes), --no-ui, --gui (force the wizard past the
TTY/headless checks; it does not override CI, AGENT_CONFIG_NO_UI, or a
CLI-mode flag — those combinations exit non-zero).
Headless / CI: the wizard is skipped automatically on CI, on a non-TTY, on
a headless host, and whenever any CLI-mode flag is present — the non-interactive
installer then runs directly. The complete opt-out set is listed once, against
the code, in the gui-wizard contract.
The setup wizard (agent-config setup) boots a small server on 127.0.0.1
(loopback-bound, CSRF-gated) and opens at /#/wizard; its first question is
which experience you want, which sets your profile.
Install scope
Section titled “Install scope”Pick one scope per machine:
- User-global (default for
initsince v2.5+) — writes~/.event4u/agent-config/,~/.claude/,~/.cursor/, … Your project tree gets anagents/overrides/folder only. - Project-local — maintainer-only, behind
AGENT_CONFIG_DEV_MODE=1.
The installer refuses a second conflicting scope via a pre-flight guard.
Supported host tools
Section titled “Supported host tools”Rules project into every tool; skills are native to Claude Code; commands are native on Claude Code and text-referenced elsewhere.
| Tool | Rules | Skills | Commands | Mechanism |
|---|---|---|---|---|
| Claude Code | ✅ | ✅ | ✅ | .claude/ |
| Cursor | ✅ | — | text-ref | .cursor/rules/ + AGENTS.md |
| Cline | ✅ | — | text-ref | .clinerules/ + AGENTS.md |
| Windsurf | ✅ | — | text-ref | .windsurfrules + AGENTS.md |
| Gemini CLI | ✅ | — | text-ref | GEMINI.md |
| GitHub Copilot | ✅ | — | text-ref | .github/copilot-instructions.md |
| Roo Code | ✅ | — | text-ref | .roo/rules/ + AGENTS.md |
| Codex CLI | ✅ | — | text-ref | AGENTS.md |
| Continue.dev | ✅ | — | text-ref | .continue/rules/ + AGENTS.md |
| Aider · Augment · Claude Desktop | marker | — | — | global / manual marker |
Full --tools= id list:
claude-code,cursor,augment,windsurf,cline,gemini-cli,copilot,roocode,aider,codex,claude-desktop,continue.
The core suite is provider-agnostic and needs no API keys. Only the optional AI-council and team features consult external models, and those keys are configured separately (see Configuration).
Keeping in sync
Section titled “Keeping in sync”Team members run npx @event4u/agent-config sync after clone; CI can gate drift
with agent-config validate. There is no one-shot uninstall command yet —
removal is manual (see the
installation guide).