• Stars
    star
    202
  • Rank 193,691 (Top 4 %)
  • Language
    Nix
  • License
    European Union Pu...
  • Created over 1 year ago
  • Updated 2 months ago

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

Post-modern configuration management

wrapper-manager

Post-modern configuration management

wrapped nixos logo

{pkgs, ...}: {
  # Build a custom nushell wrapper
  # that self-bundles its configuration and dependencies
  # ~/.config/nushell is not neeeded!
  wrappers.nushell = {
    basePackage = pkgs.nushell;
    flags = [
      "--env-config"
      ./env.nu
      "--config"
      ./config.nu
    ];
    env.STARSHIP_CONFIG.value = ../starship.toml;
    pathAdd = [
      pkgs.starship
      pkgs.carapace
    ];
  };
}

Result (nushell executable):

#! /nix/store/51sszqz1d9kpx480scb1vllc00kxlx79-bash-5.2-p15/bin/bash -e
export STARSHIP_CONFIG=${STARSHIP_CONFIG-'/nix/store/9gyqz7x765dgh6jvjgnsmiq1zp8lm2y8-starship.toml'}
PATH=${PATH:+':'$PATH':'}
PATH=${PATH/':''/nix/store/11hrc3lnzp8jyb3afmmy9h4m4c30jkgs-starship-1.15.0/bin'':'/':'}
PATH='/nix/store/11hrc3lnzp8jyb3afmmy9h4m4c30jkgs-starship-1.15.0/bin'$PATH
PATH=${PATH#':'}
PATH=${PATH%':'}
export PATH
PATH=${PATH:+':'$PATH':'}
PATH=${PATH/':''/nix/store/vzvxm72pj68fc0120fw1k67b73iaf6g9-carapace-0.25.1/bin'':'/':'}
PATH='/nix/store/vzvxm72pj68fc0120fw1k67b73iaf6g9-carapace-0.25.1/bin'$PATH
PATH=${PATH#':'}
PATH=${PATH%':'}
export PATH
exec -a "$0" "/nix/store/k57j42qv2p1msgf9djsrzssnixlblw9v-nushell-0.82.0/bin/.nu-wrapped"  --env-config /nix/store/zx7cc0fmr3gsbxfvdri8b1pnybsh8hd9-env.nu --config /nix/store/n4mdvfbcc81i9bhrakw7r6wnk4nygbdl-config.nu "$@"

Wrapper-manager is a Nix library that allows you to configure your favorite applications without adding files into ~/.config. This is done by creating wrapper scripts that set the appropriate environment variables, like PATH, or pass extra flags to the wrapped program.

Nix offers very good reliability and reproducibility thanks to its read-only store. However, putting symlinks to it in your $HOME starts breaking this property. Because any program can tamper files in ~, the stability of your system is a bit more fragile.

Wrapper-manager leverages the nixpkgs' functions wrapProgram and symlinkJoin to create wrappers around your applications, providing an easy-to use interface, and also getting around some of their shortcomings.

Module documentation

https://viperml.github.io/wrapper-manager/docs/module

Installation/usage

First, you need to instantiate wrapper-manager's lib. This can be done by pulling the WM flake, or by pulling the repo tarball directly.

Flake

# flake.nix
{
  inputs = {
    nixpkgs.url = "...";

    # Add the wrapper-manager flake
    wrapper-manager = {
      url = "github:viperML/wrapper-manager";
      # WM's nixpkgs is only used for tests, you can safely drop this if needed.
      inputs.nixpkgs.follows = "nixpkgs";
    };
  };

  outputs = {self, nixpkgs, wrapper-manager}: { ... };
}

Classic

Wrapper-manager can be pulled in a classic (non-flake) setup for a devshell or nixos configuration, like so:

# shell.nix , or configuration.nix

# or {pkgs, config, ...}: if you are in NixOS...
let
  pkgs = import <nixpkgs> {};

  # optionally, pin a commit instead of using master
  wrapper-manager = import (builtins.fetchTarball "https://github.com/viperML/wrapper-manager/archive/refs/heads/master.tar.gz") {
    inherit (pkgs) lib;
  };
in
  ...

Evaluating

Now that you already have wrapper-manager in scope, you need to evaluate wrapper-manager.lib. The argument is an attrset with following elements:

  • pkgs: your nixpkgs instance used to bring symlinkJoin and makeWrapper, as well as passing it through the modules for convenience.
  • modules: a list of wrapper-manager modules. As with NixOS, a module can be passed as a path to a module or directly. A proper module is either an attset, or a function to attrset.
  • specialArgs (optional): extra arguments passed to the module system.

A convenience shorthand for (wrapper-manager.lib {...}).config.build.toplevel is available through: wrapper-manager.lib.build {}, which is probably what you want in 99% of the cases.

# This expression outputs a package, which collects all wrappers.
# You can add it to:
# - environment.systemPackages
# - home.packages
# - mkShell { packages = [...]; }
# - etc

(wrapper-manager.lib.build {
  inherit pkgs;
  modules = [
    ./my-module.nix
    {
      wrappers.foo = { ... };
    }
  ];
})
# => «derivation /nix/store/...»

For example, if you want to use wrapper-manager in the context of a devshell, you can instatiate it directly like so:

# pkgs and wrapper-manager in scope, see previous steps
# ...
mkShell {
  packages = [

    (wrapper-manager.lib.build {
      inherit pkgs;
      modules = [{
        wrappers.stack = {
          basePackage = pkgs.stack;
          flags = [
            "--resolver"
            "lts"
          ];
          env.NO_COLOR.value = "1";
        };
      }];
    })

  ];
}

Configuration examples

These are some examples of wrapper-manager used in the wild. Feel free to PR yours.

To-do's

https://github.com/viperML/wrapper-manager/issues

Changelog

  • 2023-11-13

    • Added prependFlags, which maps to --add-flags
    • Added appendFlags, which maps to --append-flags
    • flags is now an alias to prependFlags, which uses --add-flags instead of --append-flags
  • 2023-11-06

    • Users can now pass their own specialArgs
  • 2023-10-05

    • Changed wrapper.name.env to be an attrset instead
    • Added the ability to unset a variable with wrapper.name.env.unset
    • Added the ability to disallow overriding a variable with wrapper.name.env.force
    • Changed the way wrapper.name.flags is handled so that every flag is escaped
  • 2023-08-12

    • Added wrappers.name.renames option.

More Repositories

1

nh

Yet another nix cli helper
Rust
864
star
2

dotfiles

Personal configuration files for my PC
Nix
157
star
3

noshell

User-configurable login shell
C
48
star
4

home-manager-wsl

WSL distribution, including Nix + Home-manager + FHS Distro
Nix
35
star
5

activation-manager

The missing piece for effectful operations with Nix
Nix
29
star
6

miq

Master's thesis - Immutable package management for Linux
Rust
20
star
7

hover-rs

Protective home overlay
Rust
20
star
8

mkshell-minimal

POC of mkShell with the smallest closure possible
Nix
18
star
9

neoinfra

Infrastucture as code
Nix
14
star
10

iosevka

My iosevka build, patched with nerd fonts
Nix
13
star
11

qemu-android-x86

Android-x86 environment via QEMU and VirGL
Shell
6
star
12

neohome

Source for https://ayats.org
Astro
5
star
13

deploy-rs-example

Nix
4
star
14

nixos-discord-bot

Discord bot for the unofficial NixOS discord server.
Python
4
star
15

viperML-overlay

Gentoo’s portage overlay with packages for personal use.
Shell
4
star
16

home

Source for https://ayats.org
Nix
3
star
17

octoprint-nix

NixOS configuration for a raspberry pi with octoprint
Nix
3
star
18

bundlers

Nix
3
star
19

ubuntu-declarative

Shell
3
star
20

Guia-Instalacion-Gentoo

Guía de instalación de Gentoo Linux en español
3
star
21

delphix

Nix
3
star
22

nix-common

Common bits and pieces for NixOS and Home-Manager modules
Nix
2
star
23

sauce-archiver

Haskell
2
star
24

bad-nix

Exploit the capabilities of trusted users in Nix
Nix
2
star
25

bangscript

Embed scripts in a shebang
Rust
2
star
26

gentoo-plasma

Docker image with Gentoo + KDE Plasma
Dockerfile
1
star
27

st

Simple terminal patch set
C
1
star
28

tree-sitter

Everything tree-sitter, at once
Rust
1
star
29

in-nix

Export IN_NIX for subprocesses of Nix
Nix
1
star
30

experiments

All my experiments in one place
Nix
1
star
31

len

Toy language
Rust
1
star
32

splitdigitalclock

Copy of https://store.kde.org/p/1324315
QML
1
star
33

infra

Nix
1
star
34

wrapper-hack

Rust
1
star