miden-client-cli 0.13.1

The official command line client for interacting with the Miden network
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48

# Miden client CLI

This binary allows the user to interact with the Miden rollup via a simple command-line interface (CLI). It's a wrapper around the [Miden client](https://crates.io/crates/miden-client) library exposing its functionality in order to create accounts, create and consume notes, all executed and proved using the Miden VM.

## Usage

Before you can use the Miden client, you'll need to make sure you have both [Rust](https://www.rust-lang.org/tools/install) and SQLite3 installed. Miden client requires rust version **1.88** or higher.

### Running `miden-client`'s CLI

You can either build from source with:

```bash
cargo build --release --locked
```

Once the binary is built, you can find it on `./target/release/miden-client`.

Or you can install the CLI from crates.io with:

```bash
cargo install miden-client-cli --locked
```

These actions can also be executed when inside the repository via the Makefile with `make build` or `make install`.

### Using the CLI

To have a fully-functional client CLI, you would need to set it up first. You can accomplish that with:

```sh
miden-client init --network {localhost/devnet/testnet/custom_rpc_endpoint}
```

This would generate the `miden-client.toml` file, which contains useful information for the client like RPC provider's URL and database path.

After this, your client should be set and ready to use. Get the available commands with:

```sh
miden-client
# or
miden-client --help
```

The first time that you sync your client (`miden-client sync`) a new file will be generated based on the configurations set on `miden-client.toml`. This file is the database of the client.

## License
This project is [MIT licensed](../../LICENSE).