Skip to content
tonythethompson edited this page Jul 10, 2026 · 1 revision

Installation Guide

Numan is a cross-platform package manager for Nushell built in Rust. Installs are inert: numan install only writes under $NUMAN_ROOT and does not modify the Nushell environment until you run numan activate.

Current release: v0.1.4.

System requirements

  • Rust 1.88+ (stable recommended) when building from source
  • Nushell on PATH for numan init, activate, and related commands
  • Platforms: Linux (x86_64), Windows (x86_64), macOS (Apple Silicon and Intel)

Pre-built releases

Download the latest archive for your platform from GitHub Releases. Each release ships a SHA256SUMS file.

Platform Archive Binary
Linux (x86_64) numan-<version>-x86_64-unknown-linux-gnu.tar.gz numan
Windows (x86_64) numan-<version>-x86_64-pc-windows-msvc.zip numan.exe
macOS (Apple Silicon) numan-<version>-aarch64-apple-darwin.tar.gz numan
macOS (Intel) numan-<version>-x86_64-apple-darwin.tar.gz numan

Linux / macOS

tar -xzf numan-<version>-<target>.tar.gz
install -m 755 numan-<version>-<target>/numan ~/.local/bin/numan

Windows (PowerShell)

Expand-Archive numan-<version>-x86_64-pc-windows-msvc.zip -DestinationPath .
# Add the extracted folder to PATH, or copy numan.exe into a directory already on PATH

Package managers

Homebrew (macOS / Linux)

brew tap tonythethompson/numan
brew install numan

Or without a tap:

brew install --formula https://raw.githubusercontent.com/tonythethompson/numan/master/packaging/homebrew/numan.rb

See Homebrew.

crates.io

cargo install numan-cli

The installed binary is named numan.

From git (latest master)

cargo install --git https://github.com/tonythethompson/numan

Pin a tag for reproducible installs: --tag v0.1.4.

winget (Windows)

After the package is listed in winget-pkgs:

winget install tonythethompson.Numan

Until then, install from the in-repo manifest (from a clone of the repository):

winget install --manifest .\packaging\winget\manifests\t\tonythethompson\Numan\0.1.4

See Winget and docs/PACKAGING.md.

Building from source

git clone https://github.com/tonythethompson/numan.git
cd numan
cargo install --path .

Post-install: initialize

numan init
numan registry sync

numan init probes Nu on PATH, creates the Numan root layout, and configures the official registry. Then continue with Quick Start.

Default data roots

OS Path
Linux ~/.local/share/numan
macOS ~/Library/Application Support/numan
Windows %LOCALAPPDATA%\numan

Override with NUMAN_ROOT or --root. Layout under the root:

numan/
├── config.toml          # registries, defaults
├── lockfile             # pinned installs (authoritative)
├── packages/            # immutable versioned payloads
├── registries/          # synced index caches
├── state/               # journals, nupm import provenance
└── nu_state/            # cached Nu paths for activation checks

Shell completions

Shell Command
Bash numan completions bash > ~/.local/share/bash-completion/completions/numan
Zsh numan completions zsh > ~/.zfunc/_numan
Fish numan completions fish > ~/.config/fish/completions/numan.fish
PowerShell numan completions powershell | Out-File -Encoding utf8 $PROFILE

Verify

numan doctor
numan doctor --fix --yes

See Doctor.

Clone this wiki locally