Installation
Install and configure the Andamio CLI
Installation
Homebrew (macOS)
brew install Andamio-Platform/tap/andamio-cliDownload a Release
Prebuilt binaries for macOS, Linux, and Windows are available on the Releases page.
# Example: macOS Apple Silicon — replace VERSION with the latest release
VERSION=0.9.1
curl -sLO "https://github.com/Andamio-Platform/andamio-cli/releases/download/v${VERSION}/andamio_${VERSION}_darwin_arm64.tar.gz"
curl -sLO "https://github.com/Andamio-Platform/andamio-cli/releases/download/v${VERSION}/checksums.txt"
shasum -a 256 --check --ignore-missing checksums.txt
tar xzf "andamio_${VERSION}_darwin_arm64.tar.gz"
sudo mv andamio /usr/local/bin/Available platforms: darwin_arm64, darwin_amd64, linux_amd64, linux_arm64, windows_amd64, windows_arm64.
Build from Source
Requires Go 1.21 or later.
go install github.com/Andamio-Platform/andamio-cli/cmd/andamio@latestVerify
andamio --versionConfiguration
The CLI stores configuration at ~/.andamio/config.json. This file is created automatically when you first authenticate.
Networks
The CLI works with two Cardano networks. Start on preprod for development.
| Preprod (default) | Mainnet | |
|---|---|---|
| API | preprod.api.andamio.io | mainnet.api.andamio.io |
| App | preprod.app.andamio.io | app.andamio.io |
| Get API key | preprod.app.andamio.io/api-setup | app.andamio.io/api-setup |
| Access Token | Free (test ADA) | Requires real ADA |
Switch networks:
# Preprod (default)
andamio config set-url https://preprod.api.andamio.io
# Mainnet
andamio config set-url https://mainnet.api.andamio.ioWhen switching networks, you need to re-authenticate — API keys and Access Tokens are network-specific:
andamio config set-url https://mainnet.api.andamio.io
andamio auth login --api-key <your-mainnet-api-key>
andamio user login # re-authenticate wallet on mainnetSee Environments for policy IDs and environment variables.
View current configuration:
andamio config showUpdate
# Homebrew
brew upgrade andamio-cli
# From source
go install github.com/Andamio-Platform/andamio-cli/cmd/andamio@latestOr download the latest binary from the Releases page.
All Commands
andamio --helpAvailable Commands:
apikey API key management
auth Authenticate with the Andamio API
config Manage CLI configuration
course Manage courses
manager Project manager operations (requires user login)
project Manage projects
spec Manage OpenAPI spec
teacher Teacher operations (requires user login)
tx Transaction operations
user User authentication and infoEvery command supports four output formats via the -o flag:
| Format | Flag | Use case |
|---|---|---|
| Text (default) | -o text | Human-readable tables in the terminal |
| JSON | -o json | Scripting and piping to jq |
| CSV | -o csv | Spreadsheets and data analysis |
| Markdown | -o markdown | Documentation and reports |
JSON goes to stdout with no stderr noise, so all commands are safe to pipe.
Shell Completion
Generate autocompletion for your shell:
# Zsh (add to ~/.zshrc)
source <(andamio completion zsh)
# Bash (add to ~/.bashrc)
source <(andamio completion bash)
# Fish
andamio completion fish | source