Skip to content

Commit

Permalink
docs(cli): update README with generate cmd
Browse files Browse the repository at this point in the history
  • Loading branch information
mempirate committed Dec 6, 2024
1 parent 5770183 commit 5f2fe1e
Showing 1 changed file with 27 additions and 1 deletion.
28 changes: 27 additions & 1 deletion bolt-cli/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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.

---

Expand Down Expand Up @@ -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
Expand Down

0 comments on commit 5f2fe1e

Please sign in to comment.