README
¶
Avalanche-CLI
Avalanche CLI is a command line tool that gives developers access to everything Avalanche. This beta release specializes in helping developers develop and test subnets.
Installation
Compatibility
The tool has been tested on Linux and Mac. Windows is currently not supported.
Instructions
To download a binary for the latest release, run:
curl -sSfL https://raw.githubusercontent.com/ava-labs/avalanche-cli/main/scripts/install.sh | sh -s
The binary will be installed inside the ./bin directory (relative to where the install command was run).
Downloading binaries from the Github UI will cause permission errors on Mac.
To add the binary to your path, run
cd bin
export PATH=$PWD:$PATH
To add it to your path permanently, add an export command to your shell initialization script (ex: .bashrc).
Installing in Custom Location
To download the binary into a specific directory, run:
curl -sSfL https://raw.githubusercontent.com/ava-labs/avalanche-cli/main/scripts/install.sh | sh -s -- -b <relative directory>
Quickstart
After installing, launch your own custom subnet:
avalanche subnet create <subnetName>
avalanche subnet deploy <subnetName>
Shut down your local deployment with:
avalanche network stop
Restart your local deployment (from where you left off) with:
avalanche network start
Disclaimer
This beta project is very early in its lifecycle. It will evolve rapidly over the coming weeks and months. Until we achieve our first mature release, we are not committed to preserving backwards compatibility. Commands may be renamed or removed in future versions.
We wanted to get this in your hands as soon as possible, so it's releasing before it's "complete." Bug reports and feedback on future directions are appreciated and encouraged! That said, we have LOTS planned and many new features are on the way.
Currently Supported Functionality
- Creation of Subnet-EVM configs
- Local deployment of Subnet-EVM based subnets
Notable Missing Features
- Fuji and mainnet Subnet-EVM deploys
Building Locally
To build Avalanche-CLI, you'll first need to install golang. Follow the instructions here: https://go.dev/doc/install.
Once golang is installed, run:
./scripts/build.sh
The binary will be called ./bin/avalanche.
Detailed Usage
More detailed information on how to use Avalanche CLI can be found at here.
Documentation
Source Files
Directories