janewang / stellar-cli

CLI for Soroban contracts.

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
• Installation
• Installation with Experimental Features
• Autocomplete
• Latest Release
• Upcoming Features
• To Contribute
• Additional Developer Resources

Documentation

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

Installation

Install the latest version from source:

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

Install with cargo-binstall:

cargo install --locked cargo-binstall
cargo binstall -y stellar-cli

Install with Homebrew:

brew install stellar/tap/stellar-cli

Installation with Experimental Features

To use the potentially unreleased bleeding edge CLI functionalities, install from git:

cargo install --locked stellar-cli --features opt --git https://github.com/stellar/stellar-cli.git

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: https://developers.stellar.org/meetings/2024/06/27