Installation

Install NUCH CLI application on your system.

Install Binary

Package Managers

You can install via homebrew (macOS/Linux):

brew install rivethorn/tap/nuch

You can also install via cargo (Rust package manager):

cargo install nuch

Unix Shell Script

You can install prebuilt binaries via shell script:

curl --proto '=https' --tlsv1.2 -LsSf https://github.com/rivethorn/nuch/releases/download/v1.3.5/nuch-installer.sh | sh

Windows PowerShell Script

You can install prebuilt binaries via PowerShell script:

powershell -ExecutionPolicy Bypass -c "irm https://github.com/rivethorn/nuch/releases/download/v1.3.5/nuch-installer.ps1 | iex"

You can also download the binary from Releases page and add it to your PATH.

Build from source

NUCH commands call git add/commit/push, so ensure git is available on your PATH.

You can also build NUCH from source. Make sure you have the following prerequisites:

  • Rust toolchain (cargo)
  • Git installed and on $PATH

Then follow these steps:

Clone the repository:

git clone https://github.com/rivethorn/nuch.git
cd nuch

Test the build:

cargo test

Build and run NUCH:

# Build
cargo build --release

# Run (shows help)
cargo run -- --help

# Create a sample config (writes to XDG_CONFIG_HOME/nuch/config.toml or ~/.config/nuch/config.toml)
cargo run -- --config

(Optional) Install the binary to your PATH:

cargo install --path .