You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+70-1Lines changed: 70 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -69,7 +69,76 @@ See the full [ROADMAP](./docs/guides/ROADMAP.md) for details on each iteration.
69
69
70
70
## Getting started
71
71
72
-
### Installation and deployment
72
+
### Claude Code plugin (recommended)
73
+
74
+
This repository ships a [Claude Code plugin](https://docs.anthropic.com/en/docs/claude-code/plugins) that provides guided workflows for setup, deployment, task submission, and troubleshooting.
The `--plugin-dir` flag tells Claude Code to load the local plugin from the `docs/abca-plugin/` directory. The plugin's skills, commands, agents, and hooks will be available immediately.
85
+
86
+
> **Tip:** If you use Claude Code via VS Code or JetBrains, you can add `--plugin-dir docs/abca-plugin` to the extension's CLI arguments setting.
87
+
88
+
#### What the plugin provides
89
+
90
+
**Skills** (guided multi-step workflows — Claude activates these automatically based on your request):
91
+
92
+
| Skill | Triggers on | What it does |
93
+
|-------|------------|--------------|
94
+
|`setup`| "get started", "install", "first time setup" | Full guided setup: prerequisites, toolchain, deploy, smoke test |
95
+
|`deploy`| "deploy", "cdk diff", "destroy" | Deploy, diff, or destroy the CDK stack with pre-checks |
96
+
|`onboard-repo`| "add a repo", "onboard", 422 errors | Add a new GitHub repository via Blueprint construct |
- The plugin lives under `docs/` to keep documentation and plugin content colocated
135
+
- Skills live in subdirectories with a `SKILL.md` file (not flat `.md` files)
136
+
- Agents are flat `.md` files with YAML frontmatter
137
+
- The hook advertises plugin capabilities only (no project-specific content)
138
+
139
+
**After editing plugin files**, restart Claude Code with `claude --plugin-dir docs/abca-plugin` to pick up changes.
140
+
141
+
### Manual installation and deployment
73
142
74
143
Install [mise](https://mise.jdx.dev/getting-started.html) if you want to use repo tasks (`mise run install`, `mise run build`). For monorepo-prefixed tasks (`mise //cdk:build`, etc.), set **`MISE_EXPERIMENTAL=1`** — see [CONTRIBUTING.md](./CONTRIBUTING.md).
A Claude Code plugin that provides guided workflows for setting up, deploying, operating, and troubleshooting the ABCA (Autonomous Background Coding Agents on AWS) platform.
4
+
5
+
## Installation
6
+
7
+
```bash
8
+
claude --plugin-dir docs/abca-plugin
9
+
```
10
+
11
+
Or add to your project's `.claude/settings.json`:
12
+
13
+
```json
14
+
{
15
+
"plugins": ["./docs/abca-plugin"]
16
+
}
17
+
```
18
+
19
+
## What's Included
20
+
21
+
### Skills (slash commands)
22
+
23
+
| Skill | Trigger | Description |
24
+
|-------|---------|-------------|
25
+
|`/setup`| First-time setup, prerequisites | Walk through prerequisites, toolchain, and first deployment |
26
+
|`/deploy`| Deploy, diff, destroy | Deploy, diff, or destroy the CDK stack |
27
+
|`/onboard-repo`| Add a repository | Onboard a GitHub repo via Blueprint CDK construct |
28
+
|`/submit-task`| Submit a coding task | Submit tasks with prompt quality guidance and cost controls (supports quick mode) |
This plugin is markdown and configuration only (no executable code), so traditional unit tests don't apply. Instead, a **3-layer validation strategy** verifies correctness:
|**3. Content Integrity**| All repo paths exist, all `mise run` commands are valid tasks, all `bgagent` CLI flags match actual help output, skill cross-references resolve, AWS CLI syntax is correct |
71
+
72
+
### Running the tests
73
+
74
+
From the repo root with Claude Code:
75
+
76
+
```
77
+
claude --plugin-dir docs/abca-plugin
78
+
```
79
+
80
+
Then ask Claude to validate the plugin:
81
+
82
+
```
83
+
Validate the abca-plugin using the plugin-validator agent, then verify
84
+
all command references and file paths in the skills are accurate.
0 commit comments