Skip to content

Commit

Permalink
chore: rename to bzlcmd + readme update (#5)
Browse files Browse the repository at this point in the history
  • Loading branch information
zaucy authored Sep 14, 2023
1 parent b373d70 commit f8eab26
Show file tree
Hide file tree
Showing 2 changed files with 36 additions and 4 deletions.
2 changes: 1 addition & 1 deletion MODULE.bazel
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
module(
name = "bzlreg",
name = "bzlcmd",
version = "0.1.0",
compatibility_level = 1,
)
Expand Down
38 changes: 35 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,37 @@
# bazel registry command line tool
# bzlcmd - CLI tools for bazel projects

Simple command line tool for managing a bazel registry.
## bzlmod

WORK IN PROGRESS
Create a simple `MODULE.bazel` file and some other bazel files to get you started.

```sh
bzlmod init
```

Add a dependency to your bazel module file with ease! Correctly checks third party dependencies configured in your `.bazelrc` files as well.

```sh
bzlmod add rules_cc
```

`MODULE.bazel` after command:

```diff
module(name = "my_cool_module")

+bazel_dep(name = "rules_cc", version = "0.0.8")
```

## bzlreg

Create file and folder structure required for a [bazel registry](https://bazel.build/external/registry).

```sh
bzlreg init
```

Add a bazel module from it's archive to the registry.

```
bzlreg add-module http://example.com/some/targz/archive.tar.gz
```

0 comments on commit f8eab26

Please sign in to comment.