Skip to content

docs(plugin): flip CLI examples to v2 short form#6

Merged
trevormil merged 1 commit into
masterfrom
docs/cli-v2-short-form
May 14, 2026
Merged

docs(plugin): flip CLI examples to v2 short form#6
trevormil merged 1 commit into
masterfrom
docs/cli-v2-short-form

Conversation

@trevormil

Copy link
Copy Markdown
Contributor

Summary

  • Drop the bb cli infix from every plugin page, skill, agent, and slash command — examples now use bb <cmd> directly per the CLI v2 redesign locked on 2026-05-14 (autopilot ticket #0399, design doc outputs/flagship-plans/cli-v2-design.md).
  • Apply the v2 rename table inside both code blocks and prose: portfolioaccount (absorbs address convert/validate, lookup, alias, gen-list-id), configsettings, tools/tool + resources/docs/skills/gen-pub-key moved under dev, swap pools / swap asset-pairs promoted to top-level pools / pairs, and sign-with-browser + gen-tx-payload folded into bb deploy --browser / bb deploy --gen-payload.
  • README's "Two entrypoints" section now documents the flat surface plus a deprecation runway note: bb cli <cmd> keeps working for one release with a stderr banner, suppressed by BB_QUIET=1.

Signing stays as bb deploy --<method> flags — no bb sign <method> subcommand was introduced anywhere. No semantic or behavioral changes; invocation form only. This PR is one of the doc sweeps that backs the SDK + chain binary implementation PRs being opened against bitbadgesjs and bitbadgeschain for ticket #0399.

Files changed (13)

  • README.md
  • CHANGELOG.md
  • agents/bitbadges-builder.md
  • commands/setup.md, commands/status.md
  • skills/address/SKILL.md
  • skills/broadcast/SKILL.md
  • skills/build/SKILL.md
  • skills/claim/SKILL.md
  • skills/explain/SKILL.md
  • skills/query/SKILL.md
  • skills/review/SKILL.md
  • skills/simulate/SKILL.md

Test plan

  • Skim every changed page in rendered Markdown to confirm command tables and code blocks read cleanly.
  • Confirm no bb cli <cmd> invocations remain outside the README deprecation row and the CHANGELOG entry that documents the runway.
  • Confirm signing still surfaces only as bb deploy --browser / --burner / --with-keyring / --gen-payload (no bb sign <method> anywhere).
  • Spot-check that /bitbadges:setup still references bitbadgeschaind / bitbadges-cli for PATH checks (correct — those are the underlying binary names users install).
  • Hold for merge until the matching SDK + chain binary PRs for ticket #0399 land and the v2 commands are reachable in a released CLI.

DO NOT MERGE until the SDK rollout for #0399 lands — per feedback_pr_merge_rules no auto-merge, and per feedback_one_pr_per_repo_for_refactors this is the plugin-side slice of the multi-repo refactor.

Drop the `bb cli` infix from every plugin page, skill, agent, and
slash command per the CLI v2 redesign locked on 2026-05-14
(autopilot ticket #0399, outputs/flagship-plans/cli-v2-design.md).

Applied renames inside both prose and code blocks:

- `bb cli <anything>` → `bb <anything>`
- `bb cli portfolio` → `bb account` (absorbs `address convert/validate`,
  `lookup`, `alias`, `gen-list-id` as subcommands)
- `bb cli config` → `bb settings`
- `bb cli tool[s]` / `resources` / `docs` / `skills` / `gen-pub-key`
  → `bb dev <subcmd>`
- `bb cli swap pools` / `bb cli swap asset-pairs`
  → `bb pools` / `bb pairs`
- `sign-with-browser` and `gen-tx-payload` folded into
  `bb deploy --browser` / `bb deploy --gen-payload`
- `bb cli <standard> build` (per-standard builders) → `bb build <type>`
- Underlying `bitbadges-cli <subcmd>` invocations in skill examples
  flipped to `bb <subcmd>` (binary names retained only where the
  reader must know them to install or troubleshoot — README intro
  + `/bitbadges:setup` PATH check)

Signing stays as `bb deploy --<method>` flags (no `bb sign <method>`
subcommands per the locked decisions). The deprecated `bb cli` form
keeps working for one release with a stderr deprecation banner;
README now calls that out, and `BB_QUIET=1` suppresses the banner.

No semantic / behavioral changes — invocation form only. Backs the
implementation that lands in the bitbadgesjs SDK + bitbadgeschain
PRs for ticket #0399.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@trevormil
trevormil merged commit 2db5ca2 into master May 14, 2026
1 check passed
@trevormil
trevormil deleted the docs/cli-v2-short-form branch May 14, 2026 18:51
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.

1 participant