Skip to content

Commit 4a6b97e

Browse files
Update Forest CLI docs
1 parent 8df416c commit 4a6b97e

File tree

1 file changed

+37
-8
lines changed
  • docs/docs/users/reference

1 file changed

+37
-8
lines changed

docs/docs/users/reference/cli.md

Lines changed: 37 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1690,23 +1690,39 @@ Options:
16901690
Usage: forest-tool api dump-tests [OPTIONS] --path <PATH> [SNAPSHOT_FILES]...
16911691
16921692
Arguments:
1693-
[SNAPSHOT_FILES]... Snapshot input paths. Supports `.car`, `.car.zst`, and `.forest.car.zst`
1693+
[SNAPSHOT_FILES]...
1694+
Snapshot input paths. Supports `.car`, `.car.zst`, and `.forest.car.zst`
16941695
16951696
Options:
16961697
-n, --n-tipsets <N_TIPSETS>
1697-
The number of tipsets to use to generate test cases [default: 10]
1698+
The number of tipsets to use to generate test cases
1699+
1700+
[default: 10]
1701+
16981702
--miner-address <MINER_ADDRESS>
16991703
Miner address to use for miner tests. Miner worker key must be in the key-store
1704+
17001705
--worker-address <WORKER_ADDRESS>
17011706
Worker address to use where key is applicable. Worker key must be in the key-store
1707+
17021708
--eth-chain-id <ETH_CHAIN_ID>
1703-
Ethereum chain ID. Default to the calibnet chain ID [default: 314159]
1709+
Ethereum chain ID. Default to the calibnet chain ID
1710+
1711+
[default: 314159]
1712+
17041713
--path <PATH>
1705-
Which API path to dump [possible values: v0, v1]
1714+
Which API path to dump
1715+
1716+
Possible values:
1717+
- v0: Only expose this method on `/rpc/v0`
1718+
- v1: Only expose this method on `/rpc/v1`
1719+
- v2: Only expose this method on `/rpc/v2`
1720+
17061721
--include-ignored
17071722
1723+
17081724
-h, --help
1709-
Print help
1725+
Print help (see a summary with '-h')
17101726
```
17111727

17121728
### `forest-tool api test`
@@ -1816,10 +1832,23 @@ Usage: forest-tool shed openrpc [OPTIONS] --path <PATH> [INCLUDE]...
18161832
Arguments:
18171833
[INCLUDE]...
18181834
1835+
18191836
Options:
1820-
--path <PATH> Which API path to dump [possible values: v0, v1]
1821-
--omit <OMIT> A comma-separated list of fields to omit from the output (e.g., "summary,description") [possible values: summary, description]
1822-
-h, --help Print help
1837+
--path <PATH>
1838+
Which API path to dump
1839+
1840+
Possible values:
1841+
- v0: Only expose this method on `/rpc/v0`
1842+
- v1: Only expose this method on `/rpc/v1`
1843+
- v2: Only expose this method on `/rpc/v2`
1844+
1845+
--omit <OMIT>
1846+
A comma-separated list of fields to omit from the output (e.g., "summary,description")
1847+
1848+
[possible values: summary, description]
1849+
1850+
-h, --help
1851+
Print help (see a summary with '-h')
18231852
```
18241853

18251854
### `forest-tool shed f3`

0 commit comments

Comments
 (0)