Merge pull request #136 from Yimikami/docs/integration-consistency
Solid docs cleanup — GitHub capitalization, durable wording, OpenClaw README. Nice work!
This commit is contained in:
3
.gitignore
vendored
3
.gitignore
vendored
@@ -73,4 +73,5 @@ integrations/opencode/agents/
|
|||||||
integrations/cursor/rules/
|
integrations/cursor/rules/
|
||||||
integrations/aider/CONVENTIONS.md
|
integrations/aider/CONVENTIONS.md
|
||||||
integrations/windsurf/.windsurfrules
|
integrations/windsurf/.windsurfrules
|
||||||
integrations/openclaw/
|
integrations/openclaw/*
|
||||||
|
!integrations/openclaw/README.md
|
||||||
|
|||||||
12
README.md
12
README.md
@@ -455,7 +455,7 @@ The Agency works natively with Claude Code, and ships conversion + install scrip
|
|||||||
### Supported Tools
|
### Supported Tools
|
||||||
|
|
||||||
- **[Claude Code](https://claude.ai/code)** — native `.md` agents, no conversion needed → `~/.claude/agents/`
|
- **[Claude Code](https://claude.ai/code)** — native `.md` agents, no conversion needed → `~/.claude/agents/`
|
||||||
- **[Github Copilot](https://github.com/copilot)** — native `.md` agents, no conversion needed → `~/.github/agents/`
|
- **[GitHub Copilot](https://github.com/copilot)** — native `.md` agents, no conversion needed → `~/.github/agents/`
|
||||||
- **[Antigravity](https://github.com/google-gemini/antigravity)** — `SKILL.md` per agent → `~/.gemini/antigravity/skills/`
|
- **[Antigravity](https://github.com/google-gemini/antigravity)** — `SKILL.md` per agent → `~/.gemini/antigravity/skills/`
|
||||||
- **[Gemini CLI](https://github.com/google-gemini/gemini-cli)** — extension + `SKILL.md` files → `~/.gemini/extensions/agency-agents/`
|
- **[Gemini CLI](https://github.com/google-gemini/gemini-cli)** — extension + `SKILL.md` files → `~/.gemini/extensions/agency-agents/`
|
||||||
- **[OpenCode](https://opencode.ai)** — `.md` agent files → `.opencode/agents/`
|
- **[OpenCode](https://opencode.ai)** — `.md` agent files → `.opencode/agents/`
|
||||||
@@ -536,7 +536,7 @@ See [integrations/claude-code/README.md](integrations/claude-code/README.md) for
|
|||||||
</details>
|
</details>
|
||||||
|
|
||||||
<details>
|
<details>
|
||||||
<summary><strong>Github Copilot</strong></summary>
|
<summary><strong>GitHub Copilot</strong></summary>
|
||||||
|
|
||||||
Agents are copied directly from the repo into `~/.github/agents/` -- no conversion needed.
|
Agents are copied directly from the repo into `~/.github/agents/` -- no conversion needed.
|
||||||
|
|
||||||
@@ -544,7 +544,7 @@ Agents are copied directly from the repo into `~/.github/agents/` -- no conversi
|
|||||||
./scripts/install.sh --tool copilot
|
./scripts/install.sh --tool copilot
|
||||||
```
|
```
|
||||||
|
|
||||||
Then activate in Github Copilot:
|
Then activate in GitHub Copilot:
|
||||||
```
|
```
|
||||||
Use the Frontend Developer agent to review this component.
|
Use the Frontend Developer agent to review this component.
|
||||||
```
|
```
|
||||||
@@ -572,7 +572,7 @@ See [integrations/antigravity/README.md](integrations/antigravity/README.md) for
|
|||||||
<details>
|
<details>
|
||||||
<summary><strong>Gemini CLI</strong></summary>
|
<summary><strong>Gemini CLI</strong></summary>
|
||||||
|
|
||||||
Installs as a Gemini CLI extension with 80 skills + a manifest.
|
Installs as a Gemini CLI extension with one skill per agent plus a manifest.
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
./scripts/install.sh --tool gemini-cli
|
./scripts/install.sh --tool gemini-cli
|
||||||
@@ -670,6 +670,8 @@ Each agent becomes a workspace with `SOUL.md`, `AGENTS.md`, and `IDENTITY.md` in
|
|||||||
|
|
||||||
Agents are registered and available by `agentId` in OpenClaw sessions.
|
Agents are registered and available by `agentId` in OpenClaw sessions.
|
||||||
|
|
||||||
|
See [integrations/openclaw/README.md](integrations/openclaw/README.md) for details.
|
||||||
|
|
||||||
</details>
|
</details>
|
||||||
|
|
||||||
---
|
---
|
||||||
@@ -689,7 +691,7 @@ When you add new agents or edit existing ones, regenerate all integration files:
|
|||||||
|
|
||||||
- [ ] Interactive agent selector web tool
|
- [ ] Interactive agent selector web tool
|
||||||
- [x] Multi-agent workflow examples -- see [examples/](examples/)
|
- [x] Multi-agent workflow examples -- see [examples/](examples/)
|
||||||
- [x] Multi-tool integration scripts (Claude Code, Antigravity, Gemini CLI, OpenCode, OpenClaw, Cursor, Aider, Windsurf)
|
- [x] Multi-tool integration scripts (Claude Code, GitHub Copilot, Antigravity, Gemini CLI, OpenCode, OpenClaw, Cursor, Aider, Windsurf)
|
||||||
- [ ] Video tutorials on agent design
|
- [ ] Video tutorials on agent design
|
||||||
- [ ] Community agent marketplace
|
- [ ] Community agent marketplace
|
||||||
- [ ] Agent "personality quiz" for project matching
|
- [ ] Agent "personality quiz" for project matching
|
||||||
|
|||||||
@@ -1,14 +1,16 @@
|
|||||||
# 🔌 Integrations
|
# 🔌 Integrations
|
||||||
|
|
||||||
This directory contains The Agency's 61 AI agents converted into formats
|
This directory contains The Agency integrations and converted formats for
|
||||||
compatible with popular agentic coding tools.
|
supported agentic coding tools.
|
||||||
|
|
||||||
## Supported Tools
|
## Supported Tools
|
||||||
|
|
||||||
- **[Claude Code](#claude-code)** — `.md` agents, use the repo directly
|
- **[Claude Code](#claude-code)** — `.md` agents, use the repo directly
|
||||||
|
- **[GitHub Copilot](#github-copilot)** — `.md` agents, use the repo directly
|
||||||
- **[Antigravity](#antigravity)** — `SKILL.md` per agent in `antigravity/`
|
- **[Antigravity](#antigravity)** — `SKILL.md` per agent in `antigravity/`
|
||||||
- **[Gemini CLI](#gemini-cli)** — extension + `SKILL.md` files in `gemini-cli/`
|
- **[Gemini CLI](#gemini-cli)** — extension + `SKILL.md` files in `gemini-cli/`
|
||||||
- **[OpenCode](#opencode)** — `.md` agent files in `opencode/`
|
- **[OpenCode](#opencode)** — `.md` agent files in `opencode/`
|
||||||
|
- **[OpenClaw](#openclaw)** — `SOUL.md` + `AGENTS.md` + `IDENTITY.md` workspaces
|
||||||
- **[Cursor](#cursor)** — `.mdc` rule files in `cursor/`
|
- **[Cursor](#cursor)** — `.mdc` rule files in `cursor/`
|
||||||
- **[Aider](#aider)** — `CONVENTIONS.md` in `aider/`
|
- **[Aider](#aider)** — `CONVENTIONS.md` in `aider/`
|
||||||
- **[Windsurf](#windsurf)** — `.windsurfrules` in `windsurf/`
|
- **[Windsurf](#windsurf)** — `.windsurfrules` in `windsurf/`
|
||||||
@@ -19,15 +21,18 @@ compatible with popular agentic coding tools.
|
|||||||
# Install for all detected tools automatically
|
# Install for all detected tools automatically
|
||||||
./scripts/install.sh
|
./scripts/install.sh
|
||||||
|
|
||||||
# Install for a specific tool
|
# Install a specific home-scoped tool
|
||||||
./scripts/install.sh --tool antigravity
|
./scripts/install.sh --tool antigravity
|
||||||
./scripts/install.sh --tool gemini-cli
|
./scripts/install.sh --tool gemini-cli
|
||||||
./scripts/install.sh --tool cursor
|
./scripts/install.sh --tool copilot
|
||||||
./scripts/install.sh --tool aider
|
./scripts/install.sh --tool openclaw
|
||||||
./scripts/install.sh --tool windsurf
|
|
||||||
./scripts/install.sh --tool claude-code
|
./scripts/install.sh --tool claude-code
|
||||||
```
|
```
|
||||||
|
|
||||||
|
For project-scoped tools such as OpenCode, Cursor, Aider, and Windsurf, run
|
||||||
|
the installer from your target project root as shown in the tool-specific
|
||||||
|
sections below.
|
||||||
|
|
||||||
## Regenerating Integration Files
|
## Regenerating Integration Files
|
||||||
|
|
||||||
If you add or modify agents, regenerate all integration files:
|
If you add or modify agents, regenerate all integration files:
|
||||||
@@ -53,6 +58,19 @@ See [claude-code/README.md](claude-code/README.md) for details.
|
|||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
|
## GitHub Copilot
|
||||||
|
|
||||||
|
The Agency also works natively with GitHub Copilot. Agents can be copied
|
||||||
|
directly into `~/.github/agents/` without conversion.
|
||||||
|
|
||||||
|
```bash
|
||||||
|
./scripts/install.sh --tool copilot
|
||||||
|
```
|
||||||
|
|
||||||
|
See [github-copilot/README.md](github-copilot/README.md) for details.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
## Antigravity
|
## Antigravity
|
||||||
|
|
||||||
Skills are installed to `~/.gemini/antigravity/skills/`. Each agent becomes
|
Skills are installed to `~/.gemini/antigravity/skills/`. Each agent becomes
|
||||||
@@ -79,6 +97,39 @@ See [gemini-cli/README.md](gemini-cli/README.md) for details.
|
|||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
|
## OpenCode
|
||||||
|
|
||||||
|
Each agent becomes a project-scoped `.md` file in `.opencode/agents/`.
|
||||||
|
|
||||||
|
```bash
|
||||||
|
cd /your/project && /path/to/agency-agents/scripts/install.sh --tool opencode
|
||||||
|
```
|
||||||
|
|
||||||
|
See [opencode/README.md](opencode/README.md) for details.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## OpenClaw
|
||||||
|
|
||||||
|
Each agent becomes an OpenClaw workspace containing `SOUL.md`, `AGENTS.md`,
|
||||||
|
and `IDENTITY.md`.
|
||||||
|
|
||||||
|
Before installing, generate the OpenClaw workspaces:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
./scripts/convert.sh --tool openclaw
|
||||||
|
```
|
||||||
|
|
||||||
|
Then install them:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
./scripts/install.sh --tool openclaw
|
||||||
|
```
|
||||||
|
|
||||||
|
See [openclaw/README.md](openclaw/README.md) for details.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
## Cursor
|
## Cursor
|
||||||
|
|
||||||
Each agent becomes a `.mdc` rule file. Rules are project-scoped — run the
|
Each agent becomes a `.mdc` rule file. Rules are project-scoped — run the
|
||||||
|
|||||||
@@ -28,4 +28,4 @@ Use the Reality Checker agent to verify this feature is production-ready.
|
|||||||
## Agent Directory
|
## Agent Directory
|
||||||
|
|
||||||
Agents are organized into divisions. See the [main README](../../README.md) for
|
Agents are organized into divisions. See the [main README](../../README.md) for
|
||||||
the full roster of 61 specialists.
|
the full current roster.
|
||||||
|
|||||||
@@ -1,12 +1,12 @@
|
|||||||
# Github Copilot Integration
|
# GitHub Copilot Integration
|
||||||
|
|
||||||
The Agency was built for Github Copilot. No conversion needed — agents work
|
The Agency works with GitHub Copilot out of the box. No conversion needed —
|
||||||
natively with the existing `.md` + YAML frontmatter format.
|
agents use the existing `.md` + YAML frontmatter format.
|
||||||
|
|
||||||
## Install
|
## Install
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
# Copy all agents to your Github Copilot agents directory
|
# Copy all agents to your GitHub Copilot agents directory
|
||||||
./scripts/install.sh --tool copilot
|
./scripts/install.sh --tool copilot
|
||||||
|
|
||||||
# Or manually copy a category
|
# Or manually copy a category
|
||||||
@@ -15,7 +15,7 @@ cp engineering/*.md ~/.github/agents/
|
|||||||
|
|
||||||
## Activate an Agent
|
## Activate an Agent
|
||||||
|
|
||||||
In any Github Copilot session, reference an agent by name:
|
In any GitHub Copilot session, reference an agent by name:
|
||||||
|
|
||||||
```
|
```
|
||||||
Activate Frontend Developer and help me build a React component.
|
Activate Frontend Developer and help me build a React component.
|
||||||
@@ -28,4 +28,4 @@ Use the Reality Checker agent to verify this feature is production-ready.
|
|||||||
## Agent Directory
|
## Agent Directory
|
||||||
|
|
||||||
Agents are organized into divisions. See the [main README](../../README.md) for
|
Agents are organized into divisions. See the [main README](../../README.md) for
|
||||||
the full roster of 61 specialists.
|
the full current roster.
|
||||||
|
|||||||
34
integrations/openclaw/README.md
Normal file
34
integrations/openclaw/README.md
Normal file
@@ -0,0 +1,34 @@
|
|||||||
|
# OpenClaw Integration
|
||||||
|
|
||||||
|
OpenClaw agents are installed as workspaces containing `SOUL.md`, `AGENTS.md`,
|
||||||
|
and `IDENTITY.md` files. The installer copies each workspace into
|
||||||
|
`~/.openclaw/agency-agents/` and registers it when the `openclaw` CLI is
|
||||||
|
available.
|
||||||
|
|
||||||
|
Before installing, generate the OpenClaw workspaces:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
./scripts/convert.sh --tool openclaw
|
||||||
|
```
|
||||||
|
|
||||||
|
## Install
|
||||||
|
|
||||||
|
```bash
|
||||||
|
./scripts/install.sh --tool openclaw
|
||||||
|
```
|
||||||
|
|
||||||
|
## Activate an Agent
|
||||||
|
|
||||||
|
After installation, agents are available by `agentId` in OpenClaw sessions.
|
||||||
|
|
||||||
|
If the OpenClaw gateway is already running, restart it after installation:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
openclaw gateway restart
|
||||||
|
```
|
||||||
|
|
||||||
|
## Regenerate
|
||||||
|
|
||||||
|
```bash
|
||||||
|
./scripts/convert.sh --tool openclaw
|
||||||
|
```
|
||||||
Reference in New Issue
Block a user