Introduction
This document is a guide to start using the Andromeda CLI.
Last updated
This document is a guide to start using the Andromeda CLI.
Last updated
To install the Andromeda CLI, run the following command to download our npm package:
Make sure you have npm installed.
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:
Then run andr to open the 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.
Testnets are currently disable in CLI but will be added very shortly.
To get the list of chains that are integrated with the Andromeda system, run:
The first thing to do in the CLI is to choose which environment to use. There are three main environments:
Mainnet: Connects to the mainnet chain configs.
Testnet: Connects to testnet chain configs.
Devnet: Connects to devnet chain configs. Used mainly in Andromeda dev events such as hackathons and beta testing.
You can run the following command and then select from the displayed envs:
Next, you need to select the chain config and wallets to use.
Run:
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.
Choose the chain config that you want to use. Then add a wallet:
This creates a new wallet address. If you already have an address, you can import it to the CLI using the "wallet recover" command.
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.
You will notice something similar to ? user@galileo-3> 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.
Or just:
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:
Query and execute messages on an ADO.
Send tokens or query address balances.
Manage the chains and their configs.
Clears the terminal.
Manage your environments.
Exits the CLI.
Query Apps and assets using the Andromeda GraphQL service.
Lists all valid commands.
Query transactions information.
Prints the current CLI version.
Manage wallets.
Send messages to the chain using wasm.
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.
Execute and Query messages on the OS ADOs like the , , and .
