Skip to content

[automated] Update Forest CLI docs #5468

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
hanabi1224 merged 1 commit into from
Mar 27, 2025
Merged

[automated] Update Forest CLI docs #5468

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 11 additions & 5 deletions docs/docs/users/reference/cli.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1671,11 +1671,16 @@ Arguments:
<TEST_DUMP_FILES>... Path to test dumps that are generated by `forest-tool api dump-tests` command

Options:
--db <DB> Path to the database folder that powers a Forest node
--chain <CHAIN> Filecoin network chain
--out-dir <OUT_DIR> Folder into which test snapshots are dumped
--allow-response-mismatch Allow generating snapshot even if Lotus generated a different response. This is useful when the response is not deterministic
-h, --help Print help
--db <DB>
Path to the database folder that powers a Forest node
--chain <CHAIN>
Filecoin network chain
--out-dir <OUT_DIR>
Folder into which test snapshots are dumped
--use-response-from <USE_RESPONSE_FROM>
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]
-h, --help
Print help
```

### `forest-tool api dump-tests`
Expand Down Expand Up @@ -1745,6 +1750,7 @@ Commands:
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
openrpc Dump the OpenRPC definition for the node
f3 F3 related commands
migrate-state Run a network upgrade migration
help Print this message or the help of the given subcommand(s)

Options:
Expand Down
Loading