Skip to content

Commit efeb5ae

Browse files
committed
feat(pretty-fmt): update README for pretty flag
- update README for `--pretty` flag - update CHANGELOG
1 parent 3a5204f commit efeb5ae

File tree

2 files changed

+12
-0
lines changed

2 files changed

+12
-0
lines changed

CHANGELOG.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,8 @@ page. See [DEVELOPMENT_CYCLE.md](DEVELOPMENT_CYCLE.md) for more details.
55

66
## [Unreleased]
77

8+
- Add `--pretty` top level flag for formatting commands output in a tabular format
9+
810
## [1.0.0]
911

1012
- Changed the MSRV to 1.75.0 and bumped the rust edition to 2021

README.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -195,6 +195,16 @@ Note: You can modify the `Justfile` to reflect your nodes' configuration values.
195195
cargo run --features rpc -- wallet -u "127.0.0.1:18443" -c rpc -a user:password balance
196196
```
197197

198+
## Formatting Responses using `--pretty` flag
199+
200+
You can optionally return outputs of commands in human-readable, tabular format instead of `JSON`. To enable this option, simply add the `--pretty` flag as a top level flag. For instance, you wallet's balance in a pretty format, you can run:
201+
202+
```shell
203+
cargo run --pretty -n signet wallet -w {wallet_name} -d sqlite balance
204+
```
205+
206+
This is available for wallet, key, repl and compile features. When ommitted, outputs default to `JSON`.
207+
198208
## Minimum Supported Rust Version (MSRV)
199209

200210
This library should always compile with any valid combination of features on Rust **1.75.0**.

0 commit comments

Comments
 (0)