Skip to content

Commit 934a061

Browse files
[automated] Update Forest CLI docs (#5468)
Co-authored-by: github-merge-queue <118344674+github-merge-queue@users.noreply.github.com>
1 parent 0173743 commit 934a061

File tree

1 file changed

+11
-5
lines changed
  • docs/docs/users/reference

1 file changed

+11
-5
lines changed

docs/docs/users/reference/cli.md

Lines changed: 11 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1671,11 +1671,16 @@ Arguments:
16711671
<TEST_DUMP_FILES>... Path to test dumps that are generated by `forest-tool api dump-tests` command
16721672
16731673
Options:
1674-
--db <DB> Path to the database folder that powers a Forest node
1675-
--chain <CHAIN> Filecoin network chain
1676-
--out-dir <OUT_DIR> Folder into which test snapshots are dumped
1677-
--allow-response-mismatch Allow generating snapshot even if Lotus generated a different response. This is useful when the response is not deterministic
1678-
-h, --help Print help
1674+
--db <DB>
1675+
Path to the database folder that powers a Forest node
1676+
--chain <CHAIN>
1677+
Filecoin network chain
1678+
--out-dir <OUT_DIR>
1679+
Folder into which test snapshots are dumped
1680+
--use-response-from <USE_RESPONSE_FROM>
1681+
Allow generating snapshot even if Lotus generated a different response. This is useful when the response is not deterministic or a failing test is expected. If generating a failing test, use `Lotus` as the argument to ensure the test passes only when the response from Forest is fixed and matches the response from Lotus [possible values: forest, lotus]
1682+
-h, --help
1683+
Print help
16791684
```
16801685

16811686
### `forest-tool api dump-tests`
@@ -1745,6 +1750,7 @@ Commands:
17451750
key-pair-from-private-key Generate a key-pair file from the given base64-encoded private key. This effectively transforms Lotus's private key into a Forest-compatible key-pair file. If `output` is not provided, the key-pair is printed to stdout as a base64-encoded string
17461751
openrpc Dump the OpenRPC definition for the node
17471752
f3 F3 related commands
1753+
migrate-state Run a network upgrade migration
17481754
help Print this message or the help of the given subcommand(s)
17491755
17501756
Options:

0 commit comments

Comments
 (0)