Skip to content

Commit

Permalink
Update install instructions to match stellar-docs
Browse files Browse the repository at this point in the history
  • Loading branch information
leighmcculloch committed Oct 16, 2024
1 parent 4b2738e commit d5da135
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 27 deletions.
38 changes: 14 additions & 24 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,15 +8,16 @@ This repo is home to the Stellar CLI, the command-line multi-tool for running an

## Table of Contents

- [Documentation](#documentation)
- [Cookbook](#cookbook)
- [Installation](#installation)
- [Installation with Experimental Features](#installation-with-experimental-features)
- [Autocomplete](#autocomplete)
- [Latest Release](#latest-release)
- [Upcoming Features](#upcoming-features)
- [To Contribute](#to-contribute)
- [Additional Developer Resources](#additional-developer-resources)
- [Stellar CLI (stellar-cli)](#stellar-cli-stellar-cli)
- [Table of Contents](#table-of-contents)
- [Documentation](#documentation)
- [Cookbook](#cookbook)
- [Install](#install)
- [Autocomplete](#autocomplete)
- [Latest Release](#latest-release)
- [Upcoming Features](#upcoming-features)
- [To Contribute](#to-contribute)
- [Additional Developer Resources](#additional-developer-resources)



Expand All @@ -27,28 +28,17 @@ For installation options see below, for usage instructions [see the full help do
## Cookbook
To understand how to get the most of the Stellar CLI, see the [Stellar CLI Cookbook](https://github.com/stellar/stellar-cli/tree/main/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.

## Installation
Install the latest version from source:
```
cargo install --locked stellar-cli --features opt
```
## Install

Install with `cargo-binstall`:
```
cargo install --locked cargo-binstall
cargo binstall -y stellar-cli
```

Install with Homebrew:
Install with Homebrew (macOS, Linux):

```
brew install stellar-cli
```

## Installation with Experimental Features
To use the potentially unreleased bleeding edge CLI functionalities, install from git:
Install the latest version from source:
```
cargo install --locked stellar-cli --features opt --git https://github.com/stellar/stellar-cli.git
cargo install --locked stellar-cli --features opt
```

## Autocomplete
Expand Down
7 changes: 4 additions & 3 deletions cmd/stellar-cli/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,12 +6,13 @@ Docs: https://developers.stellar.org

## Install

Install with Homebrew (macOS, Linux):

```
cargo install --locked stellar-cli
brew install stellar-cli
```

To install with the `opt` feature, which includes a WASM optimization feature and wasm-opt built in:

Install the latest version from source:
```
cargo install --locked stellar-cli --features opt
```
Expand Down

0 comments on commit d5da135

Please sign in to comment.