gem-hunter

This repo is home to the Stellar CLI, the command-line multi-tool for running and deploying Stellar contracts on the Stellar network.

• Documentation
• Cookbook
• Install
• Autocomplete
• Latest Release
• Upcoming Features
• To Contribute
• Additional Developer Resources

For installation options see below, for usage instructions see the full help docs.

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.

Install with the install script (macOS, Linux):

curl -fsSL https://github.com/stellar/stellar-cli/raw/main/install.sh | sh

For installation options, run the script with --help:

curl -fsSL https://github.com/stellar/stellar-cli/raw/main/install.sh | sh -s -- --help

Install with dependency setup (--install-deps) to attempt installing:

• Linux development dependencies (libdbus/libudev development packages; Linux only, not required on macOS)
• Rust toolchain and wasm32v1-none target (for contract build workflows)

curl -fsSL https://github.com/stellar/stellar-cli/raw/main/install.sh | sh -s -- --install-deps

Install with Homebrew (macOS, Linux):

brew install stellar-cli

Install the latest version from source:

cargo install --locked stellar-cli

Install without features that depend on additional libraries:

cargo install --locked stellar-cli --no-default-features

Install or run the unreleased main branch with nix:

$ nix run 'github:stellar/stellar-cli' -- --help
or install
$ nix profile install github:stellar/stellar-cli

For additional information on how to install, see instructions here on the Developer Docs.

Use GitHub Action:

uses: stellar/stellar-cli@v23.0.1

Run with Docker:

docker run --rm -it -v "$(pwd)":/source stellar/stellar-cli version

Docker image distribution is handled by the stellar/stellar-cli-docker repository, with images published to Docker Hub.

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

For the latest release, see releases.

For upcoming features, please see the project board.

Find issues to contribute to here and review CONTRIBUTING.md.

• Developer Docs CLI Examples: https://developers.stellar.org/docs/smart-contracts/guides/cli
• Video Tutorial on network container, keys, and contract init: https://developers.stellar.org/meetings/2024/06/27
• Video Tutorial on alias and snapshot: https://developers.stellar.org/meetings/2024/09/12