Skip to content

fix(help): tell users where to run /buddy CLI commands from - #112

Open
grlee wants to merge 1 commit into
ramarivera:mainfrom
grlee:fix/cli-help-discoverability
Open

fix(help): tell users where to run /buddy CLI commands from#112
grlee wants to merge 1 commit into
ramarivera:mainfrom
grlee:fix/cli-help-discoverability

Conversation

@grlee

@grlee grlee commented Apr 25, 2026

Copy link
Copy Markdown
Contributor

Problem

/buddy help lists CLI commands like:

CLI:
  bun run help            Show full CLI help
  bun run show            Display buddy in terminal
  bun run pick            Interactive buddy picker
  ...

…but never tells users where to run them from. The plugin lives at:

~/.claude/plugins/cache/claude-buddy/claude-buddy/<version>/

which isn't an obvious location. Running bun run show from any other directory fails with a confusing error: Script not found "show" error from bun, leaving users wondering whether the install is broken.

Fix

Replaces the bare "CLI:" header in the help text with a hint that includes a path-finder one-liner:

CLI (run from the plugin directory — find it with:
         cd "$(ls -d ~/.claude/plugins/cache/claude-buddy/claude-buddy/*/ | tail -1)"):

  bun run help            Show full CLI help
  ...

3 lines added, 1 line removed. No code-path changes — just the static help string. The path uses ~/.claude because that's the default the rest of the plugin already assumes; users who relocate Claude Code's config via $CLAUDE_CONFIG_DIR can substitute their own path.

Verification

  • bun run typecheck passes.
  • bun test passes — 246/246 tests.
  • Help-text rendering preview was sanity-checked manually:
  /buddy statusline Enable or disable buddy in the status line

CLI (run from the plugin directory — find it with:
         cd "$(ls -d ~/.claude/plugins/cache/claude-buddy/claude-buddy/*/ | tail -1)"):

  bun run help            Show full CLI help

Out of scope

  • Suggesting a shell alias to make CLI commands runnable from anywhere — punted for portability reasons (bash/zsh/fish/nu/PowerShell all differ). Happy to add as a follow-up if you want, scoped to a single shell at a time.
  • Changing how the plugin is invoked (e.g., installing a buddy binary on PATH). Larger architectural change, separate concern.

The /buddy help output lists CLI commands as `bun run show`, `bun run pick`,
etc., but never tells users where to run them from. The plugin lives in
~/.claude/plugins/cache/claude-buddy/claude-buddy/<version>/, which is not
an obvious location, and running `bun run <cmd>` from outside that directory
fails with a confusing "no script named X" error.

Replaces the bare "CLI:" header with a hint that includes a path-finder
one-liner so users can cd into the plugin directory first:

    cd "$(ls -d ~/.claude/plugins/cache/claude-buddy/claude-buddy/*/ | tail -1)"

The hint respects $CLAUDE_CONFIG_DIR via the ~/.claude default that the rest
of the plugin already assumes; users who relocate Claude Code's config can
substitute their own path.

No code-path changes; only the static help-text string.

Signed-off-by: George Lee <grlee@users.noreply.github.com>
@grlee
grlee force-pushed the fix/cli-help-discoverability branch from bd370e9 to f443b77 Compare June 10, 2026 11:54
@ramarivera

Copy link
Copy Markdown
Owner

Hey @grlee — good catch on the discoverability gap, and the fix is the right shape. One thing before merge: the project was just renamed (claude-buddy → coding-buddy, now also shipping Pi / Oh My Pi extensions), so the cache path in the new help text is stale. Could you update it to:

cd "$(ls -d ~/.claude/plugins/cache/coding-buddy/coding-buddy/*/ | tail -1)"

Once that's updated this is good to go.

🤖 Created with the help of AI (Claude Fable 5).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants