Skip to content

Latest commit

 

History

History
74 lines (51 loc) · 2.09 KB

README.md

File metadata and controls

74 lines (51 loc) · 2.09 KB
Raw

NWXPKGS

This repository serves my collection of custom Nix expressions, akin to what is done in nixpkgs. It includes a default overlay that exposes all custom packages, facilitating their integration into other projects.

Packages

Package Description Reference
cynthion CLI tool to work with the Cynthion by Great Scott Gadgets https://cynthion.readthedocs.io/
lldap-cli pending PR version of lldap-cli Zepmann/lldap-cli#12

Usage

Setting Up

  1. Fork this repository.
  2. Begin adding packages to the pkgs/by-name directory. Follow the same approach as adding packages in nixpkgs. Similar to RFC140, packages added in this directory will be automatically discovered.
    • Create a new directory for each package.
    • Inside each directory, create a package.nix file.
  3. Optionally, you can add packages directly to the pkgs/ directory and manually update the bindings in the imports/pkgs-all.nix file.

Using NWXPKGS as registry

Register NWXPKGS packet source and run packets, like in this example:

$ nix registry add nwxpkgs github:nwhirschfeld/nwxpkgs
$ nix run nwxpkgs#cynthion info
Cynthion version: 0.1.5
Apollo version: 1.1.0
Python version: 3.12.4 (main, Jun  6 2024, 18:26:44) [GCC 13.3.0]

[4,468s][release][~/Documents/nwxpkgs]$

Integrating NWXPKGS as an Overlay

To use this repository as an overlay in another project, follow these steps:

  1. Add the Repository as an Input:

    Add the following to your nix file to include this repository as an input:

    inputs = {
    nwxpkgs.url = "github:nwhirschfeld/nwxpkgs/release";
};

  2. Include the Overlay in pkgs:

    When constructing pkgs, include the overlay as follows:

    pkgs = import inputs.nixpkgs {
  overlays = [
    inputs.nwxpkgs.overlays.default
  ];
};

  3. Use NWXPKGS Packages:

    Access the packages in your project like this:

    buildInputs = [ pkgs.example1 pkgs.example2 ];