This repo is home to the Stellar CLI, the command-line multi-tool for running and deploying Stellar contracts on the Stellar network.
- Documentation
- Installation
- Installation with Experimental Features
- Autocomplete
- Latest Release
- Upcoming Features
- To Contribute
- Additional Developer Resources
For installation options see below, for usage instructions see the full help docs.
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
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
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: https://developers.stellar.org/meetings/2024/06/27