Andromeda
Search…
⌃K

Introduction

This document is a guide to start using the Andromeda CLI.
The CLI is still in beta phase. It may contain bugs and upgrades will probably be released weekly.

Installation

To install the Andromeda CLI, run the following command to download our npm package:
Make sure you have npm installed.
npm install -g @andromedaprotocol/[email protected]
Then run andr to open the CLI:
Andromeda CLI
You can run "version" in the CLI to check the CLI version you have downloaded.

CLI Commands

Now that we have the CLI open, we can start exploring some of its functions which include:
  • Generating keys and managing wallets.
  • Swap between chains with one command.
  • Interact with the chain of your choice
  • Query using our GraphQL server.
The Andromeda CLI is built to work with any of the chains that Andromeda is deployed on. This would remove the need for users to learn how to deploy contracts on each of the chains allowing them to use this CLI to interact with ADOs anywhere on the Cosmos ecosystem.

Deployed Chains

Andromeda is currently deployed on the following chains:
  • Andromeda
  • Juno
  • Stargaze
  • Terra

Getting Started

The first thing to do in the CLI is to choose the chain config and wallets to use.
Run:
chain use
You will be prompted to choose a chain config from a list:
The chain Ids are the same as the ones for the testnets they correspond to.
You can also create your own chain config using the chain new command.
Input the chain ID to use: (Use arrow keys)
❯ uni-5
elgafar-1
galileo-2
pisco-1
exit
Choose the chain config that you want to use.
Then we need to add a wallet. We run:
wallets add
Make sure to save the seed phrase somewhere private and secure as it is the only way to recover your wallet.
You will be prompted to select the wallet name.
If you are using a test-net config make sure to send some tokens to your new address from the corresponding test-net faucet on discord.
If you already have an address, you can import it to the CLI using the recover flag.

CLI Display

You will notice something similar to "? [email protected]>" in the CLI. This signifies which wallet and chain-Id are currently in use. It is formatted in the following way:
? $<Wallet>@<ChainId>>

Start Exploring

We can start off by running andr --help to see what are the available commands.
andr --help
Or just:
help
The --help flag can be used after any command to get information on the command.
You will get a list of available commands to use:
Command
Description
ado
Query and execute on an ADO
chain
Manage Chain Config
clear
Clears the terminal
exit
Exits the CLI
gql
Query using the Andromeda GraphQL service
help
Lists all valid commands
tx
Query transactions
version
Prints the current CLI version.
wallets
Manage wallets
wasm
Send CosmWasm messages to the chain
It is important to note that the CLI has been designed to prompt the user for the required fields in each command. This means that it is sufficient to write the command without the fields and the CLI will prompt you to fill in the inputs one by one instead of throwing an error.