From bef48f04e39686e92f416b62789b9c614bbca176 Mon Sep 17 00:00:00 2001 From: julienrbrt <29894366+julienrbrt@users.noreply.github.com> Date: Mon, 13 Jan 2025 07:46:27 +0000 Subject: [PATCH] docs(cli): update generated docs --- docs/docs/08-references/01-cli.md | 35 +++++++++++++++++++++++++++++++ 1 file changed, 35 insertions(+) diff --git a/docs/docs/08-references/01-cli.md b/docs/docs/08-references/01-cli.md index 72fc9974ef..9e2f1d2bf4 100644 --- a/docs/docs/08-references/01-cli.md +++ b/docs/docs/08-references/01-cli.md @@ -2599,6 +2599,7 @@ with an "--ibc" flag. Note that the default module is not IBC-enabled. * [ignite](#ignite) - Ignite CLI offers everything you need to scaffold, test, build, and launch your blockchain * [ignite scaffold chain](#ignite-scaffold-chain) - New Cosmos SDK blockchain +* [ignite scaffold chain-registry](#ignite-scaffold-chain-registry) - Configs for the chain registry * [ignite scaffold configs](#ignite-scaffold-configs) - Configs for a custom Cosmos SDK module * [ignite scaffold list](#ignite-scaffold-list) - CRUD for data stored as an array * [ignite scaffold map](#ignite-scaffold-map) - CRUD for data stored as key-value pairs @@ -2684,6 +2685,40 @@ ignite scaffold chain [name] [flags] * [ignite scaffold](#ignite-scaffold) - Create a new blockchain, module, message, query, and more +## ignite scaffold chain-registry + +Configs for the chain registry + +**Synopsis** + +Scaffold the chain registry chain.json and assets.json files. + +The chain registry is a GitHub repo, hosted at https://github.com/cosmos/cosmos-registry, that +contains the chain.json and assets.json files of most of chains in the Cosmos ecosystem. +It is good practices, when creating a new chain, and about to launch a testnet or mainnet, to +publish the chain's metadata in the chain registry. + +Read more about the chain.json at https://github.com/cosmos/chain-registry?tab=readme-ov-file#chainjson +Read more about the assets.json at https://github.com/cosmos/chain-registry?tab=readme-ov-file#assetlists + +``` +ignite scaffold chain-registry [flags] +``` + +**Options** + +``` + --clear-cache clear the build cache (advanced) + -h, --help help for chain-registry + -p, --path string path of the app (default ".") + -y, --yes answers interactive yes/no questions with yes +``` + +**SEE ALSO** + +* [ignite scaffold](#ignite-scaffold) - Create a new blockchain, module, message, query, and more + + ## ignite scaffold configs Configs for a custom Cosmos SDK module