Skip to content

Commit

Permalink
Update install instructions of the stellar-cli (#1045)
Browse files Browse the repository at this point in the history
  • Loading branch information
leighmcculloch authored Oct 16, 2024
1 parent 1f981a7 commit af0af63
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 33 deletions.
15 changes: 4 additions & 11 deletions docs/build/smart-contracts/getting-started/setup.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -85,23 +85,16 @@ The [Stellar CLI](https://github.com/stellar/stellar-cli) can execute smart cont

There are a few ways to install the [latest released version](https://github.com/stellar/stellar-cli/releases) of Stellar CLI.

Install with cargo from source:

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

Install with `cargo-binstall`:
Install with Homebrew (macOS, Linux):

```sh
cargo install --locked cargo-binstall
cargo binstall -y stellar-cli
brew install stellar-cli
```

Install with Homebrew (macOS, Linux):
Install with cargo from source:

```sh
brew install stellar-cli
cargo install --locked stellar-cli --features opt
```

:::info
Expand Down
29 changes: 7 additions & 22 deletions docs/tools/developer-tools/cli/install-cli.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -10,52 +10,37 @@ sidebar_position: 50

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

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 (macOS, Linux):

```
```sh
brew install stellar-cli
```

## Installation with Experimental Features
Install with cargo from source:

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
```sh
cargo install --locked stellar-cli --features opt
```

## Set up Autocomplete

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

```
```sh
stellar completion --shell <SHELL>
```

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

To enable autocomplete in the current bash shell, run:

```
```sh
source <(stellar completion --shell bash)
```

To enable autocomplete permanently, run:

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

Expand Down

0 comments on commit af0af63

Please sign in to comment.