Skip to content

Commit 618be91

Browse files
committed
docs(cmd): update commands to ignite cosmos namespace
1 parent 7b2d7df commit 618be91

23 files changed

Lines changed: 75 additions & 75 deletions

‎ignite/cmd/chain_build.go‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -35,21 +35,21 @@ installs the binary in the $(go env GOPATH)/bin directory.
3535
3636
You can customize the output directory for the binary using a flag:
3737
38-
ignite chain build --output dist
38+
ignite cosmos chain build --output dist
3939
4040
To compile the binary Ignite first compiles protocol buffer (proto) files into
4141
Go source code. Proto files contain required type and services definitions. If
4242
you're using another program to compile proto files, you can use a flag to tell
4343
Ignite to skip the proto compilation step:
4444
45-
ignite chain build --skip-proto
45+
ignite cosmos chain build --skip-proto
4646
4747
Afterwards, Ignite install dependencies specified in the go.mod file. By default
4848
Ignite doesn't check that dependencies of the main module stored in the module
4949
cache have not been modified since they were downloaded. To enforce dependency
5050
checking (essentially, running "go mod verify") use a flag:
5151
52-
ignite chain build --check-dependencies
52+
ignite cosmos chain build --check-dependencies
5353
5454
Next, Ignite identifies the "main" package of the project. By default the "main"
5555
package is located in "cmd/{app}d" directory, where "{app}" is the name of the
@@ -79,7 +79,7 @@ project's source directory. Specify the release targets with GOOS:GOARCH build
7979
tags. If the optional --release.targets is not specified, a binary is created
8080
for your current environment.
8181
82-
ignite chain build --release -t linux:amd64 -t darwin:amd64 -t darwin:arm64
82+
ignite cosmos chain build --release -t linux:amd64 -t darwin:amd64 -t darwin:arm64
8383
`,
8484
Args: cobra.NoArgs,
8585
RunE: chainBuildHandler,

‎ignite/cmd/chain_debug.go‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -44,11 +44,11 @@ JSON-RPC or DAP client connections.
4444
4545
To start a debug server use the following flag:
4646
47-
ignite chain debug --server
47+
ignite cosmos chain debug --server
4848
4949
To start a debug server with a custom address use the following flags:
5050
51-
ignite chain debug --server --server-address 127.0.0.1:30500
51+
ignite cosmos chain debug --server --server-address 127.0.0.1:30500
5252
5353
The debug server stops automatically when the client connection is closed.
5454
`,

‎ignite/cmd/chain_init.go‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -13,10 +13,10 @@ func NewChainInit() *cobra.Command {
1313
c := &cobra.Command{
1414
Use: "init",
1515
Short: "Initialize your chain",
16-
Long: `The init command compiles and installs the binary (like "ignite chain build")
16+
Long: `The init command compiles and installs the binary (like "ignite cosmos chain build")
1717
and uses that binary to initialize the blockchain's data directory for one
18-
validator. To learn how the build process works, refer to "ignite chain build
19-
--help".
18+
validator. To learn how the build process works, refer to "ignite cosmos chain
19+
build --help".
2020
2121
By default, the data directory will be initialized in $HOME/.mychain, where
2222
"mychain" is the name of the project. To set a custom data directory use the

‎ignite/cmd/chain_serve.go‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -37,9 +37,9 @@ func NewChainServe() *cobra.Command {
3737
c := &cobra.Command{
3838
Use: "serve",
3939
Short: "Start a blockchain node in development",
40-
Long: `The serve command compiles and installs the binary (like "ignite chain build"),
40+
Long: `The serve command compiles and installs the binary (like "ignite cosmos chain build"),
4141
uses that binary to initialize the blockchain's data directory for one validator
42-
(like "ignite chain init"), and starts the node locally for development purposes
42+
(like "ignite cosmos chain init"), and starts the node locally for development purposes
4343
with automatic code reloading.
4444
4545
Automatic code reloading means Ignite starts watching the project directory.
@@ -52,19 +52,19 @@ exporting and importing the genesis file.
5252
To force Ignite to start from a clean slate even if a genesis file exists, use
5353
the following flag:
5454
55-
ignite chain serve --reset-once
55+
ignite cosmos chain serve --reset-once
5656
5757
To force Ignite to reset the state every time the source code is modified, use
5858
the following flag:
5959
60-
ignite chain serve --force-reset
60+
ignite cosmos chain serve --force-reset
6161
6262
With Ignite it's possible to start more than one blockchain from the same source
6363
code using different config files. This is handy if you're building
6464
inter-blockchain functionality and, for example, want to try sending packets
6565
from one blockchain to another. To start a node using a specific config file:
6666
67-
ignite chain serve --config mars.yml
67+
ignite cosmos chain serve --config mars.yml
6868
6969
The serve command is meant to be used ONLY FOR DEVELOPMENT PURPOSES. Under the
7070
hood, it runs "appd start", where "appd" is the name of your chain's binary. For

‎ignite/cmd/cmd.go‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -248,17 +248,17 @@ func deprecated() []*cobra.Command {
248248
{
249249
Use: "build",
250250
Hidden: true,
251-
Deprecated: "use `ignite chain build` instead.",
251+
Deprecated: "use `ignite cosmos chain build` instead.",
252252
},
253253
{
254254
Use: "serve",
255255
Hidden: true,
256-
Deprecated: "use `ignite chain serve` instead.",
256+
Deprecated: "use `ignite cosmos chain serve` instead.",
257257
},
258258
{
259259
Use: "faucet",
260260
Hidden: true,
261-
Deprecated: "use `ignite chain faucet` instead.",
261+
Deprecated: "use `ignite cosmos chain faucet` instead.",
262262
},
263263
{
264264
Use: "node",

‎ignite/cmd/generate_typescript_client.go‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,12 +25,12 @@ can customize the output directory in config.yml:
2525
2626
Output can also be customized by using a flag:
2727
28-
ignite generate ts-client --output new-path
28+
ignite cosmos generate ts-client --output new-path
2929
3030
TypeScript client code can be automatically regenerated on reset or source code
3131
changes when the blockchain is started with a flag:
3232
33-
ignite chain serve --generate-clients
33+
ignite cosmos chain serve --generate-clients
3434
`,
3535
RunE: generateTSClientHandler,
3636
}

‎ignite/cmd/scaffold.go‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -30,10 +30,10 @@ const (
3030
msgCommitPrompt = "Do you want to proceed without committing your saved changes"
3131

3232
statusScaffolding = "Scaffolding..."
33-
multipleCoinDisclaimer = `**Disclaimer**
34-
The 'coins' and 'dec.coins' argument types require special attention when used in CLI commands.
35-
Due to current limitations in the AutoCLI, only one variadic (slice) argument is supported per command.
36-
If a message contains more than one field of type 'coins' or 'dec.coins', only the last one will accept multiple values via the CLI.
33+
multipleCoinDisclaimer = `**Disclaimer**
34+
The 'coins' and 'dec.coins' argument types require special attention when used in CLI commands.
35+
Due to current limitations in the AutoCLI, only one variadic (slice) argument is supported per command.
36+
If a message contains more than one field of type 'coins' or 'dec.coins', only the last one will accept multiple values via the CLI.
3737
For the best user experience, manual command handling or scaffolding is recommended when working with messages containing multiple 'coins' or 'dec.coins' fields.
3838
`
3939
)
@@ -47,8 +47,8 @@ func NewScaffold() *cobra.Command {
4747
application.
4848
4949
For details on each scaffolding target (chain, module, message, etc.) run the
50-
corresponding command with a "--help" flag, for example, "ignite scaffold chain
51-
--help".
50+
corresponding command with a "--help" flag, for example, "ignite cosmos
51+
scaffold chain --help".
5252
5353
The Ignite team strongly recommends committing the code to a version control
5454
system before running scaffolding commands. This will make it easier to see the

‎ignite/cmd/scaffold_chain.go‎

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ const (
2525
👉 Get started with the following commands:
2626
2727
%% cd %[1]v
28-
%% ignite chain serve
28+
%% ignite cosmos chain serve
2929
3030
Documentation: https://docs.ignite.com
3131
`
@@ -41,16 +41,16 @@ func NewScaffoldChain() *cobra.Command {
4141
For example, the following command will create a blockchain called "hello" in
4242
the "hello/" directory:
4343
44-
ignite scaffold chain hello
44+
ignite cosmos scaffold chain hello
4545
4646
A project name can be a simple name or a URL. The name will be used as the Go
4747
module path for the project. Examples of project names:
4848
49-
ignite scaffold chain foo
50-
ignite scaffold chain foo/bar
51-
ignite scaffold chain example.org/foo
52-
ignite scaffold chain github.com/username/foo
53-
49+
ignite cosmos scaffold chain foo
50+
ignite cosmos scaffold chain foo/bar
51+
ignite cosmos scaffold chain example.org/foo
52+
ignite cosmos scaffold chain github.com/username/foo
53+
5454
A new directory with source code files will be created in the current directory.
5555
To use a different path use the "--path" flag.
5656
@@ -59,15 +59,15 @@ effectively encapsulates an independent piece of functionality. Following the
5959
Cosmos SDK convention, custom modules are stored inside the "x/" directory. By
6060
default, Ignite creates a module with a name that matches the name of the
6161
project. To create a blockchain without a default module use the "--no-module"
62-
flag. Additional modules can be added after a project is created with "ignite
63-
scaffold module" command.
62+
flag. Additional modules can be added after a project is created with the
63+
"ignite cosmos scaffold module" command.
6464
6565
Account addresses on Cosmos SDK-based blockchains have string prefixes. For
6666
example, the Cosmos Hub blockchain uses the default "cosmos" prefix, so that
6767
addresses look like this: "cosmos12fjzdtqfrrve7zyg9sv8j25azw2ua6tvu07ypf". To
6868
use a custom address prefix use the "--address-prefix" flag. For example:
6969
70-
ignite scaffold chain foo --address-prefix bar
70+
ignite cosmos scaffold chain foo --address-prefix bar
7171
7272
By default when compiling a blockchain's source code Ignite creates a cache to
7373
speed up the build process. To clear the cache when building a blockchain use

‎ignite/cmd/scaffold_configs.go‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,10 +19,10 @@ func NewScaffoldConfigs() *cobra.Command {
1919
2020
A Cosmos SDK module can have configurations. An example of a config is "address prefix" of the
2121
"auth" module. A config can be scaffolded into a module using the "--module-configs" into
22-
the scaffold module command or using the "scaffold configs" command. By default
22+
the scaffold module command or using the "scaffold configs" command. By default
2323
configs are of type "string", but you can specify a type for each config. For example:
2424
25-
ignite scaffold configs foo baz:uint bar:bool
25+
ignite cosmos scaffold configs foo baz:uint bar:bool
2626
2727
Refer to Cosmos SDK documentation to learn more about modules, dependencies and
2828
configs.

‎ignite/cmd/scaffold_list.go‎

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ provides the logic to create, read, update, and delete instances of the type.
3636
For example, let's review a command that generates the code to handle a list of
3737
posts and each post has "title" and "body" fields:
3838
39-
ignite scaffold list post title body
39+
ignite cosmos scaffold list post title body
4040
4141
This provides you with a "Post" type, MsgCreatePost, MsgUpdatePost,
4242
MsgDeletePost and two queries: Post and PostAll. The compiled CLI, let's say the
@@ -53,17 +53,17 @@ different type, you can specify it after a colon ":". The following types are
5353
supported: string, bool, int, uint, coin, array.string, array.int, array.uint,
5454
array.coin. An example of using field types:
5555
56-
ignite scaffold list pool amount:coin tags:array.string height:int
56+
ignite cosmos scaffold list pool amount:coin tags:array.string height:int
5757
58-
For detailed type information use ignite scaffold type --help
58+
For detailed type information use ignite cosmos scaffold type --help
5959
6060
"Index" indicates whether the type can be used as an index in
61-
"ignite scaffold map".
61+
"ignite cosmos scaffold map".
6262
6363
Ignite also supports custom types:
6464
65-
ignite scaffold list product-details name desc
66-
ignite scaffold list product price:coin details:ProductDetails
65+
ignite cosmos scaffold list product-details name desc
66+
ignite cosmos scaffold list product price:coin details:ProductDetails
6767
6868
In the example above the "ProductDetails" type was defined first, and then used
6969
as a custom type for the "details" field.
@@ -76,19 +76,19 @@ By default the code will be scaffolded in the module that matches your project's
7676
name. If you have several modules in your project, you might want to specify a
7777
different module:
7878
79-
ignite scaffold list post title body --module blog
79+
ignite cosmos scaffold list post title body --module blog
8080
8181
By default, each message comes with a "creator" field that represents the
8282
address of the transaction signer. You can customize the name of this field with
8383
a flag:
8484
85-
ignite scaffold list post title body --signer author
85+
ignite cosmos scaffold list post title body --signer author
8686
8787
It's possible to scaffold just the getter/setter logic without the CRUD
8888
messages. This is useful when you want the methods to handle a type, but would
8989
like to scaffold messages manually. Use a flag to skip message scaffolding:
9090
91-
ignite scaffold list post title body --no-message
91+
ignite cosmos scaffold list post title body --no-message
9292
9393
The "creator" field is not generated if a list is scaffolded with the
9494
"--no-message" flag.

0 commit comments

Comments
 (0)