Skip to main content

​
Installation

The Compound Plugin CLI requires minimal setup. You can use it via bunx without any installation, or install it globally for repeated use.

​
Prerequisites

Before using Compound Plugin, ensure you have the following installed:
1

Install Bun (Recommended)

Bun is the fastest way to run Compound Plugin. Install it using the official installer:
curl -fsSL https://bun.sh/install | bash
Verify installation:
bun --version
2

Alternative: Install Node.js

If you prefer npm/npx, install Node.js 18 or later:Verify installation:
node --version
npm --version
3

Install Git (Optional)

Git is required if you want to clone the repository for local development:
  • Download from git-scm.com
  • Or install via your package manager
Verify installation:
git --version

​
Installation Methods

The fastest way to use Compound Plugin is with bunx - no installation required: 
bunx @every-env/compound-plugin --help
This downloads and runs the latest version automatically. Perfect for one-off conversions or trying the tool.

​
Option 2: Global Installation

For repeated use, install globally: 
bun install -g @every-env/compound-plugin
After global installation, you can use the shorter command: 
compound-plugin --help

​
Option 3: Local Development

For contributing or local development:
1

Clone the repository

git clone https://github.com/EveryInc/compound-engineering-plugin.git
cd compound-engineering-plugin
2

Install dependencies

bun install
3

Run locally

bun run src/index.ts install ./plugins/compound-engineering --to opencode

​
Verification

Verify your installation by checking the version and available commands: 
bunx @every-env/compound-plugin --version
bunx @every-env/compound-plugin --help
You should see output showing the version number and available commands: 
Usage: compound-plugin [command] [options]

Commands:
  install <plugin> --to <target>  Install a plugin to a target platform
  sync [--target <target>]        Sync Claude Code config to other tools
  list                            List available plugins

​
Target Platform Setup

The CLI will write to platform-specific directories. Make sure your target AI coding assistant is installed before running conversions.

​
Common Target Directories

PlatformOutput LocationNotes
OpenCode~/.config/opencode/Commands as .md files; deep-merged config
Codex~/.codex/prompts + ~/.codex/skillsPrompts and skill pairs
Factory Droid~/.factory/Native tool mappings
Pi~/.pi/agent/MCPorter interoperability
Gemini CLI.gemini/Namespaced commands as TOML
GitHub Copilot.github/Agent markdown with MCP env vars
Kiro CLI.kiro/JSON configs with prompt files
Windsurf~/.codeium/windsurf/ (global) or .windsurf/ (workspace)Skills and workflows
OpenClaw~/.openclaw/extensions/<plugin>/TypeScript skill extensions
Qwen Code~/.qwen/extensions/<plugin>/Agent YAML configurations

​
Troubleshooting

​
Bun command not found

If bun isn’t recognized after installation:
  1. Restart your terminal
  2. Check if Bun’s bin directory is in your PATH: 
    echo $PATH | grep bun
  3. Add Bun to PATH manually in ~/.bashrc, ~/.zshrc, or equivalent: 
    export PATH="$HOME/.bun/bin:$PATH"

​
Permission errors on npm global install

If you get permission errors with npm: 
# Use npx instead of global install
npx @every-env/compound-plugin --help

# Or configure npm to use a different directory
npm config set prefix ~/.npm-global
export PATH=~/.npm-global/bin:$PATH

​
Target directory doesn’t exist

The CLI creates target directories automatically. If you see errors about missing directories, ensure:
  1. You have write permissions to the target location
  2. The parent directory exists (e.g., ~/.config/ for OpenCode)
  3. You’re running the command as the correct user

​
Next Steps

Quick Start

Install the compound-engineering plugin to OpenCode in 30 seconds