Skip to content

Commit 3a7df00

Browse files
committed
Update README
1 parent 5025162 commit 3a7df00

File tree

1 file changed

+9
-8
lines changed

1 file changed

+9
-8
lines changed

README.md

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title: Aspect CLI
33
sidebar_label: Overview
44
---
55

6-
Aspect CLI (`aspect`) is a drop-in replacement for the CLI that comes with [Bazel](http://bazel.build) that adds additional features and extensibility to the popular polyglot build system from Google.
6+
Aspect CLI (`aspect`) is wrapper for [Bazel], built on top of [Bazelisk], that adds additional features and extensibility to the popular polyglot build system from Google.
77

88
# Why Aspect CLI?
99

@@ -35,19 +35,19 @@ We intend for Aspect CLI to remain free for individuals (only for personal use),
3535

3636
### Bazelisk (MacOS / Linux)
3737

38-
Aspect CLI OSS can be installed in an existing Bazel workspace using [bazelisk].
38+
Aspect CLI OSS can be installed in an existing Bazel workspace using [Bazelisk].
3939

4040
> [!NOTE]
4141
> This approach doesn't provide the `aspect init` command, which has to run outside a Bazel workspace.
4242
4343
From the [OSS releases page](https://github.com/aspect-build/aspect-cli/releases),
44-
copy the `.bazeliskrc` snippet into your `.bazeliskrc` file to install Aspect for all developers in the target repository.
44+
copy the `.bazeliskrc` snippet into your `.bazeliskrc` file to install Aspect CLI OSS for all developers in the target repository.
4545

4646
The underlying version of Bazel can be configured in your `.bazelversion` file or the `BAZEL_VERSION` environment variable.
4747

4848
### Manual (MacOS / Linux)
4949

50-
On any platform, you can download the Aspect CLI OSS `aspect` binary for your platform on our
50+
On MacOS and Linux, you can download the Aspect CLI OSS `aspect` binary for your platform on our
5151
[Releases](https://github.com/aspect-build/aspect-cli/releases) page and add it to your `PATH` manually.
5252

5353
Note, if you manually install for MacOS, you can bypass the "Unknown Developer" dialog by running
@@ -63,16 +63,16 @@ To install the Aspect CLI on MacOS, you can run
6363
% brew install aspect-build/aspect/aspect
6464
```
6565

66-
This installs the `aspect` command and also links it to `bazel`, just like the [bazelisk] installer does.
66+
This installs the `aspect` command and also links it to `bazel`, just like the [Bazelisk] installer does.
6767

6868
### Bazelisk (MacOS / Linux)
6969

70-
Aspect CLI can be installed in an existing Bazel workspace using [bazelisk].
70+
Aspect CLI can be installed in an existing Bazel workspace using [Bazelisk].
7171

7272
> [!NOTE]
7373
> This approach doesn't provide the `aspect init` command, which has to run outside a Bazel workspace.
7474
75-
Configure [bazelisk](https://github.com/bazelbuild/bazelisk) to use the Aspect CLI for all developers in a repository
75+
Configure [Bazelisk](https://github.com/bazelbuild/bazelisk) to use the Aspect CLI for all developers in a repository
7676
by adding the following to \`.bazeliskrc\` in the repository root:
7777

7878
```
@@ -126,4 +126,5 @@ Aspect CLI is built by [Aspect](http://aspect.build).
126126

127127
See our website at <http://aspect.build> to learn more about our product offerings.
128128

129-
[bazelisk]: https://github.com/bazelbuild/bazelisk
129+
[Bazel]: http://bazel.build
130+
[Bazelisk]: https://github.com/bazelbuild/bazelisk

0 commit comments

Comments
 (0)