Skip to content

Commit e33d088

Browse files
committed
docs: update bin name
1 parent b09d76b commit e33d088

File tree

3 files changed

+11
-11
lines changed

3 files changed

+11
-11
lines changed

Cargo.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ version = "0.0.7"
44
edition = "2021"
55

66
[[bin]]
7-
name = "xrpl-vl-tool"
7+
name = "xrpl_vl_tool"
88
path = "src/main.rs"
99

1010
[lib]

README.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ For more information about v2, follow this [link](https://github.com/XRPLF/XRPL-
1818
The command allows for either a url or a file path:
1919

2020
```
21-
Usage: xrpl-vl-tool load <URL_OR_FILE>
21+
Usage: xrpl_vl_tool load <URL_OR_FILE>
2222
2323
Arguments:
2424
<URL_OR_FILE> The URL or file path of the Validation List. You can pass either
@@ -33,7 +33,7 @@ And loads the given VL performing some validations.
3333

3434
*Example request:*
3535

36-
`./xrpl-vl-tool load https://vl.xrplf.org` or `./xrpl-vl-tool load /dev/vl.json`
36+
`./xrpl_vl_tool load https://vl.xrplf.org` or `./xrpl_vl_tool load /dev/vl.json`
3737

3838
*Example response:*
3939

@@ -85,7 +85,7 @@ Validator: EDA54C85F91219FD259134B6B126AD64AE7204B81DD4052510657E1A5697246AD2 (n
8585
Signs a new (or appends to an existing VL) UNL retrieving the secret from AWS.
8686

8787
```
88-
Usage: xrpl-vl-tool sign [OPTIONS] --vl-version <VL_VERSION> --publisher-manifest <PUBLISHER_MANIFEST> --manifests-file <MANIFESTS_FILE> --sequence <SEQUENCE> --expiration <EXPIRATION_IN_DAYS> --secret-provider <SECRET_PROVIDER> --secret-name <SECRET_NAME>
88+
Usage: xrpl_vl_tool sign [OPTIONS] --vl-version <VL_VERSION> --publisher-manifest <PUBLISHER_MANIFEST> --manifests-file <MANIFESTS_FILE> --sequence <SEQUENCE> --expiration <EXPIRATION_IN_DAYS> --secret-provider <SECRET_PROVIDER> --secret-name <SECRET_NAME>
8989
9090
Options:
9191
-v, --vl-version <VL_VERSION>
@@ -150,7 +150,7 @@ For local secrets, specify the path to a file containing the public and private
150150
*Example request:*
151151

152152
```
153-
./xrpl-vl-tool sign \
153+
./xrpl_vl_tool sign \
154154
--vl-version 1 \
155155
--publisher-manifest JAAAAAFxIe0md6v/0bM6xvvDBitx8eg5fBUF4cQsZNEa0bKP9z9HNHMh7V0AnEi5D4odY9X2sx+cY8B3OHNjJvMhARRPtTHmWnAhdkDFcg53dAQS1WDMQDLIs2wwwHpScrUnjp1iZwwTXVXXsaRxLztycioto3JgImGdukXubbrjeqCNU02f7Y/+6w0BcBJA3M0EOU+39hmB8vwfgernXZIDQ1+o0dnuXjX73oDLgsacwXzLBVOdBpSAsJwYD+nW8YaSacOHEsWaPlof05EsAg== \
156156
--manifests-file tests/data/manifests_list_1.txt \
@@ -161,7 +161,7 @@ For local secrets, specify the path to a file containing the public and private
161161
```
162162

163163
```
164-
./xrpl-vl-tool sign \
164+
./xrpl_vl_tool sign \
165165
--vl-version 2 \
166166
--publisher-manifest JAAAAAFxIe0md6v/0bM6xvvDBitx8eg5fBUF4cQsZNEa0bKP9z9HNHMh7V0AnEi5D4odY9X2sx+cY8B3OHNjJvMhARRPtTHmWnAhdkDFcg53dAQS1WDMQDLIs2wwwHpScrUnjp1iZwwTXVXXsaRxLztycioto3JgImGdukXubbrjeqCNU02f7Y/+6w0BcBJA3M0EOU+39hmB8vwfgernXZIDQ1+o0dnuXjX73oDLgsacwXzLBVOdBpSAsJwYD+nW8YaSacOHEsWaPlof05EsAg== \
167167
--manifests-file tests/data/manifests_list_1.txt \
@@ -235,7 +235,7 @@ Example:
235235
Encodes a manifest.
236236

237237
```
238-
Usage: xrpl-vl-tool encode-manifest [OPTIONS] --sequence <SEQUENCE> --master-public-key <MASTER_PUBLIC_KEY> --signing-public-key <SIGNING_PUBLIC_KEY> --signature <SIGNATURE> --master-signature <MASTER_SIGNATURE>
238+
Usage: xrpl_vl_tool encode-manifest [OPTIONS] --sequence <SEQUENCE> --master-public-key <MASTER_PUBLIC_KEY> --signing-public-key <SIGNING_PUBLIC_KEY> --signature <SIGNATURE> --master-signature <MASTER_SIGNATURE>
239239
240240
Options:
241241
-s, --sequence <SEQUENCE> Manifest sequence number
@@ -250,7 +250,7 @@ Options:
250250
Example:
251251

252252
```
253-
./xrpl-vl-tool encode-manifest \
253+
./xrpl_vl_tool encode-manifest \
254254
--sequence 1 \
255255
--master-public-key nHBe4vqSAzjpPRLKwSFzRFtmvzXaf5wPPmuVrQCAoJoS1zskgDA4 \
256256
--signing-public-key nHUhPxhvYHHDsNrdnDEqJnkFHm1XcddQYH4RjLTNaVQJZSXXeNhU \
@@ -263,7 +263,7 @@ Example:
263263
Decodes a manifest.
264264

265265
```
266-
Usage: xrpl-vl-tool decode-manifest <MANIFEST>
266+
Usage: xrpl_vl_tool decode-manifest <MANIFEST>
267267
268268
Arguments:
269269
<MANIFEST> The manifest to decode
@@ -275,7 +275,7 @@ Options:
275275
Example:
276276

277277
```
278-
./xrpl-vl-tool decode-manifest JAAAAAFxIe1NWZrNQGcv7hqdO+VutSUy4n1LnLA2MODJJBrxrz0fcHMhAkWhek9PSMZhFik8M+Xjp78yUA4CBG588XjqEgjUGN3idkYwRAIgevLigsRwT6Gswj9gaX06eDwwS4xBfrfnftxKqutvG4oCIBQi95V6KIjKpdaXUn+SPsDpGRU2YNUQgTjqgh39qJPpcBJAr78avNH5e3BoYgFP7Xx7PqFNf/I3jFfoMMqCnKZJUyPxk4xeQkRy3el03CqUzjWzfzkxv6jxi5G/Gz7wu7RDCQ==
278+
./xrpl_vl_tool decode-manifest JAAAAAFxIe1NWZrNQGcv7hqdO+VutSUy4n1LnLA2MODJJBrxrz0fcHMhAkWhek9PSMZhFik8M+Xjp78yUA4CBG588XjqEgjUGN3idkYwRAIgevLigsRwT6Gswj9gaX06eDwwS4xBfrfnftxKqutvG4oCIBQi95V6KIjKpdaXUn+SPsDpGRU2YNUQgTjqgh39qJPpcBJAr78avNH5e3BoYgFP7Xx7PqFNf/I3jFfoMMqCnKZJUyPxk4xeQkRy3el03CqUzjWzfzkxv6jxi5G/Gz7wu7RDCQ==
279279
```
280280

281281
### Run locally

tests/cli.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
use assert_cmd::Command;
22
use predicates::str::contains;
33

4-
const BIN_NAME: &str = "xrpl-vl-tool";
4+
const BIN_NAME: &str = "xrpl_vl_tool";
55

66
#[test]
77
fn test_cli_load_v1() {

0 commit comments

Comments
 (0)