Skip to main content

Install the Stellar CLI

Stellar CLI​

There are a few ways to install the latest released version of Stellar CLI.

Install with Homebrew (macOS, Linux):

brew install stellar-cli

Install with winget (Windows):

winget install --id Stellar.StellarCLI

Install with cargo from source (github.com/stellar/stellar-cli):

cargo install --locked stellar-cli --features opt
note

You can also use the third-party tool SVM (Stellar Version Manager), a version manager for Stellar CLI that allows you to install and switch between different versions of stellar-cli.

Install in your GitHub action (this is a preferred option of installing cli in your GitHub actions)

uses: stellar/stellar-[email protected]

Set up Autocomplete​

The Stellar CLI supports some autocompletion. To set up, run the following commands:

stellar completion --shell <SHELL>

Possible SHELL values are bash, elvish, fish, powershell, zsh, etc.

To enable autocomplete in the current bash shell, run:

source <(stellar completion --shell bash)

To enable autocomplete permanently, run:

echo "source <(stellar completion --shell bash)" >> ~/.bashrc

Stellar CLI Cookbook​

To understand how to get the most of the Stellar CLI, see the Stellar CLI Cookbook for recipes and a collection of resources to teach you how to use the CLI. Examples of recipes included in the CLI cookbook include: send payments, manage contract lifecycle, extend contract instance/storage/wasm, and more.

Video Tutorials​