Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
141 changes: 132 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,14 +46,18 @@ Browse the agents below and copy/adapt the ones you need!

### Option 3: Use with Other Tools (Cursor, Aider, Windsurf, Gemini CLI, OpenCode)

#### Linux / macOS (Bash)
```bash
# Step 1 -- generate integration files for all supported tools
# Step 1 -- generate integration files
./scripts/convert.sh

# Step 2 -- install interactively (auto-detects what you have installed)
# Step 2 -- install interactively
./scripts/install.sh
```

* Or target a specific tool directly

# Or target a specific tool directly
```bash
./scripts/install.sh --tool cursor
./scripts/install.sh --tool copilot
./scripts/install.sh --tool aider
Expand All @@ -62,6 +66,26 @@ Browse the agents below and copy/adapt the ones you need!

See the [Multi-Tool Integrations](#-multi-tool-integrations) section below for full details.

#### Windows (PowerShell)
```powershell
# Step 1 -- generate integration files
.\scripts\convert.ps1

# Step 2 -- install interactively
.\scripts\install.ps1
```

* Or target a specific tool directly

```powershell
.\scripts\install.ps1 -Tool cursor
.\scripts\install.ps1 -Tool copilot
.\scripts\install.ps1 -Tool aider
.\scripts\install.ps1 -Tool windsurf
```

See the [Multi-Tool Integrations](#-multi-tool-integrations) section below for full details.

---

## 🎨 The Agency Roster
Expand Down Expand Up @@ -501,16 +525,24 @@ The Agency works natively with Claude Code, and ships conversion + install scrip

### ⚡ Quick Install

**Step 1 -- Generate integration files:**
#### Linux / macOS (Bash)
```bash
# Step 1 -- generate integration files
./scripts/convert.sh
```

**Step 2 -- Install (interactive, auto-detects your tools):**
```bash
# Step 2 -- install interactively
./scripts/install.sh
```

#### Windows (PowerShell)
```powershell
# Step 1 -- generate integration files
.\scripts\convert.ps1

# Step 2 -- install interactively
.\scripts\install.ps1
```

The installer scans your system for installed tools, shows a checkbox UI, and lets you pick exactly what to install:

```
Expand All @@ -536,18 +568,35 @@ The installer scans your system for installed tools, shows a checkbox UI, and le
```

**Or install a specific tool directly:**

#### Linux / macOS (Bash)
```bash
./scripts/install.sh --tool cursor
./scripts/install.sh --tool opencode
./scripts/install.sh --tool openclaw
./scripts/install.sh --tool antigravity
```

#### Windows (PowerShell)
```powershell
.\scripts\install.ps1 -Tool cursor
.\scripts\install.ps1 -Tool opencode
.\scripts\install.ps1 -Tool openclaw
.\scripts\install.ps1 -Tool antigravity
```

**Non-interactive (CI/scripts):**

#### Linux / macOS (Bash)
```bash
./scripts/install.sh --no-interactive --tool all
```

#### Windows (PowerShell)
```powershell
.\scripts\install.ps1 -NoInteractive -Tool all
```

---

### Tool-Specific Instructions
Expand All @@ -557,10 +606,16 @@ The installer scans your system for installed tools, shows a checkbox UI, and le

Agents are copied directly from the repo into `~/.claude/agents/` -- no conversion needed.

#### Linux / macOS (Bash)
```bash
./scripts/install.sh --tool claude-code
```

#### Windows (PowerShell)
```powershell
.\scripts\install.ps1 -Tool claude-code
```

Then activate in Claude Code:
```
Use the Frontend Developer agent to review this component.
Expand All @@ -574,10 +629,16 @@ See [integrations/claude-code/README.md](integrations/claude-code/README.md) for

Agents are copied directly from the repo into `~/.github/agents/` and `~/.copilot/agents/` -- no conversion needed.

#### Linux / macOS (Bash)
```bash
./scripts/install.sh --tool copilot
```

#### Windows (PowerShell)
```powershell
.\scripts\install.ps1 -Tool copilot
```

Then activate in GitHub Copilot:
```
Use the Frontend Developer agent to review this component.
Expand All @@ -591,10 +652,16 @@ See [integrations/github-copilot/README.md](integrations/github-copilot/README.m

Each agent becomes a skill in `~/.gemini/antigravity/skills/agency-<slug>/`.

#### Linux / macOS (Bash)
```bash
./scripts/install.sh --tool antigravity
```

#### Windows (PowerShell)
```powershell
.\scripts\install.ps1 -Tool antigravity
```

Activate in Gemini with Antigravity:
```
@agency-frontend-developer review this React component
Expand All @@ -609,11 +676,18 @@ See [integrations/antigravity/README.md](integrations/antigravity/README.md) for
Installs as a Gemini CLI extension with one skill per agent plus a manifest.
On a fresh clone, generate the Gemini extension files before running the installer.

#### Linux / macOS (Bash)
```bash
./scripts/convert.sh --tool gemini-cli
./scripts/install.sh --tool gemini-cli
```

#### Windows (PowerShell)
```powershell
.\scripts\convert.ps1 -Tool gemini-cli
.\scripts\install.ps1 -Tool gemini-cli
```

See [integrations/gemini-cli/README.md](integrations/gemini-cli/README.md) for details.
</details>

Expand All @@ -622,11 +696,18 @@ See [integrations/gemini-cli/README.md](integrations/gemini-cli/README.md) for d

Agents are placed in `.opencode/agents/` in your project root (project-scoped).

#### Linux / macOS (Bash)
```bash
cd /your/project
/path/to/agency-agents/scripts/install.sh --tool opencode
```

#### Windows (PowerShell)
```powershell
Set-Location "C:\your\project"
& "D:\path\to\agency-agents\scripts\install.ps1" -Tool opencode
```

Or install globally:
```bash
mkdir -p ~/.config/opencode/agents
Expand All @@ -646,11 +727,18 @@ See [integrations/opencode/README.md](integrations/opencode/README.md) for detai

Each agent becomes a `.mdc` rule file in `.cursor/rules/` of your project.

#### Linux / macOS (Bash)
```bash
cd /your/project
/path/to/agency-agents/scripts/install.sh --tool cursor
```

#### Windows (PowerShell)
```powershell
Set-Location "C:\your\project"
& "D:\path\to\agency-agents\scripts\install.ps1" -Tool cursor
```

Rules are auto-applied when Cursor detects them in the project. Reference them explicitly:
```
Use the @security-engineer rules to review this code.
Expand All @@ -664,11 +752,18 @@ See [integrations/cursor/README.md](integrations/cursor/README.md) for details.

All agents are compiled into a single `CONVENTIONS.md` file that Aider reads automatically.

#### Linux / macOS (Bash)
```bash
cd /your/project
/path/to/agency-agents/scripts/install.sh --tool aider
```

#### Windows (PowerShell)
```powershell
Set-Location "C:\your\project"
& "D:\path\to\agency-agents\scripts\install.ps1" -Tool aider
```

Then reference agents in your Aider session:
```
Use the Frontend Developer agent to refactor this component.
Expand All @@ -682,11 +777,18 @@ See [integrations/aider/README.md](integrations/aider/README.md) for details.

All agents are compiled into `.windsurfrules` in your project root.

#### Linux / macOS (Bash)
```bash
cd /your/project
/path/to/agency-agents/scripts/install.sh --tool windsurf
```

#### Windows (PowerShell)
```powershell
Set-Location "C:\your\project"
& "D:\path\to\agency-agents\scripts\install.ps1" -Tool windsurf
```

Reference agents in Windsurf's Cascade:
```
Use the Reality Checker agent to verify this is production ready.
Expand All @@ -700,10 +802,16 @@ See [integrations/windsurf/README.md](integrations/windsurf/README.md) for detai

Each agent becomes a workspace with `SOUL.md`, `AGENTS.md`, and `IDENTITY.md` in `~/.openclaw/agency-agents/`.

#### Linux / macOS (Bash)
```bash
./scripts/install.sh --tool openclaw
```

#### Windows (PowerShell)
```powershell
.\scripts\install.ps1 -Tool openclaw
```

Agents are registered and available by `agentId` in OpenClaw sessions.

See [integrations/openclaw/README.md](integrations/openclaw/README.md) for details.
Expand All @@ -715,13 +823,21 @@ See [integrations/openclaw/README.md](integrations/openclaw/README.md) for detai

SubAgents are installed to `.qwen/agents/` in your project root (project-scoped).

#### Linux / macOS (Bash)
```bash
# Convert and install (run from your project root)
cd /your/project
./scripts/convert.sh --tool qwen
./scripts/install.sh --tool qwen
```

#### Windows (PowerShell)
```powershell
Set-Location "C:\your\project"
& "D:\path\to\agency-agents\scripts\convert.ps1" -Tool qwen
& "D:\path\to\agency-agents\scripts\install.ps1" -Tool qwen
```

**Usage in Qwen Code:**
- Reference by name: `Use the frontend-developer agent to review this component`
- Or let Qwen auto-delegate based on task context
Expand All @@ -737,9 +853,16 @@ cd /your/project

When you add new agents or edit existing ones, regenerate all integration files:

#### Linux / macOS (Bash)
```bash
./scripts/convert.sh # regenerate all
./scripts/convert.sh --tool cursor # regenerate just one tool
./scripts/convert.sh # regenerate all
./scripts/convert.sh --tool cursor # regenerate just one tool
```

#### Windows (PowerShell)
```powershell
.\scripts\convert.ps1 # regenerate all
.\scripts\convert.ps1 -Tool cursor # regenerate just one tool
```

---
Expand Down
Loading