Skip to main content

Avocado command line interface overview

Avocado CLI, or avocado, is a command-line interface to initialize, configure, build, and provision Avocado OS projects.

Installation

The Avocado CLI is a Rust-based command line tool that can be installed using Cargo, Rust's package manager.

Prerequisites

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.

(Option 1) Install from GitHub Releases

The recommended and easiest way to install Avocado CLI is to download a pre-built binary from the GitHub releases page:

  1. Visit https://github.com/avocado-linux/avocado-cli/releases
  2. Download the appropriate binary for your operating system from the latest release
  3. Extract the binary and place it in your PATH

(Option 2) Install from Git

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

cargo install --git https://github.com/avocado-linux/avocado-cli.git

(Option 3) Install from Source

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

git clone https://github.com/avocado-linux/avocado-cli.git
cd avocado-cli
cargo install --path .

Verify Installation

After installation, verify that the CLI is working correctly:

avocado --version

This should display the version information for the Avocado CLI.

Updating

To update to the latest version, you can use the built-in upgrade command:

avocado upgrade

Alternatively, if you installed via Cargo, you can run the install command again:

cargo install --git https://github.com/avocado-linux/avocado-cli.git --force

The --force flag will overwrite the existing installation.