Skip to content

Surface CLI install instructions on the CLI landing pages #2834

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鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
kaankacar wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Surface CLI install instructions on the CLI landing pages #2834

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
15 changes: 13 additions & 2 deletions docs/tools/cli/README.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,17 @@ sidebar_position: 20

The command line interface to Soroban smart contracts. It allows you to build, deploy, and interact with smart contracts; configure identities; generate key pairs; manage networks; and more.

Install Stellar CLI as explained in [Setup](../../build/smart-contracts/getting-started/setup.mdx#install-the-stellar-cli). For examples on how to use the Stellar CLI, please see [Stellar CLI Guides](./cookbook/README.mdx).
## Install

The auto-generated comprehensive reference documentation is available [here](stellar-cli.mdx).
Install the latest release on macOS, Linux or WSL with the install script:

```sh
curl -fsSL https://github.com/stellar/stellar-cli/raw/main/install.sh | sh
```

For Homebrew, winget, cargo, GitHub Actions and shell autocomplete, see [Install the CLI](./install-cli.mdx). To install the CLI with Rust, the Wasm target and an editor, see [Setup](../../build/smart-contracts/getting-started/setup.mdx#install-the-stellar-cli).

## Learn more

- [Stellar CLI Guides](./cookbook/README.mdx) gives examples of how to use the CLI.
- [Stellar CLI Manual](./stellar-cli.mdx) is the auto-generated reference for every command.
2 changes: 2 additions & 0 deletions docs/tools/cli/cookbook/README.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,3 +8,5 @@ sidebar_position: 150
import DocCardList from "@theme/DocCardList";

Guides that will help you use the Stellar CLI.

If you do not have the CLI yet, see [Install the CLI](../install-cli.mdx).
Loading