Skip to content

Commit 4040189

Browse files
LeshyBotgithub-merge-queue[bot]LesnyRumcajs
authored
[automated] Update Forest CLI docs (#5362)
Co-authored-by: github-merge-queue <[email protected]> Co-authored-by: LesnyRumcajs <[email protected]>
1 parent 883dd0f commit 4040189

File tree

2 files changed

+17
-0
lines changed

2 files changed

+17
-0
lines changed

docs/docs/users/reference/cli.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -984,6 +984,7 @@ SUBCOMMANDS:
984984
api API tooling
985985
net Network utilities
986986
shed Miscellaneous, semver-exempt commands for developer use
987+
completion Completion Command for generating shell completions for the CLI
987988
help Print this message or the help of the given subcommand(s)
988989
989990
OPTIONS:
@@ -1007,6 +1008,21 @@ Options:
10071008
-h, --help Print help
10081009
```
10091010

1011+
### `forest-tool completion`
1012+
1013+
```
1014+
Completion Command for generating shell completions for the CLI
1015+
1016+
Usage: forest-tool completion [OPTIONS] [BINARIES]...
1017+
1018+
Arguments:
1019+
[BINARIES]... The binaries for which to generate completions (e.g., 'forest-cli,forest-tool,forest-wallet'). If omitted, completions for all known binaries will be generated
1020+
1021+
Options:
1022+
--shell <SHELL> The Shell type to generate completions for [default: bash] [possible values: bash, elvish, fish, powershell, zsh]
1023+
-h, --help Print help
1024+
```
1025+
10101026
### `forest-tool backup create`
10111027

10121028
```

docs/docs/users/reference/cli.sh

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -90,6 +90,7 @@ generate_markdown_section "forest-cli" "f3 powertable get-proportion"
9090
generate_markdown_section "forest-tool" ""
9191

9292
generate_markdown_section "forest-tool" "backup"
93+
generate_markdown_section "forest-tool" "completion"
9394
generate_markdown_section "forest-tool" "backup create"
9495
generate_markdown_section "forest-tool" "backup restore"
9596

0 commit comments

Comments
 (0)