Install Allye Plugin

Install Allye on Pi, Claude Code, OpenCode, Cursor, Codex, Gemini CLI, or Hermes Agent.

The Allye Plugin has a unified installer and platform-specific installation paths. Pi is the recommended platform for using Allye Plugin, especially when you want more autonomy to choose and configure how the harness works. Choose the path that matches your agent. The installer is additive and idempotent: it manages Allye's entries without replacing unrelated MCP servers, plugins, or settings.

The plugin is tested extensively with Claude Code, Codex, and OpenCode. Their integration models differ: Pi and OpenCode give the agent more control over harness configuration, while Claude Code and Codex use stronger host conventions.

Before you begin

  • Have an Allye account.
  • Install at least one supported host agent.
  • Use a terminal for the unified installer. It requires Bash, curl, and jq.
  • Complete OAuth in the host when it asks you to sign in.

Unified installer

Use this path to detect and configure every supported agent found on the machine:

git clone https://github.com/allye-app/allye-plugin.git
cd allye-plugin
./install.sh

Useful operations:

./install.sh status
./install.sh install <agent>
./install.sh uninstall <agent>

Replace <agent> with claude, opencode, cursor, codex, gemini, hermes, or pi. status reports the managed installation state; uninstall removes the Allye-managed integration for the selected host.

The unified installer does not publish anything and does not overwrite unrelated configuration. Pi is intentionally different: the installer delegates package installation to Pi and does not manage Pi's MCP configuration.

Pi is the recommended platform for using Allye Plugin. It gives Allye and the host more autonomy to choose and configure the harness while keeping the workflow adaptive.

Pi receives the published allye-pi package. The installer delegates to Pi's package manager and exposes the canonical skills through Pi's resource discovery. It does not edit Pi's settings or MCP files.

./install.sh install pi

Equivalent package installation:

pi install npm:allye-pi

Remove it with:

./install.sh uninstall pi

After installation, add https://mcp.allye.app through Pi's MCP connection flow and complete OAuth. Restart Pi or reload packages, then use /allye-capabilities to see which Allye, filesystem, subagent, and optional Herdr capabilities are available in the current session.

For a repository checkout instead of the published package:

pi install git:github.com/allye-app/allye-plugin

Use a local checkout only for development:

cd /path/to/allye-plugin
ALLYE_PI_INSTALL_SOURCE=local ./install.sh install pi

Claude Code — native plugin

Claude Code has the deepest native integration: marketplace installation, a session-start hook, the canonical skills, and five bounded subagents. It is one of the plugin's most extensively tested hosts. Claude Code may require an explicit request to access Allye Memory or load a particular Allye skill because the host controls more of when context and tools are used. This behavior is intentional host coordination, and Claude Code remains a strong option when its native structure suits your workflow.

/plugin marketplace add allye-app/allye-plugin
/plugin install allye
/reload-plugins

Then open /plugin, find Allye MCP Server, select Connect, and complete the OAuth flow in your browser. Reload the plugins after authentication if Claude Code asks you to.

To update:

/plugin update allye
/reload-plugins

For separate Allye accounts in different projects, install the plugin with local scope so each project can keep an independent OAuth session.

OpenCode — native package plus MCP

OpenCode receives the allye-opencode package and six agents in its picker: Allye, Allye Plan, Allye Orchestrator, Allye Build, Allye Review, and Allye Deliver. It is one of the plugin's most extensively tested hosts and gives you more autonomy to select and configure how the harness works.

The supported installation is agent-assisted. In OpenCode, paste:

Install allye-plugin following: https://raw.githubusercontent.com/allye-app/allye-plugin/main/docs/install-opencode.md

The guide preserves the existing OpenCode configuration, adds Allye's remote MCP connection, and registers the package. Restart OpenCode, then complete OAuth the first time Allye is used. Use Ctrl+T to switch between the Allye agents.

To update, paste:

Update allye-plugin following: https://raw.githubusercontent.com/allye-app/allye-plugin/main/docs/update-opencode.md

Cursor — MCP plus .cursorrules

Cursor uses an MCP configuration together with a project instruction manifest. It does not install a multi-agent picker.

In Cursor's agent chat, paste:

Install allye-plugin following: https://raw.githubusercontent.com/allye-app/allye-plugin/main/docs/install-cursor.md

The guide adds Allye to the global Cursor MCP configuration and installs .cursorrules in the current project. Existing rules should be appended to, not replaced. Restart Cursor and complete OAuth when Allye is first used.

To update:

Update allye-plugin following: https://raw.githubusercontent.com/allye-app/allye-plugin/main/docs/update-cursor.md

Codex — MCP plus AGENTS.md

Codex uses its MCP configuration and a global AGENTS.md instruction manifest. It has one host agent rather than a separate Allye agent picker, and it is one of the plugin's most extensively tested hosts.

In Codex, paste:

Install allye-plugin following: https://raw.githubusercontent.com/allye-app/allye-plugin/main/docs/install-codex.md

The guide preserves the existing Codex configuration, installs the Allye instructions, and starts OAuth on first use. Start a new Codex session after installation.

To update:

Update allye-plugin following: https://raw.githubusercontent.com/allye-app/allye-plugin/main/docs/update-codex.md

Gemini CLI — MCP plus GEMINI.md

Gemini CLI uses its MCP configuration and a global GEMINI.md instruction manifest. It has one host agent rather than a separate Allye agent picker.

In Gemini CLI, paste:

Install allye-plugin following: https://raw.githubusercontent.com/allye-app/allye-plugin/main/docs/install-gemini.md

The guide preserves the existing Gemini configuration, installs the Allye instructions, and starts OAuth on first use. Start a new Gemini session after installation.

To update:

Update allye-plugin following: https://raw.githubusercontent.com/allye-app/allye-plugin/main/docs/update-gemini.md

Hermes Agent — adapter and skills on disk

Hermes receives a platform-specific adapter. The installer exports 16 published skills to the Hermes skills directory, installs the Allye bootstrap plugin, and adds the Allye MCP configuration.

git clone https://github.com/allye-app/allye-plugin.git
cd allye-plugin
./install.sh install hermes

OAuth requires an interactive terminal. Run the host command yourself:

hermes mcp add allye --url https://mcp.allye.app --auth oauth

Sign in in the browser, then start a new Hermes session.

Allye's shared memory is the continuity source for this integration, so the installer disables Hermes' separate memory store and kanban toolset. Hermes' ordinary scratch TODO remains available.

To update:

cd allye-plugin
git pull
./install.sh install hermes

Remote MCP connection with OAuth

Every supported platform connects to Allye through the remote MCP service at https://mcp.allye.app.

OAuth is browser-based and user-scoped. Complete the sign-in and consent flow in your browser; the host stores and refreshes the session. The plugin does not require credentials to be pasted into a prompt or instruction file.

Updating every platform

  • Claude Code: use /plugin update allye, then reload plugins.
  • OpenCode, Cursor, Codex, and Gemini CLI: use the corresponding update guide from the plugin repository.
  • Hermes: pull the repository and run ./install.sh install hermes again.
  • Pi: update the installed package through Pi's package manager or rerun ./install.sh install pi.

No update path changes unrelated host integrations.