Improve browser4-cli --help.

Open Beginner friendly
#642 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
1/5
Estimated time
Under an hour
Newbie friendliness
67/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Active
Tech stack
kotlin
Domain
cli

Research direction

Find the source that builds the browser4-cli --help text and check whether source code is present before showing the development command. Update the displayed dev command to use b4w instead of the cargo run --manifest-path ... form. Done when the help omits dev mode without source code and shows the b4w command when source code is available.

Written by the indexing model from the issue text.

Description

The help should be improved:

  Git Bash / MSYS (Windows): invoke the CLI as `./b4w.sh <command>`, or prefix
  MSYS2_ARG_CONV_EXCL='*' — MSYS rewrites a '/' -leading argument into a Windows path
  before the CLI starts. Slash-leading values can also be written without the leading
  slash (e.g. -olp "product/" instead of -olp "/product/"; a cookie --path / is the
  default and can be omitted).
Dev mode: cargo run --manifest-path cli/browser4-cli/Cargo.toml -- <command>
  1. do not show dev mode if there is no source code
  2. use b4w for dev mode instead of cargo run --manifest-path cli/browser4-cli/Cargo.toml
Dominant language
Kotlin
Stars
1.2k
Forks
152
Avg merge
1h 14m
Merged PRs (30d)
1

Getting set up

  • Ships a Dockerfile or Docker Compose file
  • No pull request template
  • No contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from platonai/Browser4

All issues in platonai/Browser4

Similar issues

More Kotlin issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.