Skip to content

usage.md

Latest commit

 

History

History
138 lines (93 loc) · 2.79 KB

usage.md

File metadata and controls

138 lines (93 loc) · 2.79 KB
Raw

BBMstack Usage Guide

This guide answers the practical question: after installation, how should a developer actually use BBMstack day to day?

Typical First Session

After installing BBMstack and adding .bbmstack.json to the project:

bbmstack source sync
bbmstack activate
bbmstack check

Then restart Claude Code or Codex if the new skills do not appear immediately.

Which Command to Use First

Use these as your default entrypoints:

  • /plan when the work is still vague or the architecture is not locked
  • /debug when something is broken and you need root cause analysis
  • /qa when you want browser-driven testing and fixes
  • /review when you want a paranoid pre-merge check
  • /ship when work is complete and you want to verify and prepare it for release
  • /verify when you need explicit completion checks before claiming something is done

Recommended Workflow

For most feature work:

  1. Start with /plan
  2. Implement the work
  3. Run /review
  4. Run /qa if the change affects user-facing behavior
  5. Run /ship or /verify

For debugging:

  1. Start with /debug
  2. Fix the issue
  3. Run /review
  4. Run /verify

For browser-heavy work:

  1. Use /setup-browser if auth cookies are needed
  2. Use /browse for manual browser investigation
  3. Use /qa for systematic testing

Common Flows

New feature

/plan → implement → /review → /qa → /ship

Bug fix

/debug → implement fix → /review → /verify

Refactor

/plan → implement → /review → /verify

Onboard to an unfamiliar repo

bbmstack source sync → bbmstack activate → /plan or /review

Working With Public and Private Sources

If your project uses only public sources:

cp ~/Dev/BBMstack/examples/bbmstack.json .bbmstack.json
bbmstack source sync
bbmstack activate

If your project also uses a private source:

cp ~/Dev/BBMstack/examples/bbmstack.private.json .bbmstack.json
bbmstack source sync
bbmstack activate

If the private source cannot be cloned, BBMstack will continue with public sources and report the private source as missing.

Inspecting State

Resolve source state:

bbmstack source list

Sync enabled sources:

bbmstack source sync

Activate configured packs:

bbmstack activate

Check installation and project status:

bbmstack check

Team Guidance

For new developers, the minimum useful onboarding is:

  1. Install BBMstack
  2. Add the project .bbmstack.json
  3. Run bbmstack source sync
  4. Run bbmstack activate
  5. Start with /plan, /debug, /qa, /review, or /ship

This avoids spending the first hour teaching the agent your workflow from scratch.

Related Docs