From 634f7c04199cec609a9846f1819b2848c93a1302 Mon Sep 17 00:00:00 2001 From: julienrbrt <29894366+julienrbrt@users.noreply.github.com> Date: Mon, 22 Jul 2024 18:32:45 +0000 Subject: [PATCH] docs(cli): update generated docs --- docs/docs/08-references/01-cli.md | 222 +----------------------------- 1 file changed, 1 insertion(+), 221 deletions(-) diff --git a/docs/docs/08-references/01-cli.md b/docs/docs/08-references/01-cli.md index e15f6b37a1..4d7f48e27d 100644 --- a/docs/docs/08-references/01-cli.md +++ b/docs/docs/08-references/01-cli.md @@ -35,7 +35,6 @@ To get started, create a blockchain: * [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 relayer](#ignite-relayer) - Connect blockchains with an IBC relayer * [ignite scaffold](#ignite-scaffold) - Create a new blockchain, module, message, query, and more * [ignite version](#ignite-version) - Print the current build information @@ -49,7 +48,7 @@ Create, delete, and show Ignite accounts Commands for managing Ignite accounts. An Ignite account is a private/public keypair stored in a keyring. Currently Ignite accounts are used when interacting -with Ignite relayer commands and when using "ignite network" commands. +with Ignite Apps (namely ignite relayer, ignite network and ignite connect). Note: Ignite account commands are not for managing your chain's keys and accounts. Use you chain's binary to manage accounts from "config.yml". For example, if your @@ -2622,225 +2621,6 @@ ignite network version [flags] * [ignite network](#ignite-network) - Launch a blockchain in production -## ignite node - -Make requests to a live blockchain node - -**Options** - -``` - -h, --help help for node - --node string : to tendermint rpc interface for this chain (default "https://rpc.cosmos.directory:443/cosmoshub") -``` - -**SEE ALSO** - -* [ignite](#ignite) - Ignite CLI offers everything you need to scaffold, test, build, and launch your blockchain -* [ignite node query](#ignite-node-query) - Querying subcommands -* [ignite node tx](#ignite-node-tx) - Transactions subcommands - - -## ignite node query - -Querying subcommands - -**Options** - -``` - -h, --help help for query -``` - -**Options inherited from parent commands** - -``` - --node string : to tendermint rpc interface for this chain (default "https://rpc.cosmos.directory:443/cosmoshub") -``` - -**SEE ALSO** - -* [ignite node](#ignite-node) - Make requests to a live blockchain node -* [ignite node query bank](#ignite-node-query-bank) - Querying commands for the bank module -* [ignite node query tx](#ignite-node-query-tx) - Query for transaction by hash - - -## ignite node query bank - -Querying commands for the bank module - -**Options** - -``` - -h, --help help for bank -``` - -**Options inherited from parent commands** - -``` - --node string : to tendermint rpc interface for this chain (default "https://rpc.cosmos.directory:443/cosmoshub") -``` - -**SEE ALSO** - -* [ignite node query](#ignite-node-query) - Querying subcommands -* [ignite node query bank balances](#ignite-node-query-bank-balances) - Query for account balances by account name or address - - -## ignite node query bank balances - -Query for account balances by account name or address - -``` -ignite node query bank balances [from_account_or_address] [flags] -``` - -**Options** - -``` - --address-prefix string account address prefix (default "cosmos") - --count-total count total number of records in all balances to query for - -h, --help help for balances - --home string directory where the blockchain node is initialized - --keyring-backend string keyring backend to store your account keys (default "test") - --keyring-dir string accounts keyring directory (default "/home/runner/.ignite/accounts") - --limit uint pagination limit of all balances to query for (default 100) - --offset uint pagination offset of all balances to query for - --page uint pagination page of all balances to query for. This sets offset to a multiple of limit (default 1) - --page-key string pagination page-key of all balances to query for - --reverse results are sorted in descending order -``` - -**Options inherited from parent commands** - -``` - --node string : to tendermint rpc interface for this chain (default "https://rpc.cosmos.directory:443/cosmoshub") -``` - -**SEE ALSO** - -* [ignite node query bank](#ignite-node-query-bank) - Querying commands for the bank module - - -## ignite node query tx - -Query for transaction by hash - -``` -ignite node query tx [hash] [flags] -``` - -**Options** - -``` - -h, --help help for tx -``` - -**Options inherited from parent commands** - -``` - --node string : to tendermint rpc interface for this chain (default "https://rpc.cosmos.directory:443/cosmoshub") -``` - -**SEE ALSO** - -* [ignite node query](#ignite-node-query) - Querying subcommands - - -## ignite node tx - -Transactions subcommands - -**Options** - -``` - --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 - --home string directory where the blockchain node is initialized - --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** - -``` - --node string : to tendermint rpc interface for this chain (default "https://rpc.cosmos.directory:443/cosmoshub") -``` - -**SEE ALSO** - -* [ignite node](#ignite-node) - Make requests to a live blockchain node -* [ignite node tx bank](#ignite-node-tx-bank) - Bank transaction subcommands - - -## ignite node tx bank - -Bank transaction subcommands - -**Options** - -``` - -h, --help help for bank -``` - -**Options inherited from parent commands** - -``` - --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 - --keyring-backend string keyring backend to store your account keys (default "test") - --keyring-dir string accounts keyring directory (default "/home/runner/.ignite/accounts") - --node string : to tendermint rpc interface for this chain (default "https://rpc.cosmos.directory:443/cosmoshub") -``` - -**SEE ALSO** - -* [ignite node tx](#ignite-node-tx) - Transactions subcommands -* [ignite node tx bank send](#ignite-node-tx-bank-send) - Send funds from one account to another. - - -## ignite node tx bank send - -Send funds from one account to another. - -``` -ignite node tx bank send [from_account_or_address] [to_account_or_address] [amount] [flags] -``` - -**Options** - -``` - -h, --help help for send -``` - -**Options inherited from parent commands** - -``` - --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 - --keyring-backend string keyring backend to store your account keys (default "test") - --keyring-dir string accounts keyring directory (default "/home/runner/.ignite/accounts") - --node string : to tendermint rpc interface for this chain (default "https://rpc.cosmos.directory:443/cosmoshub") -``` - -**SEE ALSO** - -* [ignite node tx bank](#ignite-node-tx-bank) - Bank transaction subcommands - - ## ignite relayer Connect blockchains with an IBC relayer