Skip to content

Commit 5eac951

Browse files
authored
docs(cli): update generated docs
1 parent 1d6d951 commit 5eac951

File tree

1 file changed

+19
-83
lines changed

1 file changed

+19
-83
lines changed

docs/docs/07-cli.md

Lines changed: 19 additions & 83 deletions
Original file line numberDiff line numberDiff line change
@@ -241,6 +241,7 @@ ignite chain build [flags]
241241
**Options**
242242

243243
```
244+
--check-dependencies Verify that cached dependencies have not been modified since they were downloaded
244245
--clear-cache Clear the build cache (advanced)
245246
-h, --help help for build
246247
--home string Home directory used for blockchains
@@ -250,6 +251,7 @@ ignite chain build [flags]
250251
--release build for a release
251252
--release.prefix string tarball prefix for each release target. Available only with --release flag
252253
-t, --release.targets strings release targets. Available only with --release flag
254+
--skip-proto Skip file generation from proto
253255
-v, --verbose Verbose output
254256
```
255257

@@ -291,10 +293,12 @@ ignite chain init [flags]
291293
**Options**
292294

293295
```
294-
--clear-cache Clear the build cache (advanced)
295-
-h, --help help for init
296-
--home string Home directory used for blockchains
297-
-p, --path string path of the app (default ".")
296+
--check-dependencies Verify that cached dependencies have not been modified since they were downloaded
297+
--clear-cache Clear the build cache (advanced)
298+
-h, --help help for init
299+
--home string Home directory used for blockchains
300+
-p, --path string path of the app (default ".")
301+
--skip-proto Skip file generation from proto
298302
```
299303

300304
**SEE ALSO**
@@ -317,15 +321,17 @@ ignite chain serve [flags]
317321
**Options**
318322

319323
```
320-
--clear-cache Clear the build cache (advanced)
321-
-c, --config string Ignite config file (default: ./config.yml)
322-
-f, --force-reset Force reset of the app state on start and every source change
323-
-h, --help help for serve
324-
--home string Home directory used for blockchains
325-
-p, --path string path of the app (default ".")
326-
--proto-all-modules Enables proto code generation for 3rd party modules used in your chain
327-
-r, --reset-once Reset of the app state on first start
328-
-v, --verbose Verbose output
324+
--check-dependencies Verify that cached dependencies have not been modified since they were downloaded
325+
--clear-cache Clear the build cache (advanced)
326+
-c, --config string Ignite config file (default: ./config.yml)
327+
-f, --force-reset Force reset of the app state on start and every source change
328+
-h, --help help for serve
329+
--home string Home directory used for blockchains
330+
-p, --path string path of the app (default ".")
331+
--proto-all-modules Enables proto code generation for 3rd party modules used in your chain
332+
-r, --reset-once Reset of the app state on first start
333+
--skip-proto Skip file generation from proto
334+
-v, --verbose Verbose output
329335
```
330336

331337
**SEE ALSO**
@@ -992,81 +998,11 @@ Tools for advanced users
992998
**SEE ALSO**
993999

9941000
* [ignite](#ignite) - Ignite CLI offers everything you need to scaffold, test, build, and launch your blockchain
995-
* [ignite tools completions](#ignite-tools-completions) - Generate completions script
9961001
* [ignite tools ibc-relayer](#ignite-tools-ibc-relayer) - Typescript implementation of an IBC relayer
9971002
* [ignite tools ibc-setup](#ignite-tools-ibc-setup) - Collection of commands to quickly setup a relayer
9981003
* [ignite tools protoc](#ignite-tools-protoc) - Execute the protoc command
9991004

10001005

1001-
## ignite tools completions
1002-
1003-
Generate completions script
1004-
1005-
**Synopsis**
1006-
1007-
The completions command outputs a completion script you can use in your shell. The output script requires
1008-
that [bash-completion](https://github.com/scop/bash-completion) is installed and enabled in your
1009-
system. Since most Unix-like operating systems come with bash-completion by default, bash-completion
1010-
is probably already installed and operational.
1011-
1012-
Bash:
1013-
1014-
$ source <(ignite tools completions bash)
1015-
1016-
To load completions for every new session, run:
1017-
1018-
** Linux **
1019-
$ ignite tools completions bash > /etc/bash_completion.d/ignite
1020-
1021-
** macOS **
1022-
$ ignite tools completions bash > /usr/local/etc/bash_completion.d/ignite
1023-
1024-
Zsh:
1025-
1026-
If shell completions is not already enabled in your environment, you will need to enable it. You can execute the following once:
1027-
1028-
$ echo "autoload -U compinit; compinit" >> ~/.zshrc
1029-
1030-
To load completions for each session, execute once:
1031-
1032-
$ ignite tools completions zsh > "${fpath[1]}/_ignite"
1033-
1034-
You will need to start a new shell for this setup to take effect.
1035-
1036-
fish:
1037-
1038-
$ ignite tools completions fish | source
1039-
1040-
To load completions for each session, execute once:
1041-
1042-
$ ignite tools completions fish > ~/.config/fish/completionss/ignite.fish
1043-
1044-
PowerShell:
1045-
1046-
PS> ignite tools completions powershell | Out-String | Invoke-Expression
1047-
1048-
To load completions for every new session, run:
1049-
1050-
PS> ignite tools completions powershell > ignite.ps1
1051-
1052-
and source this file from your PowerShell profile.
1053-
1054-
1055-
```
1056-
ignite tools completions
1057-
```
1058-
1059-
**Options**
1060-
1061-
```
1062-
-h, --help help for completions
1063-
```
1064-
1065-
**SEE ALSO**
1066-
1067-
* [ignite tools](#ignite-tools) - Tools for advanced users
1068-
1069-
10701006
## ignite tools ibc-relayer
10711007

10721008
Typescript implementation of an IBC relayer

0 commit comments

Comments
 (0)