spam

Search Packages And Module options in the wider Nix ecosystem.

spam indexes Nix package closures and nixosOptionsDoc output into a indexed database with ZSTD compression. Given a substring, it finds which packages own matching files, or which module options match a name.

Usage

# Search module options from a JSON file
$ spam opt --module-options options.json <query>

# Search module options from a pre-built database
$ spam opt --db options.db <query>

# Search for a file across the default package database
$ spam pkg <query>

# Build a files database from a package manifest
$ spam db build --manifest packages.json --output files.db

# Build an options database from options.json
$ spam db build --manifest options.json --output options.db

opt - option search

Search a nixosOptionsDoc JSON file or a pre-built options database.

# Search options.json for services.nginx
$ spam opt --module-options options.json services.nginx

# Search options database for networking.firewall
$ spam opt --db options.db networking.firewall

pkg - package file search

Search a package-file database or autonomous index for which package(s) ship a given file.

# Find which package ships libfoo.so
$ spam pkg libfoo.so

# Emit JSON output for a /bin/foo search
$ spam pkg --json /bin/foo

db build - index a manifest

Build a database from a JSON manifest. The manifest kind is auto-detected: option-shaped objects produce an options database; package outputs produce a files database.

# Build a package-file database from a manifest
$ spam db build --manifest packages.json --output files.db

# Build an options database from options.json
$ spam db build --manifest options.json --output options.db

Manifest formats accepted:

• Array of objects with attr, pname, version, and outputs
• Object mapping attr to a store path string
• Object mapping attr to an object with named output paths

Database format

SPAM databases use the # spam-db-v3 magic header. options and packages databases are zstd-compressed text buckets with a 256-bucket binary index. Autonomous index databases from spam index are compact zstd package streams with prefix-delta encoded paths to avoid bucket duplication.

Building

Requires Nim >= 2.2.0 and libzstd.

# Compile the project
$ nimble build

Release build:

# Release build with optimizations
$ nimble release

Nix:

# Build via Nix flake
$ nix build

Pre-built indexes

Weekly database indexes are generated by CI for all supported systems. You can download them from the Actions tab under the most recent successful auto-index run. Each system's index is uploaded as a separate artifact (spam-index-x86_64-linux, spam-index-aarch64-linux, etc.). Artifacts are retained for 90 days. To use a downloaded index:

# Point spam at the downloaded database
$ spam pkg --db ./spam-index-x86_64-linux <query>

You may also generate the indexes yourself, however, keep in mind that it is rather RAM intensive and might run your system out of memory.