README.md

Stellar CLI (stellar-cli)

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

Table of Contents

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

Documentation

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

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.

Install

Install with Homebrew (macOS, Linux):

brew install stellar-cli

Install the latest version from source:

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

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

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

Latest Release

For the latest release, see releases.

Upcoming Features

For upcoming features, please see the project board.

To Contribute

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

Additional Developer Resources

• 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