From 3ed71d5b9294ff52c016b8cf3c3f494723c10cf4 Mon Sep 17 00:00:00 2001 From: jeronimoalbi Date: Fri, 13 Oct 2023 08:00:55 +0000 Subject: [PATCH] docs(cli): update generated docs --- docs/docs/08-references/01-cli.md | 854 ++++++++++-------------------- 1 file changed, 280 insertions(+), 574 deletions(-) diff --git a/docs/docs/08-references/01-cli.md b/docs/docs/08-references/01-cli.md index 3fae1abf05..7f38f23d3a 100644 --- a/docs/docs/08-references/01-cli.md +++ b/docs/docs/08-references/01-cli.md @@ -29,13 +29,13 @@ To get started, create a blockchain: **SEE ALSO** * [ignite account](#ignite-account) - Create, delete, and show Ignite accounts +* [ignite app](#ignite-app) - Create and manage Ignite Apps * [ignite chain](#ignite-chain) - Build, init and start a blockchain node * [ignite completion](#ignite-completion) - Generate the autocompletion script for the specified shell * [ignite docs](#ignite-docs) - Show Ignite CLI docs * [ignite generate](#ignite-generate) - Generate clients, API docs from source code * [ignite network](#ignite-network) - Launch a blockchain in production * [ignite node](#ignite-node) - Make requests to a live blockchain node -* [ignite plugin](#ignite-plugin) - Handle plugins * [ignite relayer](#ignite-relayer) - Connect blockchains with an IBC relayer * [ignite scaffold](#ignite-scaffold) - Create a new blockchain, module, message, query, and more * [ignite tools](#ignite-tools) - Tools for advanced users @@ -241,6 +241,203 @@ ignite account show [name] [flags] * [ignite account](#ignite-account) - Create, delete, and show Ignite accounts +## ignite app + +Create and manage Ignite Apps + +**Options** + +``` + -h, --help help for app +``` + +**SEE ALSO** + +* [ignite](#ignite) - Ignite CLI offers everything you need to scaffold, test, build, and launch your blockchain +* [ignite app describe](#ignite-app-describe) - Print information about installed apps +* [ignite app install](#ignite-app-install) - Install app +* [ignite app list](#ignite-app-list) - List installed apps +* [ignite app scaffold](#ignite-app-scaffold) - Scaffold a new Ignite App +* [ignite app uninstall](#ignite-app-uninstall) - Uninstall app +* [ignite app update](#ignite-app-update) - Update app + + +## ignite app describe + +Print information about installed apps + +**Synopsis** + +Print information about an installed Ignite App commands and hooks. + +``` +ignite app describe [path] [flags] +``` + +**Examples** + +``` +ignite app describe github.com/org/my-app/ +``` + +**Options** + +``` + -h, --help help for describe +``` + +**SEE ALSO** + +* [ignite app](#ignite-app) - Create and manage Ignite Apps + + +## ignite app install + +Install app + +**Synopsis** + +Installs an Ignite App. + +Respects key value pairs declared after the app path to be added to the generated configuration definition. + +``` +ignite app install [path] [key=value]... [flags] +``` + +**Examples** + +``` +ignite app install github.com/org/my-app/ foo=bar baz=qux +``` + +**Options** + +``` + -g, --global use global plugins configuration ($HOME/.ignite/apps/igniteapps.yml) + -h, --help help for install +``` + +**SEE ALSO** + +* [ignite app](#ignite-app) - Create and manage Ignite Apps + + +## ignite app list + +List installed apps + +**Synopsis** + +Prints status and information of all installed Ignite Apps. + +``` +ignite app list [flags] +``` + +**Options** + +``` + -h, --help help for list +``` + +**SEE ALSO** + +* [ignite app](#ignite-app) - Create and manage Ignite Apps + + +## ignite app scaffold + +Scaffold a new Ignite App + +**Synopsis** + +Scaffolds a new Ignite App in the current directory. + +A git repository will be created with the given module name, unless the current directory is already a git repository. + +``` +ignite app scaffold [name] [flags] +``` + +**Examples** + +``` +ignite app scaffold github.com/org/my-app/ +``` + +**Options** + +``` + -h, --help help for scaffold +``` + +**SEE ALSO** + +* [ignite app](#ignite-app) - Create and manage Ignite Apps + + +## ignite app uninstall + +Uninstall app + +**Synopsis** + +Uninstalls an Ignite App specified by path. + +``` +ignite app uninstall [path] [flags] +``` + +**Examples** + +``` +ignite app uninstall github.com/org/my-app/ +``` + +**Options** + +``` + -g, --global use global plugins configuration ($HOME/.ignite/apps/igniteapps.yml) + -h, --help help for uninstall +``` + +**SEE ALSO** + +* [ignite app](#ignite-app) - Create and manage Ignite Apps + + +## ignite app update + +Update app + +**Synopsis** + +Updates an Ignite App specified by path. + +If no path is specified all declared apps are updated. + +``` +ignite app update [path] [flags] +``` + +**Examples** + +``` +ignite app update github.com/org/my-app/ +``` + +**Options** + +``` + -h, --help help for update +``` + +**SEE ALSO** + +* [ignite app](#ignite-app) - Create and manage Ignite Apps + + ## ignite chain Build, init and start a blockchain node @@ -381,6 +578,7 @@ ignite chain build [flags] **Options** ``` + --build.tags strings parameters to build the chain binary (default [app_v1]) --check-dependencies verify that cached dependencies have not been modified since they were downloaded --clear-cache clear the build cache (advanced) --debug build a debug binary @@ -568,6 +766,7 @@ ignite chain init [flags] **Options** ``` + --build.tags strings parameters to build the chain binary (default [app_v1]) --check-dependencies verify that cached dependencies have not been modified since they were downloaded --clear-cache clear the build cache (advanced) --debug build a debug binary @@ -636,6 +835,7 @@ ignite chain serve [flags] **Options** ``` + --build.tags strings parameters to build the chain binary (default [app_v1]) --check-dependencies verify that cached dependencies have not been modified since they were downloaded --clear-cache clear the build cache (advanced) -f, --force-reset force reset of the app state on start and every source change @@ -858,7 +1058,7 @@ to enable it. You can execute the following once: To load completions in your current shell session: - source <(ignite completion zsh); compdef _ignite ignite + source <(ignite completion zsh) To load completions for every new session, execute once: @@ -938,6 +1138,7 @@ meant to be edited by hand. * [ignite generate hooks](#ignite-generate-hooks) - TypeScript frontend client and React hooks * [ignite generate openapi](#ignite-generate-openapi) - OpenAPI spec for your chain * [ignite generate proto-go](#ignite-generate-proto-go) - Compile protocol buffer files to Go source code required by Cosmos SDK +* [ignite generate proto-pulsar](#ignite-generate-proto-pulsar) - Compile protocol buffer files to Go pulsar source code required by Cosmos SDK * [ignite generate ts-client](#ignite-generate-ts-client) - TypeScript frontend client * [ignite generate vuex](#ignite-generate-vuex) - *DEPRECATED* TypeScript frontend client and Vuex stores @@ -1052,6 +1253,33 @@ ignite generate proto-go [flags] * [ignite generate](#ignite-generate) - Generate clients, API docs from source code +## ignite generate proto-pulsar + +Compile protocol buffer files to Go pulsar source code required by Cosmos SDK + +``` +ignite generate proto-pulsar [flags] +``` + +**Options** + +``` + -h, --help help for proto-pulsar + -y, --yes answers interactive yes/no questions with yes +``` + +**Options inherited from parent commands** + +``` + --clear-cache clear the build cache (advanced) + -p, --path string path of the app (default ".") +``` + +**SEE ALSO** + +* [ignite generate](#ignite-generate) - Generate clients, API docs from source code + + ## ignite generate ts-client TypeScript frontend client @@ -1199,10 +1427,7 @@ validators launch their nodes, a blockchain will be live. * [ignite](#ignite) - Ignite CLI offers everything you need to scaffold, test, build, and launch your blockchain * [ignite network chain](#ignite-network-chain) - Publish a chain, join as a validator and prepare node for launch * [ignite network coordinator](#ignite-network-coordinator) - Show and update a coordinator profile -* [ignite network profile](#ignite-network-profile) - Show the address profile info -* [ignite network project](#ignite-network-project) - Handle projects * [ignite network request](#ignite-network-request) - Create, show, reject and approve requests -* [ignite network reward](#ignite-network-reward) - Manage network rewards * [ignite network tool](#ignite-network-tool) - Commands to run subsidiary tools * [ignite network validator](#ignite-network-validator) - Show and update a validator profile * [ignite network version](#ignite-network-version) - Version of the plugin @@ -1994,45 +2219,31 @@ ignite network coordinator show [address] [flags] * [ignite network coordinator](#ignite-network-coordinator) - Show and update a coordinator profile -## ignite network profile - -Show the address profile info - -``` -ignite network profile [project-id] [flags] -``` - -**Options** - -``` - --from string account name to use for sending transactions to SPN (default "default") - -h, --help help for profile - --home string home directory used for blockchains - --keyring-backend string keyring backend to store your account keys (default "test") -``` +## ignite network request -**Options inherited from parent commands** +Create, show, reject and approve requests -``` - --local Use local SPN network - --nightly Use nightly SPN network - --spn-faucet-address string SPN faucet address (default "https://faucet.devnet.ignite.com:443") - --spn-node-address string SPN node address (default "https://rpc.devnet.ignite.com:443") -``` +**Synopsis** -**SEE ALSO** +The "request" namespace contains commands for creating, showing, approving, and +rejecting requests. -* [ignite network](#ignite-network) - Launch a blockchain in production +A request is mechanism in Ignite that allows changes to be made to the genesis +file like adding accounts with token balances and validators. Anyone can submit +a request, but only the coordinator of a chain can approve or reject a request. +Each request has a status: -## ignite network project +* Pending: waiting for the approval of the coordinator +* Approved: approved by the coordinator, its content has been applied to the + launch information +* Rejected: rejected by the coordinator or the request creator -Handle projects **Options** ``` - -h, --help help for project + -h, --help help for request ``` **Options inherited from parent commands** @@ -2047,50 +2258,49 @@ Handle projects **SEE ALSO** * [ignite network](#ignite-network) - Launch a blockchain in production -* [ignite network project account](#ignite-network-project-account) - Handle project accounts -* [ignite network project create](#ignite-network-project-create) - Create a project -* [ignite network project list](#ignite-network-project-list) - List published projects -* [ignite network project show](#ignite-network-project-show) - Show published project -* [ignite network project update](#ignite-network-project-update) - Update details fo the project of the project - - -## ignite network project account - -Handle project accounts - -**Options** +* [ignite network request add-account](#ignite-network-request-add-account) - Send request to add account +* [ignite network request approve](#ignite-network-request-approve) - Approve requests +* [ignite network request change-param](#ignite-network-request-change-param) - Send request to change a module param +* [ignite network request list](#ignite-network-request-list) - List all requests for a chain +* [ignite network request reject](#ignite-network-request-reject) - Reject requests +* [ignite network request remove-account](#ignite-network-request-remove-account) - Send request to remove a genesis account +* [ignite network request remove-validator](#ignite-network-request-remove-validator) - Send request to remove a validator +* [ignite network request show](#ignite-network-request-show) - Show detailed information about a request +* [ignite network request verify](#ignite-network-request-verify) - Verify the request and simulate the chain genesis from them -``` - -h, --help help for account -``` -**Options inherited from parent commands** +## ignite network request add-account -``` - --local Use local SPN network - --nightly Use nightly SPN network - --spn-faucet-address string SPN faucet address (default "https://faucet.devnet.ignite.com:443") - --spn-node-address string SPN node address (default "https://rpc.devnet.ignite.com:443") -``` +Send request to add account -**SEE ALSO** +**Synopsis** -* [ignite network project](#ignite-network-project) - Handle projects -* [ignite network project account list](#ignite-network-project-account-list) - Show all mainnet and mainnet vesting of the project +The "add account" command creates a new request to add an account with a given +address and a specified coin balance to the genesis of the chain. +The request automatically fails to be applied if a genesis account or a vesting +account with an identical address is already specified in the launch +information. -## ignite network project account list +If a coordinator has specified that all genesis accounts on a chain should have +the same balance (useful for testnets, for example), the "add account" expects +only an address as an argument. Attempt to provide a token balance will result +in an error. -Show all mainnet and mainnet vesting of the project ``` -ignite network project account list [project-id] [flags] +ignite network request add-account [launch-id] [address] [coins] [flags] ``` **Options** ``` - -h, --help help for list + --clear-cache clear the build cache (advanced) + --from string account name to use for sending transactions to SPN (default "default") + -h, --help help for add-account + --home string home directory used for blockchains + --keyring-backend string keyring backend to store your account keys (default "test") + --keyring-dir string accounts keyring directory (default "/home/runner/.ignite/accounts") ``` **Options inherited from parent commands** @@ -2104,235 +2314,14 @@ ignite network project account list [project-id] [flags] **SEE ALSO** -* [ignite network project account](#ignite-network-project-account) - Handle project accounts - +* [ignite network request](#ignite-network-request) - Create, show, reject and approve requests -## ignite network project create -Create a project +## ignite network request approve -``` -ignite network project create [name] [total-supply] [flags] -``` +Approve requests -**Options** - -``` - --from string account name to use for sending transactions to SPN (default "default") - -h, --help help for create - --home string home directory used for blockchains - --keyring-backend string keyring backend to store your account keys (default "test") - --keyring-dir string accounts keyring directory (default "/home/runner/.ignite/accounts") - --metadata string Add a metadata to the chain -``` - -**Options inherited from parent commands** - -``` - --local Use local SPN network - --nightly Use nightly SPN network - --spn-faucet-address string SPN faucet address (default "https://faucet.devnet.ignite.com:443") - --spn-node-address string SPN node address (default "https://rpc.devnet.ignite.com:443") -``` - -**SEE ALSO** - -* [ignite network project](#ignite-network-project) - Handle projects - - -## ignite network project list - -List published projects - -``` -ignite network project list [flags] -``` - -**Options** - -``` - -h, --help help for list -``` - -**Options inherited from parent commands** - -``` - --local Use local SPN network - --nightly Use nightly SPN network - --spn-faucet-address string SPN faucet address (default "https://faucet.devnet.ignite.com:443") - --spn-node-address string SPN node address (default "https://rpc.devnet.ignite.com:443") -``` - -**SEE ALSO** - -* [ignite network project](#ignite-network-project) - Handle projects - - -## ignite network project show - -Show published project - -``` -ignite network project show [project-id] [flags] -``` - -**Options** - -``` - -h, --help help for show -``` - -**Options inherited from parent commands** - -``` - --local Use local SPN network - --nightly Use nightly SPN network - --spn-faucet-address string SPN faucet address (default "https://faucet.devnet.ignite.com:443") - --spn-node-address string SPN node address (default "https://rpc.devnet.ignite.com:443") -``` - -**SEE ALSO** - -* [ignite network project](#ignite-network-project) - Handle projects - - -## ignite network project update - -Update details fo the project of the project - -``` -ignite network project update [project-id] [flags] -``` - -**Options** - -``` - --from string account name to use for sending transactions to SPN (default "default") - -h, --help help for update - --keyring-backend string keyring backend to store your account keys (default "test") - --keyring-dir string accounts keyring directory (default "/home/runner/.ignite/accounts") - --metadata string update the project metadata - --name string update the project name - --total-supply string update the total of the mainnet of a project -``` - -**Options inherited from parent commands** - -``` - --local Use local SPN network - --nightly Use nightly SPN network - --spn-faucet-address string SPN faucet address (default "https://faucet.devnet.ignite.com:443") - --spn-node-address string SPN node address (default "https://rpc.devnet.ignite.com:443") -``` - -**SEE ALSO** - -* [ignite network project](#ignite-network-project) - Handle projects - - -## ignite network request - -Create, show, reject and approve requests - -**Synopsis** - -The "request" namespace contains commands for creating, showing, approving, and -rejecting requests. - -A request is mechanism in Ignite that allows changes to be made to the genesis -file like adding accounts with token balances and validators. Anyone can submit -a request, but only the coordinator of a chain can approve or reject a request. - -Each request has a status: - -* Pending: waiting for the approval of the coordinator -* Approved: approved by the coordinator, its content has been applied to the - launch information -* Rejected: rejected by the coordinator or the request creator - - -**Options** - -``` - -h, --help help for request -``` - -**Options inherited from parent commands** - -``` - --local Use local SPN network - --nightly Use nightly SPN network - --spn-faucet-address string SPN faucet address (default "https://faucet.devnet.ignite.com:443") - --spn-node-address string SPN node address (default "https://rpc.devnet.ignite.com:443") -``` - -**SEE ALSO** - -* [ignite network](#ignite-network) - Launch a blockchain in production -* [ignite network request add-account](#ignite-network-request-add-account) - Send request to add account -* [ignite network request approve](#ignite-network-request-approve) - Approve requests -* [ignite network request change-param](#ignite-network-request-change-param) - Send request to change a module param -* [ignite network request list](#ignite-network-request-list) - List all requests for a chain -* [ignite network request reject](#ignite-network-request-reject) - Reject requests -* [ignite network request remove-account](#ignite-network-request-remove-account) - Send request to remove a genesis account -* [ignite network request remove-validator](#ignite-network-request-remove-validator) - Send request to remove a validator -* [ignite network request show](#ignite-network-request-show) - Show detailed information about a request -* [ignite network request verify](#ignite-network-request-verify) - Verify the request and simulate the chain genesis from them - - -## ignite network request add-account - -Send request to add account - -**Synopsis** - -The "add account" command creates a new request to add an account with a given -address and a specified coin balance to the genesis of the chain. - -The request automatically fails to be applied if a genesis account or a vesting -account with an identical address is already specified in the launch -information. - -If a coordinator has specified that all genesis accounts on a chain should have -the same balance (useful for testnets, for example), the "add account" expects -only an address as an argument. Attempt to provide a token balance will result -in an error. - - -``` -ignite network request add-account [launch-id] [address] [coins] [flags] -``` - -**Options** - -``` - --clear-cache clear the build cache (advanced) - --from string account name to use for sending transactions to SPN (default "default") - -h, --help help for add-account - --home string home directory used for blockchains - --keyring-backend string keyring backend to store your account keys (default "test") - --keyring-dir string accounts keyring directory (default "/home/runner/.ignite/accounts") -``` - -**Options inherited from parent commands** - -``` - --local Use local SPN network - --nightly Use nightly SPN network - --spn-faucet-address string SPN faucet address (default "https://faucet.devnet.ignite.com:443") - --spn-node-address string SPN node address (default "https://rpc.devnet.ignite.com:443") -``` - -**SEE ALSO** - -* [ignite network request](#ignite-network-request) - Create, show, reject and approve requests - - -## ignite network request approve - -Approve requests - -**Synopsis** +**Synopsis** The "approve" command is used by a chain's coordinator to approve requests. Multiple requests can be approved using a comma-separated list and/or using a @@ -2621,102 +2610,6 @@ ignite network request verify [launch-id] [number<,...>] [flags] * [ignite network request](#ignite-network-request) - Create, show, reject and approve requests -## ignite network reward - -Manage network rewards - -**Options** - -``` - -h, --help help for reward -``` - -**Options inherited from parent commands** - -``` - --local Use local SPN network - --nightly Use nightly SPN network - --spn-faucet-address string SPN faucet address (default "https://faucet.devnet.ignite.com:443") - --spn-node-address string SPN node address (default "https://rpc.devnet.ignite.com:443") -``` - -**SEE ALSO** - -* [ignite network](#ignite-network) - Launch a blockchain in production -* [ignite network reward release](#ignite-network-reward-release) - Connect the monitoring modules of launched chains with SPN -* [ignite network reward set](#ignite-network-reward-set) - set a network chain reward - - -## ignite network reward release - -Connect the monitoring modules of launched chains with SPN - -``` -ignite network reward release [launch-id] [chain-rpc] [flags] -``` - -**Options** - -``` - --create-client-only only create the network client id - --from string account name to use for sending transactions to SPN (default "default") - -h, --help help for release - --keyring-backend string keyring backend to store your account keys (default "test") - --spn-gaslimit int gas limit used for transactions on SPN (default 400000) - --spn-gasprice string gas price used for transactions on SPN (default "0.0000025uspn") - --testnet-account string testnet chain account (default "default") - --testnet-faucet string faucet address of the testnet chain - --testnet-gaslimit int gas limit used for transactions on testnet chain (default 400000) - --testnet-gasprice string gas price used for transactions on testnet chain (default "0.0000025stake") - --testnet-prefix string address prefix of the testnet chain (default "cosmos") -``` - -**Options inherited from parent commands** - -``` - --local Use local SPN network - --nightly Use nightly SPN network - --spn-faucet-address string SPN faucet address (default "https://faucet.devnet.ignite.com:443") - --spn-node-address string SPN node address (default "https://rpc.devnet.ignite.com:443") -``` - -**SEE ALSO** - -* [ignite network reward](#ignite-network-reward) - Manage network rewards - - -## ignite network reward set - -set a network chain reward - -``` -ignite network reward set [launch-id] [last-reward-height] [coins] [flags] -``` - -**Options** - -``` - --from string account name to use for sending transactions to SPN (default "default") - -h, --help help for set - --home string home directory used for blockchains - --keyring-backend string keyring backend to store your account keys (default "test") - --keyring-dir string accounts keyring directory (default "/home/runner/.ignite/accounts") -``` - -**Options inherited from parent commands** - -``` - --local Use local SPN network - --nightly Use nightly SPN network - --spn-faucet-address string SPN faucet address (default "https://faucet.devnet.ignite.com:443") - --spn-node-address string SPN node address (default "https://rpc.devnet.ignite.com:443") -``` - -**SEE ALSO** - -* [ignite network reward](#ignite-network-reward) - Manage network rewards - - ## ignite network tool Commands to run subsidiary tools @@ -3046,6 +2939,7 @@ Transactions subcommands --address-prefix string account address prefix (default "cosmos") --fees string fees to pay along with transaction; eg: 10uatom --gas string gas limit to set per-transaction; set to "auto" to calculate sufficient gas automatically (default "auto") + --gas-adjustment float gas adjustment to set per-transaction --gas-prices string gas prices in decimal format to determine the transaction fee (e.g. 0.1uatom) --generate-only build an unsigned transaction and write it to STDOUT -h, --help help for tx @@ -3082,6 +2976,7 @@ Bank transaction subcommands --address-prefix string account address prefix (default "cosmos") --fees string fees to pay along with transaction; eg: 10uatom --gas string gas limit to set per-transaction; set to "auto" to calculate sufficient gas automatically (default "auto") + --gas-adjustment float gas adjustment to set per-transaction --gas-prices string gas prices in decimal format to determine the transaction fee (e.g. 0.1uatom) --generate-only build an unsigned transaction and write it to STDOUT --home string directory where the blockchain node is initialized @@ -3116,6 +3011,7 @@ ignite node tx bank send [from_account_or_address] [to_account_or_address] [amou --address-prefix string account address prefix (default "cosmos") --fees string fees to pay along with transaction; eg: 10uatom --gas string gas limit to set per-transaction; set to "auto" to calculate sufficient gas automatically (default "auto") + --gas-adjustment float gas adjustment to set per-transaction --gas-prices string gas prices in decimal format to determine the transaction fee (e.g. 0.1uatom) --generate-only build an unsigned transaction and write it to STDOUT --home string directory where the blockchain node is initialized @@ -3129,167 +3025,6 @@ ignite node tx bank send [from_account_or_address] [to_account_or_address] [amou * [ignite node tx bank](#ignite-node-tx-bank) - Bank transaction subcommands -## ignite plugin - -Handle plugins - -**Options** - -``` - -h, --help help for plugin -``` - -**SEE ALSO** - -* [ignite](#ignite) - Ignite CLI offers everything you need to scaffold, test, build, and launch your blockchain -* [ignite plugin add](#ignite-plugin-add) - Adds a plugin declaration to a plugin configuration -* [ignite plugin describe](#ignite-plugin-describe) - Output information about the a registered plugin -* [ignite plugin list](#ignite-plugin-list) - List declared plugins and status -* [ignite plugin remove](#ignite-plugin-remove) - Removes a plugin declaration from a chain's plugin configuration -* [ignite plugin scaffold](#ignite-plugin-scaffold) - Scaffold a new plugin -* [ignite plugin update](#ignite-plugin-update) - Update plugins - - -## ignite plugin add - -Adds a plugin declaration to a plugin configuration - -**Synopsis** - -Adds a plugin declaration to a plugin configuration. -Respects key value pairs declared after the plugin path to be added to the -generated configuration definition. -Example: - ignite plugin add github.com/org/my-plugin/ foo=bar baz=qux - -``` -ignite plugin add [path] [key=value]... [flags] -``` - -**Options** - -``` - -g, --global use global plugins configuration ($HOME/.ignite/plugins/plugins.yml) - -h, --help help for add -``` - -**SEE ALSO** - -* [ignite plugin](#ignite-plugin) - Handle plugins - - -## ignite plugin describe - -Output information about the a registered plugin - -**Synopsis** - -Output information about a registered plugins commands and hooks. - -``` -ignite plugin describe [path] [flags] -``` - -**Options** - -``` - -h, --help help for describe -``` - -**SEE ALSO** - -* [ignite plugin](#ignite-plugin) - Handle plugins - - -## ignite plugin list - -List declared plugins and status - -**Synopsis** - -Prints status and information of declared plugins - -``` -ignite plugin list [flags] -``` - -**Options** - -``` - -h, --help help for list -``` - -**SEE ALSO** - -* [ignite plugin](#ignite-plugin) - Handle plugins - - -## ignite plugin remove - -Removes a plugin declaration from a chain's plugin configuration - -``` -ignite plugin remove [path] [flags] -``` - -**Options** - -``` - -g, --global use global plugins configuration ($HOME/.ignite/plugins/plugins.yml) - -h, --help help for remove -``` - -**SEE ALSO** - -* [ignite plugin](#ignite-plugin) - Handle plugins - - -## ignite plugin scaffold - -Scaffold a new plugin - -**Synopsis** - -Scaffolds a new plugin in the current directory with the given repository path configured. A git repository will be created with the given module name, unless the current directory is already a git repository. - -``` -ignite plugin scaffold [github.com/org/repo] [flags] -``` - -**Options** - -``` - -h, --help help for scaffold -``` - -**SEE ALSO** - -* [ignite plugin](#ignite-plugin) - Handle plugins - - -## ignite plugin update - -Update plugins - -**Synopsis** - -Updates a plugin specified by path. If no path is specified all declared plugins are updated - -``` -ignite plugin update [path] [flags] -``` - -**Options** - -``` - -h, --help help for update -``` - -**SEE ALSO** - -* [ignite plugin](#ignite-plugin) - Handle plugins - - ## ignite relayer Connect blockchains with an IBC relayer @@ -3512,6 +3247,7 @@ ignite scaffold chain [name] [flags] --clear-cache clear the build cache (advanced) -h, --help help for chain --no-module create a project without a default module + --params strings add default module parameters -p, --path string create a project in a specific path --skip-git skip Git repository initialization ``` @@ -4043,7 +3779,6 @@ Tools for advanced users * [ignite](#ignite) - Ignite CLI offers everything you need to scaffold, test, build, and launch your blockchain * [ignite tools ibc-relayer](#ignite-tools-ibc-relayer) - TypeScript implementation of an IBC relayer * [ignite tools ibc-setup](#ignite-tools-ibc-setup) - Collection of commands to quickly setup a relayer -* [ignite tools protoc](#ignite-tools-protoc) - Execute the protoc command ## ignite tools ibc-relayer @@ -4097,35 +3832,6 @@ ignite tools ibc-setup -- init --src relayer_test_1 --dest relayer_test_2 * [ignite tools](#ignite-tools) - Tools for advanced users -## ignite tools protoc - -Execute the protoc command - -**Synopsis** - -The protoc command. You don't need to setup the global protoc include folder with -I, it's automatically handled - -``` -ignite tools protoc [--] [...] [flags] -``` - -**Examples** - -``` -ignite tools protoc -- --version -``` - -**Options** - -``` - -h, --help help for protoc -``` - -**SEE ALSO** - -* [ignite tools](#ignite-tools) - Tools for advanced users - - ## ignite version Print the current build information