@geteigen/cli

中文文档
6.1.1发布于 2026/11/15MITES Module近 30 天下载 4100

CLI worker for Eigen — run local Cursor/ Claude Code/Codex AI agents for multiplayer sessions

原始使用文档
文档目录9 节
  1. Requirements
  2. Install
  3. Quick start
  4. Commands
  5. Server URL
  6. Run agents on a server or VM
  7. What the worker does
  8. Development
  9. License

@geteigen/cli

CLI worker for Eigen — runs local Cursor, Claude Code, Codex, and OpenCode agents on your machine for multiplayer sessions hosted in the web app.

When you create a Local session in Eigen, prompts are relayed to this worker, which executes cursor agent, claude, codex, or opencode against a folder on your machine.

Protocol 10 is required for OpenCode, Protocol 5 for Codex, and Protocol 4 to forward chat images/files into the local workspace. Install/update:

npm i -g @geteigen/cli@latest

Requirements

  • Node.js 18+
  • Cursor CLI on your PATH (cursor command) for Cursor agents
  • Claude Code CLI (claude) for Claude Code agents
  • Codex CLI (codex) for Codex agents
  • OpenCode (opencode) for OpenCode agents
  • A Eigen account (sign in on the web app)

Install

npm install -g @geteigen/cli

Or from this repo:

cd cli
pnpm install
pnpm build
npm link

Quick start

  1. Sign in on the Eigen web app and open Pair CLI (/cli-pair).
  2. Generate a pairing code.
  3. On your machine:
eigen login
# Server URL defaults to https://cursor-multiplayer-agent.onrender.com — press Enter
# Paste the pairing code

cursor agent login   # if not already logged into Cursor CLI
# For Claude Code / OpenCode local agents, ensure `claude` / `opencode` work in your shell

eigen start
  1. Keep eigen start running while you use Local sessions in the browser.

Credentials are stored at ~/.config/steer/config.json.

Commands

CommandDescription
eigen loginPair with your Eigen account via a one-time web code
eigen logoutClear stored credentials
eigen statusShow logged-in user, server URL, and your rooms
eigen startStart the worker (connects to the API over WebSocket)
eigen start --repo <path>Same, but force every prompt to use this repo path

Server URL

eigen login defaults to:

https://cursor-multiplayer-agent.onrender.com

Override per login at the prompt, or with:

export STEER_SERVER_URL=http://localhost:3000
eigen login

Use the local URL when developing against a local API.

Run agents on a server or VM

Headless machines connect with a setup token instead of a browser login. In Eigen, open Machines → Add machine, choose personal or team (team machines can only be added by workspace owners/admins), and copy one of the commands it shows. Tokens are single-use by default and expire after 7 days.

One-line script (Linux/macOS — needs Node 20+ and git):

curl -fsSL https://www.geteigen.space/install.sh | sh -s -- --token mt_…
# optional: --agents claude,codex,opencode,cursor  --name build-vm  --no-service

Manual:

npm install -g @geteigen/cli
eigen connect --token mt_…      # trades the token for this machine's credential
eigen service install           # systemd (Linux) / launchd (macOS); starts at boot

Docker (Claude Code, Codex, OpenCode, and Cursor CLIs preinstalled):

docker run -d --name eigen-worker --restart=always \
  -e EIGEN_MACHINE_TOKEN=mt_… \
  -v eigen-worker:/root/.config/steer -v eigen-work:/work \
  ghcr.io/adityaraj-09/eigen-worker:latest

Agents still need provider access on the machine: set ANTHROPIC_API_KEY / OPENAI_API_KEY / CURSOR_API_KEY (or sign the CLIs in), or — on team machines — keep the "use team keys" policy and Eigen sends the workspace's keys with each run without storing them.

Managing it

  • eigen service status / eigen service logs / eigen service restart / eigen service uninstall
  • Auto-update: the service checks npm every 6 hours, installs a newer @geteigen/cli, and restarts itself (systemd / launchd). Disable with eigen service install --no-auto-update or EIGEN_AUTO_UPDATE=0.
  • eigen update installs the latest CLI and restarts the service now; eigen update --check only reports whether a newer version exists.
  • eigen start --daemon runs in the background without a service
  • Work roots: sessions clone repos under the work root (--root <dir>, EIGEN_WORK_ROOT, /work in Docker). Admins can also limit agents to allowed folders in Eigen → Machines; the worker refuses anything outside them.
  • Revoking: remove the machine in Eigen → Machines. It disconnects at once and its credential stops working; reconnecting needs a new setup token.

What the worker does

While eigen start is connected, the API can ask your machine to:

  • List models for each installed agent (cursor agent --list-models, opencode models, …)
  • Open a native folder picker for Local session create
  • Run Cursor, Claude Code, Codex, or OpenCode prompts in the selected repo and stream events back to the room
  • Stream tool results (including file paths and edit diffs) as each tool finishes so the web chat can group and inspect them
  • Protocol 4+: write chat images/files into .steer-uploads/ in the repo so local agents can Read them
  • Protocol 3+: Claude Code backend + exclusive file locks before edit tools run (multi-agent conflict resolution)
  • Protocol 10+: OpenCode backend (Anthropic / OpenAI provider keys or local CLI login)

Development

pnpm install
pnpm dev          # run via tsx without building
pnpm build        # compile to dist/

The published binary is dist/index.js (bin: steer).

License

MIT

版本与发布记录

@geteigen/cli 共发布 20 个版本,首次发布于 2026/11/05;过去 12 个月发布了 20 个版本。

版本发布日期距今
6.1.1latest2026/11/15今天
6.1.02026/11/106 天前
6.0.12026/11/106 天前
6.0.02026/11/106 天前
5.2.02026/11/106 天前
5.0.02026/11/096 天前

关于 @geteigen/cli 的常见问题

@geteigen/cli 是什么?

CLI worker for Eigen — run local Cursor/ Claude Code/Codex AI agents for multiplayer sessions

如何安装 @geteigen/cli?

在项目目录运行 npm install @geteigen/cli,或使用 pnpm add / yarn add / bun add。它还提供命令行工具 eigen,可以用 npx eigen 直接运行。

@geteigen/cli 支持 TypeScript 吗?

该包的 package.json 没有声明类型入口。需要类型提示时,可以在 npm 上查找社区维护的 @types/geteigen__cli 是否存在。

@geteigen/cli 支持 ESM 还是 CommonJS?

以 ES Module 形式发布,推荐使用 import 引入。在 CommonJS 项目中,Node.js 20.19+ / 22.12+ 可以直接 require() 不含顶层 await 的 ES Module,更早的版本需要改用动态 import()。

@geteigen/cli 需要什么版本的 Node.js?

package.json 的 engines 字段要求 Node.js >=18。版本不符时 npm 默认只给出警告,开启 engine-strict 后会拒绝安装。

@geteigen/cli 可以商用吗?

@geteigen/cli 使用 MIT 许可。宽松许可:允许商业使用、修改和再分发,通常只需在分发时保留原版权与许可声明。以上为概括,不构成法律意见,请以许可原文为准。

@geteigen/cli 的下载量有多少?

根据 npm 官方下载统计,@geteigen/cli 在 2026/10/17 – 2026/11/15 这 30 天内被下载 4,100 次,日均约 137 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入,适合横向比较热度,不能直接等同于使用人数。

@geteigen/cli 还在维护吗?

最新版本 6.1.1 发布于 2026/11/15(今天);至今共发布 20 个版本,其中过去 12 个月发布了 20 个;首次发布于 2026/11/05。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。