Skip to content

Docs: surface bwcli attach + screenshot capabilities in README #68

@deftio

Description

@deftio

Summary

The bwcli attach subcommand with its REPL and screenshot capabilities is a major differentiator vs plain npx serve, but the README doesn't surface this well. Users may not realize bwcli can:

  • Remote-debug any page it serves via bwcli attach
  • Take element-level screenshots (/screenshot .my-component card.png)
  • Take page-level screenshots (/screenshot body page.png)
  • Inspect DOM, patch elements, listen to events — all from the terminal

The --help output documents these features well, but the GitHub README (which is most users' first touchpoint) buries them.

Suggested improvements

  1. README.md — Add a dedicated "Remote Debugging & Screenshots" section (or similar) near the top feature list, with examples like:

    bwcli attach --allow-screenshot
    bw> /screenshot body page.png        # full-page capture
    bw> /screenshot .my-card card.png    # element-level capture
    bw> /inspect #app 2                  # DOM tree summary
    
  2. README.md — In the intro/tagline, position bwcli as more than a file converter — emphasize it as a dev server with remote debugging (a better npx serve).

  3. README.md — Link to docs/bw-attach.md prominently from the feature list.

Context

The CLI help (bwcli attach --help) already has excellent documentation of REPL commands and workflows. The gap is just in the README discoverability.

🤖 Generated with Claude Code

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions