Skip to content

installation.md

Latest commit

 

History

History
124 lines (82 loc) · 3.49 KB

installation.md

File metadata and controls

124 lines (82 loc) · 3.49 KB
Raw

Installation Guide

Table of Contents

Quick Install (Linux)

The installer script detects the distribution and its package manager, installs the build prerequisites (git and, when missing, the Rust toolchain via rustup), clones the repository, builds it in release mode and installs the binary to /usr/local/bin.

Using curl

curl -fsSL https://raw.githubusercontent.com/xtop-cli/xtop/main/install.sh | bash

Using wget

wget -qO- https://raw.githubusercontent.com/xtop-cli/xtop/main/install.sh | bash

Quick Install (Windows)

Requires Rust (Cargo) to be installed. Run in PowerShell:

irm https://raw.githubusercontent.com/xtop-cli/xtop/main/install.ps1 | iex

macOS

install.sh targets Linux package managers and has no macOS branch. Install with cargo (needs the Rust toolchain from rustup):

cargo install --git https://github.com/xtop-cli/xtop --all-features

The binary lands in ~/.cargo/bin; make sure it is on your PATH. --all-features enables the Samurai plugin, the MCP extension, the blocks widget pack, the effects module and the two runtime widget hosts (sandboxed WASM and external processes).

Installer Options

You can run the installer script with additional flags for more control:

# Check dependencies without installing
./install.sh --check-deps

# Install only dependencies (Rust, build tools)
./install.sh --install-deps

# Install with the runtime widget hosts enabled (sandboxed .wasm widgets
# and helper processes in any language)
./install.sh --with-runtime-widgets

# Show help
./install.sh --help

On Windows the same opt-in is a switch on the installer:

.\install.ps1 -RuntimeWidgets

Supported Distributions

  • Arch Linux and derivatives
  • Debian / Ubuntu and derivatives
  • Fedora / RHEL and derivatives
  • openSUSE and derivatives
  • Alpine Linux and derivatives

Build from Source

  1. Clone the repository:

    git clone https://github.com/xtop-cli/xtop.git
cd xtop

  2. Build and run with release optimizations:

    cargo run --release

Uninstall

The uninstallers remove the binary only; user configuration under the config directory is kept.

Linux

curl -fsSL https://raw.githubusercontent.com/xtop-cli/xtop/main/install.sh | bash -s -- --uninstall

Windows

irm https://raw.githubusercontent.com/xtop-cli/xtop/main/uninstall.ps1 | iex

Back to README