README
¶
title: Aspect CLI sidebar_label: Overview
The aspect CLI is a drop-in replacement for the bazel CLI that comes with Bazel.
Why Aspect CLI
Every organization has a different engineering culture and developer stack.
Bazel was designed for Google's workflows, not yours.
Many companies have found they have to write a wrapper around Bazel.
This starts out as a small need to shim something in the developer workflow, and is often an
untested Bash script living in /tools/bazel which Bazelisk understands as a wrapper script.
Over time, the wrapper accumulates more code, and is a constant source of developer distress.
See more on our product webpage: https://aspect.build/cli
Installation
Homebrew (MacOS)
On MacOS, you can run
% brew install aspect-build/aspect/aspect
This installs the aspect command and also links it to bazel, just like the bazelisk installer does.
We plan to have a standard "core" homebrew formula so this will just be
brew install aspectin the future.
Bazelisk (MacOS / Linux)
On any platform, so long as you already have bazelisk installed, you can have bazelisk
install the Aspect CLI just like it can install the standard Bazel CLI.
Add this to your .bazeliskrc in your project folder to install Aspect for all developers:
From the release you wish to use: https://github.com/aspect-build/aspect-cli/releases copy the .bazeliskrc snippet
into your .bazeliskrc file to install Aspect for all developers in this repository.
Note that in all cases, the .bazelversion file continues to indicate which version of the
Bazel tool is fetched and run beneath the wrapper.
Manual (MacOS / Linux)
On any platform, you can download the aspect binary for your platform on our
Releases page and add it to your PATH manually.
Note, if you manually install for MacOS, you can bypass the "Unknown Developer" dialog by running
xattr -c $(which aspect) before launching aspect.
Windows
Windows releases are no longer published as of v5.5.0. This is due to a new dependency on go-tree-sitter which has a CGO dependency that makes cross compiling to Windows difficult.
To produce Windows releases will require some engineering work to resolve the CGO cross compilation issues. Please let us know if you require a Windows Aspect CLI binary. In the meantime, we recommend using WSL2 on Windows.
Usage
Just run aspect help to see the available commands.
Some are the standard ones you know from Bazel, and others are new, such as print and docs.
Write a plugin
Aspect's plugin system allows you to fit Bazel into your team's development process, with custom commands, behaviors, and integrations.
A plugin is any program (written in any language) that serves our gRPC protocol. The easiest way to get started is to clone our starter template repo.
See the Plugin Documentation for more information on how to write a plugin.
Need help or having issues?
If you think you've hit a bug please file a Bug Report.
You can also find us on Bazel Slack on the #aspect-dev channel.
For Enterprise
Aspect CLI is built by Aspect.
If your organization needs more help to make your Bazel migration a success, come find us at aspect.dev
See our website at http://aspect.build to learn more about our product offerings.
Directories
¶
| Path | Synopsis |
|---|---|
|
bazel
|
|
|
Variables in this file will be replaced by the linker when Bazel is run with --stamp The time should be in format '2018-12-12 12:30:00 UTC' The GitStatus should be either "clean" or "dirty" Release will be a comma-separated string representation of any tags.
|
Variables in this file will be replaced by the linker when Bazel is run with --stamp The time should be in format '2018-12-12 12:30:00 UTC' The GitStatus should be either "clean" or "dirty" Release will be a comma-separated string representation of any tags. |
|
cmd
|
|
|
docs
|
|
|
bazelrc
Package bazelrc contains only generated files.
|
Package bazelrc contains only generated files. |
|
help/topics
Package help contains only embedded files.
|
Package help contains only embedded files. |
|
gazelle
|
|
|
bzl
Package bzl generates a `bzl_library` target for every `.bzl` file in each package.
|
Package bzl generates a `bzl_library` target for every `.bzl` file in each package. |
|
pkg
|
|
|
aspect/configure
Command gazelle is a BUILD file generator for Go projects.
|
Command gazelle is a BUILD file generator for Go projects. |
|
aspect/configure/internal/wspace
Package wspace provides functions to locate and modify a bazel WORKSPACE file.
|
Package wspace provides functions to locate and modify a bazel WORKSPACE file. |
|
aspect/init/template
Package template contains only embedded files.
|
Package template contains only embedded files. |
|
aspect/query/shared/mock
Package mock contains generated files.
|
Package mock contains generated files. |
|
aspectgrpc/mock
Package mock contains generated files.
|
Package mock contains generated files. |
|
bazel/mock
Package mock contains generated files.
|
Package mock contains generated files. |
|
bazel/workspace/mock
Package mock contains generated files.
|
Package mock contains generated files. |
|
osutils/filesystem/mock
Package mock contains generated files.
|
Package mock contains generated files. |
|
plugin/client/mock
Package mock contains generated files.
|
Package mock contains generated files. |
|
plugin/sdk/v1alpha1/plugin
grpc.go hides all the complexity of doing the gRPC calls between the aspect Core and a Plugin implementation by providing simple abstractions from the point of view of Plugin maintainers.
|
grpc.go hides all the complexity of doing the gRPC calls between the aspect Core and a Plugin implementation by providing simple abstractions from the point of view of Plugin maintainers. |
|
plugin/sdk/v1alpha2/plugin
grpc.go hides all the complexity of doing the gRPC calls between the aspect Core and a Plugin implementation by providing simple abstractions from the point of view of Plugin maintainers.
|
grpc.go hides all the complexity of doing the gRPC calls between the aspect Core and a Plugin implementation by providing simple abstractions from the point of view of Plugin maintainers. |
|
plugin/sdk/v1alpha2/plugin/mock
Package mock contains generated files.
|
Package mock contains generated files. |
|
plugin/sdk/v1alpha3/plugin
grpc.go hides all the complexity of doing the gRPC calls between the aspect Core and a Plugin implementation by providing simple abstractions from the point of view of Plugin maintainers.
|
grpc.go hides all the complexity of doing the gRPC calls between the aspect Core and a Plugin implementation by providing simple abstractions from the point of view of Plugin maintainers. |
|
plugin/sdk/v1alpha3/plugin/mock
Package mock contains generated files.
|
Package mock contains generated files. |
|
plugin/sdk/v1alpha4/plugin
grpc.go hides all the complexity of doing the gRPC calls between the aspect Core and a Plugin implementation by providing simple abstractions from the point of view of Plugin maintainers.
|
grpc.go hides all the complexity of doing the gRPC calls between the aspect Core and a Plugin implementation by providing simple abstractions from the point of view of Plugin maintainers. |
|
plugin/sdk/v1alpha4/plugin/mock
Package mock contains generated files.
|
Package mock contains generated files. |
|
plugin/system/bep/mock
Package mock contains generated files.
|
Package mock contains generated files. |
|
plugin/system/besproxy/mock
Package mock contains generated files.
|
Package mock contains generated files. |
|
plugin/system/mock
Package mock contains generated files.
|
Package mock contains generated files. |
|
stdlib/mock
Package mock contains generated files.
|
Package mock contains generated files. |
|
release
|
|