Skip to content
Frigg Docs

Installation

Frigg is distributed as one local binary. Choose the channel that matches your platform and workflow, then verify it with frigg --version.

Release installer

Section titled “Release installer”

The shell installer supports these macOS and GNU/glibc Linux targets:

  • x86_64-unknown-linux-gnu
  • aarch64-unknown-linux-gnu
  • x86_64-apple-darwin
  • aarch64-apple-darwin

In addition to standard POSIX shell utilities, it requires curl, tar, and either sha256sum or shasum.

Install the current release:

Terminal window
curl -fsSL https://raw.githubusercontent.com/bnomei/frigg/main/scripts/install.sh \
  | FRIGG_VERSION=0.9.0 sh

The installer downloads the matching archive and .sha256 file, verifies the checksum, and installs frigg to $HOME/.local/bin. Override the destination with FRIGG_INSTALL_DIR:

Terminal window
curl -fsSL https://raw.githubusercontent.com/bnomei/frigg/main/scripts/install.sh \
  | FRIGG_VERSION=0.9.0 FRIGG_INSTALL_DIR="$HOME/bin" sh

Omit FRIGG_VERSION to resolve the latest GitHub Release. The value may include or omit the leading v.

Windows users should install the release .zip asset or use Scoop.

Other install channels

Section titled “Other install channels”
Channel Command Requirements
GitHub Release installer curl -fsSL https://raw.githubusercontent.com/bnomei/frigg/main/scripts/install.sh | sh Supported Unix target and checksum utility
Cargo prebuilt binary cargo binstall frigg cargo-binstall
Cargo source build cargo install frigg Rust 1.88 or newer and a native build toolchain
npm wrapper npx @bnomei/frigg --version Node.js 18 or newer
Docker image docker run --rm ghcr.io/bnomei/frigg:0.9.0 --version Docker-compatible runtime
Scoop scoop bucket add frigg https://github.com/bnomei/scoop-frigg && scoop install frigg Windows and Scoop

The npm wrapper downloads and verifies the matching GitHub Release binary on first use. It supports Linux x64/arm64, macOS x64/arm64, and Windows x64. Its cache defaults to $XDG_CACHE_HOME/frigg/npm or ~/.cache/frigg/npm on Unix, and %LOCALAPPDATA%\frigg\npm on Windows.

npm environment variable Use
FRIGG_NPM_CACHE Override the binary cache directory.
FRIGG_VERSION Override the release version used by the wrapper.
FRIGG_REPOSITORY Override the GitHub owner/repository source.

Platform feature differences

Section titled “Platform feature differences”

GNU/glibc Linux, Apple Silicon macOS, Windows, and the Docker image use Frigg’s default feature set, including the optional local semantic provider. Static musl assets and the Intel macOS release asset omit the local ONNX/FastEmbed provider because that dependency does not provide the required prebuilt runtime for those targets. Lexical, structural, navigation, and remote semantic providers remain available.

The local semantic model is downloaded only when you enable provider=local. Normal installation and semantic-disabled use do not download model artifacts.

Build from source

Section titled “Build from source”

Frigg requires Rust 1.88 or newer:

Terminal window
git clone https://github.com/bnomei/frigg.git
cd frigg
cargo build --release -p frigg
target/release/frigg --version

Expected output:

frigg 0.9.0

To build without the local embedding dependencies:

Terminal window
cargo build --release -p frigg --no-default-features

Verify the install

Section titled “Verify the install”
Terminal window
frigg --version
frigg --help

If frigg is not on PATH, add the install directory or invoke the binary by its full path.

Source Anchors

Section titled “Source Anchors”
  • ../frigg/README.md
  • ../frigg/Cargo.toml
  • ../frigg/crates/cli/Cargo.toml
  • ../frigg/scripts/install.sh
  • ../frigg/npm/frigg/package.json
  • ../frigg/npm/frigg/bin/frigg.js
  • ../frigg/packaging/README.md
  • ../frigg/scripts/build-release.sh