Skip to content

install.md

Latest commit

 

History

History
98 lines (68 loc) · 1.99 KB

install.md

File metadata and controls

98 lines (68 loc) · 1.99 KB

Installation

Quick Install

cargo install rmxt

From Source

git clone https://github.com/santoshxshrestha/rmxt
cd rmxt
cargo build --release
sudo cp target/release/rmxt /usr/local/bin/

Using Install Script

You can use the provided install script to automate installation. It will:

  • Ensure Rust is installed
  • Clone the repository to $HOME/rmxt
  • Build the binary
  • Install it to /usr/local/bin/rmxt
curl -fsSL https://raw.githubusercontent.com/santoshxshrestha/rmxt/main/scripts/install.sh | bash

Script Options

  • --dry-run : Show what would be done without making changes
  • --repo=URL : Use a custom repository URL
  • -h, --help : Show help message

Example:

bash scripts/install.sh --dry-run

Using Nix Flakes

You can use Nix flakes to run or build rmxt without installing Rust or any dependencies manually. This is the recommended method for Nix users.

Prerequisites:

Run rmxt directly (no install)

nix run github:santoshxshrestha/rmxt

Or, if you have cloned the repo:

nix run .

This will build and run the latest rmxt binary in a temporary environment.

Build the binary

nix build github:santoshxshrestha/rmxt

Or, from a local clone:

nix build

The compiled binary will be available at ./result/bin/rmxt.

Development shell

For contributors, you can enter a shell with all development dependencies:

nix develop

Notes

Verification

rmxt --help

Updating

cargo install rmxt  # Updates to latest version