Skip to content

Commit 0b9abdd

Browse files
lee-reinhardtdanielspofford
authored andcommitted
update installation docs
1 parent 6488001 commit 0b9abdd

1 file changed

Lines changed: 19 additions & 5 deletions

File tree

docs/installation.md

Lines changed: 19 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,20 +6,28 @@ The Avocado CLI is a Rust-based command line tool that can be installed using Ca
66

77
You'll need to have Rust and Cargo installed on your system. If you don't have Rust installed, you can get it from [rustup.rs](https://rustup.rs/).
88

9+
## Install from GitHub Releases (Recommended)
10+
11+
The easiest way to install Avocado CLI is to download a pre-built binary from the GitHub releases page:
12+
13+
1. Visit [https://github.com/avocado-linux/avocado-cli/releases](https://github.com/avocado-linux/avocado-cli/releases)
14+
2. Download the appropriate binary for your operating system
15+
3. Extract the binary and place it in your PATH
16+
917
## Install from Git
1018

1119
You can install the latest version directly from the Git repository using Cargo:
1220

1321
```bash
14-
cargo install --git https://github.com/avocado-framework/avocado-cli.git
22+
cargo install --git https://github.com/avocado-linux/avocado-cli.git
1523
```
1624

1725
## Install from Source
1826

1927
Alternatively, you can clone the repository and build from source:
2028

2129
```bash
22-
git clone https://github.com/avocado-framework/avocado-cli.git
30+
git clone https://github.com/avocado-linux/avocado-cli.git
2331
cd avocado-cli
2432
cargo install --path .
2533
```
@@ -29,17 +37,23 @@ cargo install --path .
2937
After installation, verify that the CLI is working correctly:
3038

3139
```bash
32-
avocado-cli --version
40+
avocado --version
3341
```
3442

3543
This should display the version information for the Avocado CLI.
3644

3745
## Updating
3846

39-
To update to the latest version, simply run the install command again:
47+
To update to the latest version, you can use the built-in upgrade command:
48+
49+
```bash
50+
avocado upgrade
51+
```
52+
53+
Alternatively, if you installed via Cargo, you can run the install command again:
4054

4155
```bash
42-
cargo install --git https://github.com/avocado-framework/avocado-cli.git --force
56+
cargo install --git https://github.com/avocado-linux/avocado-cli.git --force
4357
```
4458

4559
The `--force` flag will overwrite the existing installation.

0 commit comments

Comments
 (0)