Skip to content

Promote all install methods for CLI in the docs #733

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
janewang merged 2 commits into from
Jun 28, 2024
Merged

Promote all install methods for CLI in the docs #733

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
bf8b32a
List all install methods of stellar cli
janewang Jun 28, 2024
7128c36
List all install methods of stellar cli
janewang Jun 28, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 21 additions & 4 deletions docs/smart-contracts/getting-started/setup.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
sidebar_position: 0
title: Setup
description: Install and configure Rust to deploy smart contracts.
description: Install and configure Rust and CLI to deploy smart contracts.
---

<head>
Expand Down Expand Up @@ -79,12 +79,29 @@ A popular editor is Visual Studio Code:

## Install the Stellar CLI

The [Stellar CLI](https://github.com/stellar/stellar-cli) can execute smart contracts in the same environment the contract will execute on network, however in a local sandbox.
The [Stellar CLI](https://github.com/stellar/stellar-cli) can execute smart contracts on futurenet, testnet, mainnet, as well as in a local sandbox.

Install the [latest released version](https://github.com/stellar/stellar-cli/releases) of Stellar CLI using `cargo install`.
### Install

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`:

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

Install with Homebrew:

```sh
cargo install --locked stellar-cli
brew install stellar/tap/stellar-cli
```

:::info
Expand Down