Installation
Install Blue Gardener as a dev dependency in your project.
Prerequisites
- Node.js 18 or higher
- npm, pnpm, or yarn package manager
- A project using one of the supported AI platforms
Install
Choose your package manager:
npm install -D blue-gardenerpnpm add -D blue-gardeneryarn add -D blue-gardenerVerify Installation
Check that Blue Gardener is installed correctly:
npx blue-gardener --versionpnpm blue-gardener --versionyarn blue-gardener --versionYou should see the version number (e.g., 0.1.0).
What Gets Installed
After installation, your package.json will include:
{
"devDependencies": {
"blue-gardener": "^0.1.0"
}
}Blue Gardener does not install any agents yet - you'll select and add them in the next step.
Platform Detection
Blue Gardener automatically detects your platform based on your project structure:
| Directory/File | Platform Detected |
|---|---|
.cursor/agents/ | Cursor |
.claude/agents/ | Claude Desktop |
.windsurf/ | Windsurf |
.opencode/agents/ | OpenCode |
.github/copilot-instructions.md | GitHub Copilot |
AGENTS.md | Codex |
If no platform is detected, Blue Gardener will prompt you to select one on first use.
Updating Blue Gardener
To update to the latest version:
npm update blue-gardenerpnpm update blue-gardeneryarn upgrade blue-gardenerInstalled agents will automatically sync to their latest versions when you update Blue Gardener.
Uninstalling
To remove Blue Gardener and all installed agents:
# Remove all agents first (optional)
npx blue-gardener list
# Then uninstall
npm uninstall blue-gardener# Remove all agents first (optional)
pnpm blue-gardener list
# Then uninstall
pnpm remove blue-gardener# Remove all agents first (optional)
yarn blue-gardener list
# Then uninstall
yarn remove blue-gardenerNote: This does not remove agent files from your project. Use blue-gardener remove to clean up agents before uninstalling.
Next Steps
Now that Blue Gardener is installed:
First Steps →
Add your first agents
Platforms →
Learn about platform-specific behavior
