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.
Make sure you have npm installed.
sudo npm i -g @andromedaprotocol/cli
We use sudo since we are installing globally using the -g flag.
If you have the package already installed, you can run the following to update to the latest version:
sudo npm update -g @andromedaprotocol/cli
Then run
andr to open the CLI:
Andromeda CLI
You can run "
version" in the CLI to check the CLI version you have downloaded.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.
Andromeda is currently deployed on the following chains:
- Andromeda
- Juno
- Stargaze
- Terra
Currently, Andromeda, Juno, and Stargaze testnets are functional.
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.
? Input the chain ID to use:
elgafar1
pisco1
sei-network
injective
❯ galileo3
junotestnet
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 testnet config make sure to send some tokens to your new address from the corresponding testnet faucet (Usually on discord).
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>>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 |
|---|---|
Query and execute on an ADO | |
Manage Chain Config | |
Clears the terminal | |
Exits the CLI | |
Query using the Andromeda GraphQL service | |
Lists all valid commands | |
Query transactions | |
Prints the current CLI version. | |
Manage wallets | |
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.
Last modified 14d ago