Skip to content

Commit 0742ebe

Browse files
author
bgagent
committed
chore(docs): clean docs
1 parent 756373f commit 0742ebe

18 files changed

Lines changed: 268 additions & 2662 deletions

File tree

docs/abca-plugin/README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -25,8 +25,8 @@ Or add to your project's `.claude/settings.json`:
2525
| `/setup` | First-time setup, prerequisites | Walk through prerequisites, toolchain, and first deployment |
2626
| `/deploy` | Deploy, diff, destroy | Deploy, diff, or destroy the CDK stack |
2727
| `/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) |
29-
| `/troubleshoot` | Debug, errors, failures | Diagnose build, deployment, auth, and task execution issues |
28+
| `/submit-task` | Submit a coding task | Submit tasks with prompt quality guidance and cost controls (supports quick mode, `--trace`) |
29+
| `/troubleshoot` | Debug, errors, failures | Diagnose build, deployment, auth, and task execution issues (supports `--verbose`) |
3030
| `/status` | Status, health check | Check stack health, running tasks, and recent history |
3131

3232
### Agents
@@ -38,7 +38,7 @@ Or add to your project's `.claude/settings.json`:
3838

3939
### Hook
4040

41-
- **SessionStart** — Advertises available skills and agents so Claude can proactively suggest them when your request matches.
41+
- **SessionStart** — Advertises available skills, agents, and interactive task commands (`watch`, `nudge`, `trace`, `webhook`) so Claude can proactively suggest them when your request matches.
4242

4343
## Plugin Structure
4444

docs/abca-plugin/hooks/hooks.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
"SessionStart": [
44
{
55
"type": "prompt",
6-
"prompt": "The ABCA plugin is active. Available skills:\n- /setup — first-time setup walkthrough\n- /deploy — deploy, diff, or destroy the CDK stack\n- /onboard-repo — add a GitHub repository\n- /submit-task — submit a coding task (guided or quick mode)\n- /troubleshoot — diagnose deployment, auth, or task issues\n- /status — platform health check (stack, tasks, build)\n\nAvailable agents: cdk-expert (CDK infrastructure), agent-debugger (task failure investigation).\n\nSuggest relevant skills when the user's request matches."
6+
"prompt": "The ABCA plugin is active. Available skills:\n- /setup — first-time setup walkthrough\n- /deploy — deploy, diff, or destroy the CDK stack\n- /onboard-repo — add a GitHub repository\n- /submit-task — submit a coding task (guided or quick mode)\n- /troubleshoot — diagnose deployment, auth, or task issues\n- /status — platform health check (stack, tasks, build)\n\nAvailable agents: cdk-expert (CDK infrastructure), agent-debugger (task failure investigation).\n\nInteractive task commands (suggest when user is monitoring or steering a running task):\n- bgagent watch <task-id> — stream progress events in real time\n- bgagent nudge <task-id> \"<message>\" — steer the agent mid-run\n- bgagent trace download <task-id> — download full execution trace\n- bgagent webhook create/list/revoke — manage webhook integrations\n- --trace flag on submit — enable detailed tracing for a task\n- --verbose flag — HTTP debug output on any command\n\nSuggest relevant skills when the user's request matches."
77
}
88
]
99
}

docs/abca-plugin/skills/status/SKILL.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -50,3 +50,5 @@ Build: [PASS | FAIL with error summary]
5050
```
5151

5252
If the CLI isn't configured, note this and suggest running the `setup` skill.
53+
54+
**Tip:** For real-time streaming of a specific task's progress, suggest `bgagent watch <TASK_ID>` instead of polling status.

docs/abca-plugin/skills/submit-task/SKILL.md

Lines changed: 17 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -103,6 +103,7 @@ node cli/lib/bin/bgagent.js submit \
103103
- `--max-turns N` — Turn limit (1-500)
104104
- `--max-budget N` — USD cost limit ($0.01-$100)
105105
- `--idempotency-key KEY` — Deduplication key for safe retries
106+
- `--trace` — Enable detailed tracing (4 KB preview cap + full NDJSON trajectory upload to S3)
106107
- `--wait` — Poll until terminal status
107108
- `--output json|text` — Output format
108109

@@ -122,12 +123,26 @@ curl -X POST "$API_URL/tasks" \
122123
}'
123124
```
124125

125-
## Step 6: Monitor
126+
## Step 6: Monitor and Interact
126127

127-
After submission, show how to check status:
128+
After submission, show how to monitor and steer the task:
128129
```bash
130+
# Watch progress in real time (adaptive polling, auto-exits on terminal state)
131+
node cli/lib/bin/bgagent.js watch <TASK_ID>
132+
133+
# Check status snapshot
129134
node cli/lib/bin/bgagent.js status <TASK_ID>
135+
136+
# Steer the agent mid-run (combined-turn acknowledgement)
137+
node cli/lib/bin/bgagent.js nudge <TASK_ID> "Focus on the auth module first"
138+
139+
# View event log
130140
node cli/lib/bin/bgagent.js events <TASK_ID>
141+
142+
# Download execution trace (requires --trace on submit)
143+
node cli/lib/bin/bgagent.js trace download <TASK_ID>
144+
145+
# List running tasks
131146
node cli/lib/bin/bgagent.js list --status RUNNING
132147
```
133148

docs/abca-plugin/skills/troubleshoot/SKILL.md

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -176,13 +176,21 @@ aws cloudformation describe-stacks --stack-name backgroundagent-dev --query 'Sta
176176
# Stack outputs
177177
aws cloudformation describe-stacks --stack-name backgroundagent-dev --query 'Stacks[0].Outputs' --output table
178178
179-
# Task status
180-
node cli/lib/bin/bgagent.js status <TASK_ID>
179+
# Task status (use --verbose for HTTP-level debug output)
180+
node cli/lib/bin/bgagent.js --verbose status <TASK_ID>
181181
node cli/lib/bin/bgagent.js events <TASK_ID> --output json
182182
183+
# Watch task progress in real time
184+
node cli/lib/bin/bgagent.js watch <TASK_ID>
185+
186+
# Download full execution trace (task must have been submitted with --trace)
187+
node cli/lib/bin/bgagent.js trace download <TASK_ID>
188+
183189
# List running tasks
184190
node cli/lib/bin/bgagent.js list --status RUNNING
185191
186192
# Build health
187193
mise run build
188194
```
195+
196+
**Tip:** Add `--verbose` to any `bgagent` command to see the full HTTP request/response cycle on stderr. This is the fastest way to diagnose auth, network, or API contract issues.

docs/backlog/CLI_COGNITO_NEW_PASSWORD_CHALLENGE.md

Lines changed: 0 additions & 177 deletions
This file was deleted.

0 commit comments

Comments
 (0)