Installation

This guide covers different methods to install Releasaurus on your system.

System Requirements

Operating System: Linux, macOS, or Windows
Git: Version 2.0 or higher
Internet Access: Required for API calls to Git forge platforms

Installation Methods

Option 1: Install from Crates.io (Recommended)

The easiest way to install Releasaurus is using Cargo, Rust's package manager:

cargo install releasaurus

This will download, compile, and install the latest stable version of Releasaurus. The binary will be available in your $HOME/.cargo/bin directory, which should be in your system's PATH.

Option 2: Download Pre-built Binaries

Coming soon...

Option 3: Build from Source

If you prefer to build from source or need the latest development features:

Build Steps

# Clone the repository
git clone https://github.com/your-username/releasaurus.git
cd releasaurus

# Build and install
cargo install --path .

This will build the project in release mode and install it to your Cargo bin directory.

Option 4: Using Docker

If you prefer to use Docker, you can pull and run the official Releasaurus Docker image:

Pull the Docker Image

docker pull rgonnella/releasaurus:latest

Run Releasaurus with Docker

You can run Releasaurus directly using Docker.

# Run from your project directory
docker run --rm rgonnella/releasaurus:latest --help

Verify Installation

After installation, verify that Releasaurus is working correctly:

releasaurus --help

You should see the help output with available commands and options.

Check the installed version:

releasaurus --version

Now that you have Releasaurus installed, head over to the Quick Start guide to learn how to use it with your first project, or check out the Basic Configuration if you want to customize the default behavior.

Releasaurus