Ignite CLI is the all-in-one platform to build, launch, and maintain gno.land smart contracts. It is a developer-friendly interface to gno.land, the smart contract platform from the Ignite team. Ignite CLI offers everything you need to scaffold, test, build, and launch your realms and packages.

Ignite CLI also ships the Cosmos SDK tooling under ignite cosmos for building sovereign blockchains.

Quick start

Scaffold a realm and start a local gno.land dev chain:

ignite scaffold realm counter
cd counter
ignite chain serve

The dev chain runs on tcp://127.0.0.1:26657, pre-funds the test1 developer account, deploys your realm at genesis, and reloads the chain on every .gno file change.

Interact with the running chain:

ignite chain call gno.land/r/counter Increment   # invoke a realm function
ignite chain query "gno.land/r/counter.Get()"   # read-only expression
ignite chain send g1... 10000000ugnot            # fund an account
ignite chain test                               # run _test.gno tests

Generate a typed TypeScript client for the realm (built on gno-js-client):

ignite generate ts-client

Deploy a package to any gno.land chain (module path read from gnomod.toml):

ignite chain deploy --from test1 --remote 127.0.0.1:26657

Manage keys (stored in the gno keybase, ~/.config/gno):

ignite account create alice
ignite account list
ignite account export alice --output alice.asc

Installation

Install Ignite using Homebrew on macOS and GNU/Linux:

brew install ignite

Or manually using the following command:

curl https://get.ignite.com/cli! | bash

sudo mv ignite /usr/local/bin

mkdir /usr/local/bin
sudo chown -R $(whoami) /usr/local/bin

To create and start a blockchain:

ignite scaffold chain mars

cd mars

ignite chain serve

The instructions for installing Ignite CLI manually and configuring your system are provided below.

curl https://get.ignite.com/cli! | bash

make install

ignite version

Alternatively, you can open Ignite CLI directly in your web browser via GitHub Codespaces: Open in GitHub Codespaces.

Documentation

To learn how to use Ignite CLI, check out the Ignite CLI docs. To learn more about how to build blockchain apps with Ignite CLI, see the Ignite CLI Developer Tutorials.

To install Ignite CLI locally on GNU, Linux, or macOS, see Install Ignite CLI.

To learn more about building a JavaScript frontend for your Cosmos SDK blockchain, see ignite/web.

Questions

For questions and support, ask easily on GitHub Discussions. The issue list in this repo is exclusively for bug reports and feature requests.

Cosmos SDK compatibility

The Cosmos SDK tooling lives under ignite cosmos. Blockchains created with it use the Cosmos SDK framework. To ensure the best possible experience, use the version of Ignite CLI that corresponds to the version of Cosmos SDK that your blockchain is built with. Unless noted otherwise, a row refers to a minor version and all associated patch versions.

To upgrade your blockchain to the newer version of Cosmos SDK, see the Migration guide.

Ignite Apps

Ignite Apps aims to extend the functionality of Ignite CLI, offering both official and community-contributed integrations. These integrations are designed to streamline development processes and offer valuable insights for blockchain app developers.

Discover Ignite Apps

You can discover available Ignite Apps in the Ignite Marketplace. The marketplace features a variety of apps that can enhance your development experience, including tools for scaffolding, deploying, and more.

How to Install an Ignite App

ignite app install -g github.com/ignite/apps/[app-name]

The ignite app list command allows to list the plugins and their status, and to update a plugin if you need to get the latest version.

How to Create an App

Scaffold your Ignite app with one simple command:

ignite scaffold app path/to/your/app

Afterwards, install using:

ignite app install -g path/to/your/app

For more information, refer to Creating Ignite Apps.

Also check out the section of our example Apps.

Contributing to Ignite CLI

We welcome contributions from everyone. The main branch contains the development version of the code. You can create a branch from main and create a pull request, or maintain your own fork and submit a cross-repository pull request.

Our Ignite CLI bounty program provides incentives for your participation and pays rewards. Track new, in-progress, and completed bounties in the GitHub Issues board.

Important Before you start implementing a new Ignite CLI feature, the first step is to create an issue on GitHub that describes the proposed changes.

If you're not sure where to start, check out contributing.md for our guidelines and policies for how we develop Ignite CLI. Thank you to everyone who has contributed to Ignite CLI!

Community

Ignite CLI is a free and open source product maintained by Ignite. Here's where you can find us. Stay in touch.

• ignite.com website
• @ignite on Twitter
• ignite.com/blog
• Ignite YouTube
• Ignite docs
• Ignite jobs