-
Notifications
You must be signed in to change notification settings - Fork 20
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs(cli): update README with generate cmd
- Loading branch information
Showing
1 changed file
with
27 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -19,7 +19,7 @@ git clone [email protected]:chainbound/bolt.git | |
cd bolt-cli | ||
|
||
# build and install the binary on your machine | ||
cargo install --path . --force | ||
cargo install --path . --force --locked | ||
|
||
# test the installation | ||
bolt --version | ||
|
@@ -34,6 +34,7 @@ Available commands: | |
- [`send`](#send) - Send a preconfirmation request to a Bolt sidecar. | ||
- [`validators`](#validators) - Subcommand for bolt validators. | ||
- [`operators`](#operators) - Subcommand for bolt operators. | ||
- [`generate`](#generate) - Subcommand for generating bolt related data. | ||
|
||
--- | ||
|
||
|
@@ -342,6 +343,31 @@ Options: | |
|
||
--- | ||
|
||
### `generate` | ||
|
||
The `generate` subcommand contains functionality for generating bolt related data like BLS keypairs. | ||
|
||
<details> | ||
<summary>Usage</summary> | ||
|
||
```text | ||
❯ bolt generate --help | ||
Useful data generation commands | ||
Usage: bolt generate <COMMAND> | ||
Commands: | ||
bls Generate a BLS keypair | ||
help Print this message or the help of the given subcommand(s) | ||
Options: | ||
-h, --help Print help | ||
``` | ||
|
||
</details> | ||
|
||
--- | ||
|
||
## Security | ||
|
||
The Bolt CLI is designed to be used offline. It does not require any network connections | ||
|