docs: add CodeBuddy CLI installation section to README#1500
Open
m9rco wants to merge 1 commit into
Open
Conversation
Owner
|
Hi, would you mind retargeting the dev branch instead of main and I don't think we want harness specific test instructions that are really the same test instruction. |
Author
|
Okay, got it. I split it into two MRs due to issues with hook script installation. :) |
CodeBuddy CLI v1.16.0+ ships full Claude Code Hooks compatibility,
including support for ${CLAUDE_PLUGIN_ROOT} and .claude-plugin/.
Superpowers' existing plugin layout already works on CodeBuddy via
native skill auto-invocation (verified with the project's standard
acceptance test), but README had no entry point documenting this.
Adds a CodeBuddy CLI install section modeled after GitHub Copilot
CLI, plus a CodeBuddy CLI link in the README quickstart anchor list.
No code changes; SessionStart hook loading on CodeBuddy is a
separate problem deferred to a follow-up PR per "one problem per PR".
Co-authored-by: Cursor <cursoragent@cursor.com>
6346f35 to
7074b79
Compare
Author
|
Updated per your review:
Final diff: Sorry for the closed/reopen churn — hook-script work is being split off into a separate PR as planned. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Update (2026-05-21)
Re-targeting this PR at
devand removing the harness-specific verify step per @obra's review feedback (comment). README now adds only the install commands for CodeBuddy CLI, positioned alphabetically betweenClaude CodeandCodex Appto match upstream/dev's existing ordering. Final diff:+15 / -1, README.md only.The PlanMode-trap context below is preserved for historical accuracy of the original investigation, but the README no longer contains the verify/warning text it references.
What problem are you trying to solve?
I am a daily user of CodeBuddy CLI (Claude-Code-compatible coding agent). I expected Superpowers to "just work" via CodeBuddy's documented Claude Code Hooks compatibility (CodeBuddy CLI v1.16.0+ implements the full Claude Code Hooks spec, supports
${CLAUDE_PLUGIN_ROOT}, and recognizes.claude-plugin/directories per its official compatibility documentation). The installation experience left me stuck because:README has no entry point for CodeBuddy users. Among 8 supported harnesses listed, CodeBuddy is absent. I had to reverse-engineer the install command from the Claude Code section.
First attempted session failed mysteriously due to a CodeBuddy-specific trap. When I sent "Let's make a react todo list" in my first CodeBuddy session, the agent went into CodeBuddy's built-in PlanMode (toggled with Tab), not Superpowers'
brainstormingskill:I mistakenly believed Superpowers wasn't installed.
After clearing PlanMode and starting a fresh session,
brainstormingauto-triggered correctly:So the integration already works at the code level via CodeBuddy's native skill auto-invocation — what's missing is README documentation telling CodeBuddy users (a) it's supported and (b) the install command.
What does this PR change?
Adds a
### CodeBuddy CLIinstallation section toREADME.md, inserted alphabetically between### Claude Codeand### Codex Appto match the strict alphabetical ordering already established ondev. Adds the corresponding[CodeBuddy CLI](#codebuddy-cli)entry in the README quickstart anchor list, also alphabetically positioned. No code changes, no new files, no changes to skills/hooks/plugin manifests. Single file diff:+15 / -1.The harness-specific verify step / PlanMode warning from the original revision has been removed per maintainer feedback — every other harness section is install-only, and this section now matches that convention.
Is this change appropriate for the core library?
Yes.
README.mdalready documents installation entry points for 9 harnesses ondev(Claude Code, Codex App, Codex CLI, Cursor, Factory Droid, Gemini CLI, GitHub Copilot CLI, OpenCode, Pi). CodeBuddy CLI joins as the 10th — pure documentation increment with identical structural treatment. Not a third-party promotion: CodeBuddy's Claude Code Hooks compatibility is a unilateral choice by CodeBuddy team to align with Anthropic's Claude Code spec, and Superpowers' existing plugin layout works there unchanged.Does this PR contain multiple unrelated changes?
No. Single concern: README adds one more harness installation section. SessionStart hook investigation remains deferred to a separate follow-up per "one problem per PR".
Environment tested
Host OS: macOS 14.7.3 (build 23H417), shell zsh.
New harness support (required if this PR adds a new harness)
This PR is on the boundary: code-level support already exists in upstream CodeBuddy CLI v1.16.0+ (no Superpowers code change needed). The "newness" is README documentation only.
The acceptance test from the PR template — "Let's make a react todo list" auto-triggers
brainstormingin a clean session — passes via CodeBuddy's native skill auto-invocation:Clean-session transcript for "Let's make a react todo list"
The
brainstormingskill not only triggered but loaded its body and executed the workflow (initial codebase exploration, recognition that this is a plugin repo not a target project, offer of the visual brainstorming companion).For honesty, I had a prior failed session caused by CodeBuddy's built-in PlanMode being toggled on, which intercepts skill auto-invocation. This was the original motivation for adding a verify step to the README; per maintainer feedback that harness-specific verify steps don't belong in README, that text has been removed from this PR.
Failed session transcript (PlanMode interception, before PlanMode toggled off)
Note: the failure case shows CodeBuddy's built-in PlanMode flow ("CodeBuddy is now exploring and designing"), distinct from
Skill(brainstorming)invocation.Evaluation
brainstormingauto-triggered, loaded the skill body, began the workflow (initial clarifying question, codebase exploration vialsandpackage.jsonread, visual-brainstorming companion offer), with PlanMode confirmed off. I have not independently re-verified in additional working directories within this PR cycle.Rigor
If this is a skills change: I used
superpowers:writing-skillsand completed adversarial pressure testing (paste results below)N/A — no skill content modified.
This change was tested adversarially, not just on the happy path
First session unintentionally hit the PlanMode auto-trap (real failure, not contrived). Subsequent fresh session with PlanMode off triggered
brainstormingand executed the skill workflow correctly.I did not modify carefully-tuned content (Red Flags table, rationalizations, "human partner" language) without extensive evals
N/A — README only.
Known limitations & follow-up
CodeBuddy CLI does not load plugin-level
SessionStarthooks declared inhooks/hooks.json.--debugconfirms zero hook activity, and/hookspanel shows "No matchers configured yet" even with the plugin enabled. As a result, theusing-superpowersbootstrap (theframing) is not injected at session start in CodeBuddy.This does not break the acceptance test, because CodeBuddy's native skill auto-invocation triggers
brainstormingfrom the skill's owndescriptionfrontmatter alone. But it does mean the bootstrap-driven behavior reinforcement that other harnesses receive is missing on CodeBuddy.I will investigate and propose a fix in a separate PR per "one problem per PR". This PR does not block on that.
Human review