bazelbuild / bazelbuild/bazelisk
What does "Install it as the `bazel` binary in your PATH" actually mean?
- Dominant language
- Go
- Stars
- 2.7k
- Forks
- 424
- PR merge metrics
- No merged PRs in 30d
Description
For non-english speaking people like me this sentence in the README makes little bit a confusion.
Should i install `bazelisk` with `go get github.com/bazelbuild/bazelisk` and rename the `bazelisk` binary in my `$GOPATH/bin` to `bazel` and i should make sure the old `bazel` binary is removed from the system?
Or i should make an alias `alias bazel='bazelisk'` in my `.profile` or `.zprofile`?
For sure, i got it working, but just want to clarify the actual meaning of the:
>Install it **as the** `bazel` binary
Example like:
```sh
sudo wget -O /usr/local/bin/bazel https://github.com/bazelbuild/bazelisk/releases/latest/download/bazelisk-linux-amd64
sudo chmod +x /usr/local/bin/bazel
```
could be really nice.
Contributor guide
Research direction
Update the README sentence about installing Bazelisk as the `bazel` binary. Start by reviewing the surrounding installation instructions and the proposed `/usr/local/bin/bazel` commands, then clarify whether renaming the binary or using an alias is intended. Done means a non-English-speaking newcomer can follow the documented steps without ambiguity.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- go, shell
- Domain
- cli, documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 45/100