Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/docs.go
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ package docs

import "embed"

// Docs are Ignite CLI docs.
// Docs are IGNITE® CLI docs.
//
//go:embed docs
var Docs embed.FS
16 changes: 8 additions & 8 deletions docs/docs/01-welcome/01-index.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,24 +4,24 @@ slug: /welcome

import ProjectsTable from '@site/src/components/ProjectsTable';

# Introduction to Ignite CLI: Your Gateway to Blockchain Innovation
# Introduction to IGNITE® CLI: Your Gateway to Blockchain Innovation

[Ignite CLI](https://github.com/ignite/cli) is a powerful tool that simplifies the journey of building, testing, and launching diverse blockchain applications. Developed on top of the [Cosmos SDK](https://docs.cosmos.network), the leading framework for blockchain technology, Ignite CLI is pivotal in streamlining the development process. It enables developers to focus on the unique aspects of their projects, from DeFi and NFTs to supply chain solutions and smart contracts.
Beyond these, Ignite has been instrumental in a wide array of blockchain applications, ranging from VPNs and gaming platforms to blogs, oracle systems, and innovative consensus mechanisms. This demonstrates its versatility in supporting a broad spectrum of blockchain-based solutions.
[IGNITE® CLI](https://github.com/ignite/cli) is a powerful tool that simplifies the journey of building, testing, and launching diverse blockchain applications. Developed on top of the [Cosmos SDK](https://docs.cosmos.network), the leading framework for blockchain technology, IGNITE® CLI is pivotal in streamlining the development process. It enables developers to focus on the unique aspects of their projects, from DeFi and NFTs to supply chain solutions and smart contracts.
Beyond these, IGNITE® has been instrumental in a wide array of blockchain applications, ranging from VPNs and gaming platforms to blogs, oracle systems, and innovative consensus mechanisms. This demonstrates its versatility in supporting a broad spectrum of blockchain-based solutions.

## Key Features of Ignite CLI
## Key Features of IGNITE® CLI

- **Simplified Blockchain Development:** Ignite CLI, leveraging Cosmos SDK, makes building sovereign application-specific blockchains intuitive and efficient.
- **Simplified Blockchain Development:** IGNITE® CLI, leveraging Cosmos SDK, makes building sovereign application-specific blockchains intuitive and efficient.
- **Comprehensive Scaffolding:** Easily scaffold modules, messages, CRUD operations, IBC packets, and more, expediting the development of complex functionalities.
- **Development with Live Reloading:** Start and test your blockchain node with real-time updates, enhancing your development workflow.
- **Frontend Flexibility:** Utilize pre-built templates for Vue.js, React, Typescript or Go, catering to diverse frontend development needs.
- **Inter-Blockchain Communication (IBC):** Seamlessly connect and interact with other blockchains using an integrated IBC relayer, a key feature of the Cosmos SDK.
- **CometBFT Integration:** Built with the CometBFT consensus engine (formerly Tendermint), ensuring robust consensus mechanisms in your blockchain solutions.
- **Cross-Domain Applications:** Ignite is perfectly suited for developing a diverse array of use cases across various sectors. These include DeFi, NFTs, supply chain management, smart contracts (both EVM and WASM), and decentralized exchanges (DEXes).
- **Cross-Domain Applications:** IGNITE® is perfectly suited for developing a diverse array of use cases across various sectors. These include DeFi, NFTs, supply chain management, smart contracts (both EVM and WASM), and decentralized exchanges (DEXes).

## Embracing the Cosmos Ecosystem

Ignite CLI is your entry point into the vibrant Cosmos ecosystem, a hub of innovation where you can explore a range of applications, from wallets and explorers to smart contracts and DEXes, all powered by CometBFT and the Cosmos SDK.
IGNITE® CLI is your entry point into the vibrant Cosmos ecosystem, a hub of innovation where you can explore a range of applications, from wallets and explorers to smart contracts and DEXes, all powered by CometBFT and the Cosmos SDK.
This ecosystem is home to over [$100 billion worth of blockchain projects](https://cosmos.network/ecosystem/tokens/), showcasing the scalability and versatility of the technologies at play.

## Projects using Tendermint and Cosmos SDK
Expand All @@ -30,7 +30,7 @@ Many projects already showcase the Tendermint BFT consensus engine and the Cosmo
the [Cosmos ecosystem](https://cosmos.network/ecosystem/apps) to discover a wide variety of apps, blockchains, wallets,
and explorers that are built in the Cosmos ecosystem.

## Projects building with Ignite CLI
## Projects building with IGNITE® CLI

<ProjectsTable data={[
{ name: "Stride Labs", logo: "img/logo/stride.svg"},
Expand Down
36 changes: 18 additions & 18 deletions docs/docs/01-welcome/02-install.md
Original file line number Diff line number Diff line change
@@ -1,42 +1,42 @@
---
sidebar_position: 1
description: Steps to install Ignite CLI on your local computer.
description: Steps to install IGNITE® CLI on your local computer.
---

# Install Ignite CLI
# Install IGNITE® CLI

You can run [Ignite CLI](https://github.com/ignite/cli) in a web-based IDE or you can install Ignite CLI on your local computer.
You can run [IGNITE® CLI](https://github.com/ignite/cli) in a web-based IDE or you can install IGNITE® CLI on your local computer.

## Prerequisites

Be sure you have met the prerequisites before you install and use Ignite CLI.
Be sure you have met the prerequisites before you install and use IGNITE® CLI.

### Operating systems

Ignite CLI is supported for the following operating systems:
IGNITE® CLI is supported for the following operating systems:

- GNU/Linux
- macOS
- Windows Subsystem for Linux (WSL)

### Go

Ignite CLI is written in the Go programming language. To use Ignite CLI on a local system:
IGNITE® CLI is written in the Go programming language. To use IGNITE® CLI on a local system:

- Install [Go](https://golang.org/doc/install) (**version 1.24.1** or higher)
- Ensure the Go environment variables are [set properly](https://golang.org/doc/gopath_code#GOPATH) on your system

## Verify your Ignite CLI version
## Verify your IGNITE® CLI version

To verify the version of Ignite CLI you have installed, run the following command:
To verify the version of IGNITE® CLI you have installed, run the following command:

```bash
ignite version
```

## Installing Ignite CLI
## Installing IGNITE® CLI

To install the latest version of Ignite use [HomeBrew](https://formulae.brew.sh/formula/ignite) on macOS and GNU/Linux:
To install the latest version of IGNITE® use [HomeBrew](https://formulae.brew.sh/formula/ignite) on macOS and GNU/Linux:

```sh
brew install ignite
Expand All @@ -53,7 +53,7 @@ curl https://get.ignite.com/cli! | bash
This command invokes `curl` to download the installation script and pipes the output to `bash` to perform the
installation. The `ignite` binary is installed in `/usr/local/bin`.

Ignite CLI installation requires write permission to the `/usr/local/bin/` directory. If the installation fails because
IGNITE® CLI installation requires write permission to the `/usr/local/bin/` directory. If the installation fails because
you do not have write permission to `/usr/local/bin/`, run the following command:

```bash
Expand Down Expand Up @@ -83,18 +83,18 @@ sudo curl https://get.ignite.com/cli | sudo bash
To learn more or customize the installation process, see the [installer docs](https://github.com/ignite/installer) on
GitHub.

## Upgrading your Ignite CLI installation {#upgrade}
## Upgrading your IGNITE® CLI installation {#upgrade}

Before you install a new version of Ignite CLI, remove all existing Ignite CLI installations.
Before you install a new version of IGNITE® CLI, remove all existing IGNITE® CLI installations.

To remove the current Ignite CLI installation:
To remove the current IGNITE® CLI installation:

1. On your terminal window, press `Ctrl+C` to stop the chain that you started with `ignite chain serve`.
2. Remove the Ignite CLI binary with `rm $(which ignite)`.
2. Remove the IGNITE® CLI binary with `rm $(which ignite)`.
Depending on your user permissions, run the command with or without `sudo`.
3. Repeat this step until all `ignite` installations are removed from your system.

After all existing Ignite CLI installations are removed, follow the [Installing Ignite CLI](#installing-ignite-cli)
After all existing IGNITE® CLI installations are removed, follow the [Installing IGNITE® CLI](#installing-ignite-cli)
instructions.

For details on version features and changes, see
Expand All @@ -113,7 +113,7 @@ cd cli && make install
## Summary

- Verify the prerequisites.
- To set up a local development environment, install Ignite CLI locally on your computer.
- Install Ignite CLI by fetching the binary using cURL or by building from source.
- To set up a local development environment, install IGNITE® CLI locally on your computer.
- Install IGNITE® CLI by fetching the binary using cURL or by building from source.
- The latest version is installed by default. You can install previous versions of the precompiled `ignite` binary.
- Stop the chain and remove existing versions before installing a new version.
18 changes: 9 additions & 9 deletions docs/docs/02-guide/02-introduction.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,29 +4,29 @@ sidebar_position: 2

# Introduction

In this guide, we will be using Ignite CLI to create a new blockchain. Ignite
In this guide, we will be using IGNITE® CLI to create a new blockchain. IGNITE®
CLI is a command line interface that allows users to quickly and easily create
blockchain networks. By using Ignite CLI, we can quickly create a new blockchain
blockchain networks. By using IGNITE® CLI, we can quickly create a new blockchain
without having to manually set up all the necessary components.

Once we have created our blockchain with Ignite CLI, we will take a look at the
Once we have created our blockchain with IGNITE® CLI, we will take a look at the
directory structure and files that were created. This will give us an
understanding of how the blockchain is organized and how the different
components of the blockchain interact with each other.

By the end of this guide, you will have a basic understanding of how to use
Ignite CLI to create a new blockchain, and you will have a high-level
IGNITE® CLI to create a new blockchain, and you will have a high-level
understanding of the directory structure and files that make up a blockchain.
This knowledge will be useful as you continue to explore the world of blockchain
development.

If you are looking for more tutorials and hands-on experience, check out our tutorials website:

[Ignite Tutorials](https://tutorials.ignite.com)
[IGNITE® Tutorials](https://tutorials.ignite.com)

## Creating a new blockchain

To create a new blockchain project with Ignite, you will need to run the
To create a new blockchain project with IGNITE®, you will need to run the
following command:

```
Expand All @@ -49,15 +49,15 @@ the chain's configuration, application logic, and tests, among others. It
provides a starting point for developers to quickly set up a new Cosmos SDK
blockchain and build their desired functionality on top of it.

By default, Ignite creates a new empty custom module with the same name as the
By default, IGNITE® creates a new empty custom module with the same name as the
blockchain being created (in this case, `example`) in the `x/` directory. This
module doesn't have any functionality by itself, but can serve as a starting
point for building out the features of your application. If you don't want to
create this module, you can use the `--no-module` flag to skip it.

## Directory structure

In order to understand what the Ignite CLI has generated for your project, you
In order to understand what the IGNITE® CLI has generated for your project, you
can inspect the contents of the `example/` directory.

The `app/` directory contains the files that connect the different parts of the
Expand Down Expand Up @@ -145,7 +145,7 @@ the code can be reflected in the running blockchain without having to restart
the node. This allows for faster development and testing of the blockchain.

**Congratulations!** 🥳 You have successfully created a brand-new Cosmos blockchain
using the Ignite CLI. This blockchain uses the delegated proof of stake (DPoS)
using the IGNITE® CLI. This blockchain uses the delegated proof of stake (DPoS)
consensus algorithm, and comes with a set of standard modules for token
transfers, governance, and inflation. Now that you have a basic understanding of
your Cosmos blockchain, it's time to start building custom functionality. In the
Expand Down
6 changes: 3 additions & 3 deletions docs/docs/02-guide/03-hello-world.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,11 @@ description: Build your first blockchain and your first Cosmos SDK query.
title: Hello World
---

# "Hello world!" Blockchain Tutorial with Ignite CLI
# "Hello world!" Blockchain Tutorial with IGNITE® CLI

**Introduction**

In this tutorial, you'll build a simple blockchain using Ignite CLI that responds to a custom query with `Hello %s!`, where `%s` is a name passed in the query.
In this tutorial, you'll build a simple blockchain using IGNITE® CLI that responds to a custom query with `Hello %s!`, where `%s` is a name passed in the query.
This will enhance your understanding of creating custom queries in a Cosmos SDK blockchain.

## Setup and Scaffold
Expand Down Expand Up @@ -93,4 +93,4 @@ Expect a response: `Hello world!`

## Conclusion

Congratulations! 🎉 You've successfully created a blockchain module with a custom query using Ignite CLI. Through this tutorial, you've learned how to scaffold a chain, add a custom query, and modify the logic for personalized responses. This experience illustrates the power of Ignite CLI in streamlining blockchain development and the importance of understanding the underlying code for customization.
Congratulations! 🎉 You've successfully created a blockchain module with a custom query using IGNITE® CLI. Through this tutorial, you've learned how to scaffold a chain, add a custom query, and modify the logic for personalized responses. This experience illustrates the power of IGNITE® CLI in streamlining blockchain development and the importance of understanding the underlying code for customization.
18 changes: 9 additions & 9 deletions docs/docs/02-guide/04-ibc.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ between blockchains with the Cosmos SDK.
**You will learn how to**

- Use IBC to create and send packets between blockchains.
- Navigate between blockchains using the Cosmos SDK and the Ignite CLI Relayer.
- Navigate between blockchains using the Cosmos SDK and the IGNITE® CLI Relayer.
- Create a basic blog post and save the post on another blockchain.

## What is IBC?
Expand All @@ -33,7 +33,7 @@ blockchain.

The IBC relayer lets you connect between sets of IBC-enabled chains. This
tutorial teaches you how to create two blockchains and then start and use the
relayer with Ignite CLI to connect two blockchains.
relayer with IGNITE® CLI to connect two blockchains.

This tutorial covers essentials like modules, IBC packets, relayer, and the
lifecycle of packets routed through IBC.
Expand Down Expand Up @@ -68,7 +68,7 @@ post is saved on both blockchains.

## Build your blockchain app

Use Ignite CLI to scaffold the blockchain app and the blog module.
Use IGNITE® CLI to scaffold the blockchain app and the blog module.

### Build a new blockchain

Expand All @@ -84,7 +84,7 @@ directory contains a working blockchain app.

### Scaffold the blog module inside your blockchain

Next, use Ignite CLI to scaffold a blog module with IBC capabilities. The blog
Next, use IGNITE® CLI to scaffold a blog module with IBC capabilities. The blog
module contains the logic for creating blog posts and routing them through IBC
to the second blockchain.

Expand Down Expand Up @@ -129,7 +129,7 @@ ignite scaffold list timeoutPost title chain creator --no-message --module blog
The scaffolded code includes proto files for defining data structures, messages,
messages handlers, keepers for modifying the state, and CLI commands.

### Ignite CLI Scaffold List Command Overview
### IGNITE® CLI Scaffold List Command Overview

```
ignite scaffold list [typeName] [field1] [field2] ... [flags]
Expand All @@ -143,7 +143,7 @@ The next arguments define the fields that are associated with the type. For the
blog app, you created `title`, `content`, `postID`, and `chain` fields.

The `--module` flag defines which module the new transaction type is added to.
This optional flag lets you manage multiple modules within your Ignite CLI app.
This optional flag lets you manage multiple modules within your IGNITE® CLI app.
When the flag is not present, the type is scaffolded in the module that matches
the name of the repo.

Expand Down Expand Up @@ -295,7 +295,7 @@ created the message, use an identifier in the following format:

`<portID>-<channelID>-<creatorAddress>`

Finally, the Ignite CLI-generated AppendPost function returns the ID of the new
Finally, the IGNITE® CLI-generated AppendPost function returns the ID of the new
appended post. You can return this value to the source chain through
acknowledgment.

Expand Down Expand Up @@ -506,7 +506,7 @@ ignite app install -g github.com/ignite/apps/hermes
```

If you previously used the relayer, follow these steps to remove exiting relayer
and Ignite CLI configurations:
and IGNITE® CLI configurations:

- Stop your blockchains and delete previous configuration files:

Expand Down Expand Up @@ -664,6 +664,6 @@ Here's what you accomplished in this tutorial:

- Built two Hello blockchain apps as IBC modules
- Modified the generated code to add CRUD action logic
- Configured and used the Ignite CLI relayer to connect two blockchains with
- Configured and used the IGNITE® CLI relayer to connect two blockchains with
each other
- Transferred IBC packets from one blockchain to another
4 changes: 2 additions & 2 deletions docs/docs/02-guide/05-debug.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ description: Debugging your Cosmos SDK blockchain

# Debugging a chain

Ignite chain debug command can help you find issues during development. It uses
IGNITE® chain debug command can help you find issues during development. It uses
[Delve](https://github.com/go-delve/delve) debugger which enables you to
interact with your blockchain app by controlling the execution of the process,
evaluating variables, and providing information of thread / goroutine state, CPU
Expand Down Expand Up @@ -138,7 +138,7 @@ Connect to Server" and enter the debug host address and then the port number.

## Example: Debugging a Blockchain App

In this short example we will be using Ignite CLI to create a new blockchain and
In this short example we will be using IGNITE® CLI to create a new blockchain and
a query to be able to trigger a debugging breakpoint when the query is called.

Create a new blockchain:
Expand Down
Loading
Loading