nixpkgs/pkgs/by-name
2023-10-11 07:00:08 -05:00
..
_4/_4th _4th: fix cross compilation by setting AR in makeFlags 2023-09-22 16:28:35 -03:00
_9/_9base _9base: init at unstable-2019-09-11 2023-09-29 10:43:34 +01:00
a4/a4 a4term: rename package to a4 2023-10-06 21:56:23 -03:00
aa/aarch64-esr-decoder aarch64-esr-decoder: init at 0.2.1 2023-09-21 18:41:38 -07:00
ac/action-validator action-validator: init at 0.5.3 2023-10-10 14:35:02 +01:00
af/afterstep afterstep: migrate to by-name 2023-09-26 12:13:10 -03:00
ai/airscan airscan: init at 0.3 2023-09-10 12:54:15 +02:00
al algol68g: 3.3.23 -> 3.3.24 2023-10-02 18:03:40 -03:00
ao/aocl-utils aocl-utils: init at 4.1 2023-10-06 10:34:01 +02:00
ar arxiv-latex-cleaner: init at v1.0.1 2023-10-10 13:50:57 -07:00
as ast-grep: 0.12.2 -> 0.12.4 2023-10-04 12:33:10 +02:00
aw/aws-azure-login aws-azure-login: use fetchYarnDeps 2023-09-30 13:39:56 -07:00
ba Merge pull request #256438 from lf-/jade/backlight-auto 2023-09-24 02:28:37 +02:00
be/berry berry: migrate to by-name 2023-09-26 12:13:10 -03:00
bi bitmagnet: init at 0.0.6 2023-10-08 14:20:31 -04:00
bm/bmake bmake: more accurate metainfo about brokenness 2023-09-22 01:38:23 -03:00
bo boogie: 2.15.7 -> 3.0.4 2023-09-16 16:00:34 +02:00
br/bruno bruno: init at 0.17.0 2023-10-04 01:29:25 -07:00
ca cargo-i18n: fix build on darwin 2023-09-28 23:36:01 +02:00
cd cdk: 5.0-20221025 -> 5.0-20230201 2023-10-09 23:50:05 -03:00
ce/celluloid celluloid: refactor 2023-09-17 15:47:03 -03:00
ci cimg: 3.2.6 -> 3.3.1 2023-10-09 19:01:25 -03:00
cl/clzip clzip: init at 1.13 2023-09-22 20:00:39 +08:00
cn/cntb cntb: init at 1.4.6 2023-09-22 12:21:36 +00:00
co Merge pull request #256500 from adamcstephens/incus/init 2023-10-11 07:00:08 -05:00
cr/create-react-app create-react-app: use buildNpmPackage 2023-09-25 12:45:06 -07:00
ct/ctx ctx: migrate to by-name 2023-10-05 17:53:27 -03:00
de/debianutils debianutils: fix build on darwin 2023-09-22 08:01:22 -03:00
di/dialog dialog: migrate to by-name 2023-10-10 17:51:30 -03:00
dj/djent djent: init at 1.0 2023-09-14 13:05:29 +02:00
dm/dmenu-bluetooth dmenu-bluetooth: init at unstable-2023-07-16 2023-09-21 18:05:46 +09:00
do/dorion dorion: init at 1.2.1 2023-10-04 17:26:07 -03:00
dx dxvk: migrate to by-name 2023-10-08 16:10:33 -04:00
dy/dyalog dyalog: init at 18.2.45405 2023-09-26 22:36:39 +02:00
ec ecc: init at 1.0.11 2023-10-08 22:36:08 +08:00
ek/eksctl eksctl: 0.160.0 -> 0.161.0 2023-10-08 11:10:45 +00:00
el/elvish elvish: refactor 2023-09-19 00:02:22 -03:00
en/engage engage: 0.1.3 -> 0.2.0 2023-09-19 20:52:12 -07:00
es/esbuild-config esbuild-config: init at 1.0.1 2023-09-10 20:12:51 -04:00
eu/eudev eudev: refactor 2023-10-09 00:46:25 -03:00
ez/eza eza: 0.14.0 -> 0.14.1 2023-10-08 14:19:59 +02:00
fl/fleng fleng: 16 -> 17 2023-09-16 21:15:31 +00:00
fo/fortune-kind fortune-kind: init at 0.1.3 2023-10-10 05:29:48 +02:00
ga game-rs: init at 0.1.3 2023-09-29 14:17:53 +02:00
gb/gbar gbar: init at unstable-2023-09-21 2023-10-05 18:17:38 +08:00
gh gh-screensaver: init at 2.0.1 2023-09-29 09:23:45 +02:00
gi girouette: add cafkafk as maintainer 2023-10-03 08:26:42 +02:00
gm/gmic gmic: 3.2.6 -> 3.3.1 2023-10-09 19:01:25 -03:00
go/goat goat: init at unstable-2022-08-15 2023-09-27 18:38:43 +02:00
gr/grimblast grimblast: unstable-2023-09-06 -> unstable-2023-10-03 2023-10-03 14:39:15 +01:00
gu maintainers: grxnola -> offsetcyan (#258210) 2023-09-30 21:53:04 +02:00
ha/ha-mqtt-discoverable-cli ha-mqtt-discoverable-cli: init at 0.2.1 2023-09-25 11:06:48 +02:00
he Merge pull request #255459 from bobvanderlinden/pr-hello-mainprogram 2023-09-16 14:12:22 +02:00
hy hyperlink: init at 0.1.31 2023-09-16 15:21:08 -04:00
i3/i3bar-river i3bar-river: init at 0.1.3 2023-09-22 16:45:57 -04:00
ic/icewm icewm: 3.4.2 -> 3.4.3 2023-10-09 09:43:07 -03:00
if/ifrextractor-rs ifrextractor-rs: init at 1.5.1 2023-09-08 16:39:00 +02:00
im Merge pull request #258669 from dotlambda/impression-init 2023-10-07 23:14:30 +00:00
in incus: init at 0.1 2023-10-07 19:50:46 -04:00
ir/ironbar ironbar: init at 0.13.0 2023-09-09 20:48:37 +02:00
ji/jinja2-cli jinja2-cli: init at 0.8.2 2023-09-08 21:10:04 -04:00
ju/justbuild justbuild: partial fixes for darwin 2023-09-30 10:07:17 +10:00
ka/katriawm katriawm: fix cross compilation and minor improvement 2023-09-22 16:28:05 -03:00
kt/ktfmt ktfmt: init at 0.46 2023-09-23 16:42:25 -03:00
ku/kubectl-neat kubectl-neat: init at 2.0.3 2023-10-03 16:48:56 +02:00
la/labwc labwc: 0.6.4 -> 0.6.5 2023-09-23 19:44:14 -03:00
le lexmark-aex: init at 1.0 2023-10-01 09:33:56 +02:00
li linux-wallpaperengine: init at unstable-2023-09-23 2023-09-27 07:56:51 -04:00
lu/luastatus luastatus: init at 0.6.0 2023-09-23 15:40:55 +10:00
lx/lxd-to-incus lxd-to-incus: init at 0.1 2023-10-07 19:50:48 -04:00
ma matrix-commander-rs: init at 0.1.32 2023-09-21 18:12:17 +02:00
me/mermaid-cli mermaid-cli: use fetchYarnDeps 2023-10-02 14:10:23 -07:00
mf/mfoc-hardnested mfoc-hardnested: unstable-2021-08-14 -> unstable-2023-03-27 2023-09-13 23:24:14 +08:00
mi/millipixels millipixels: init at 0.22.0 2023-09-08 21:54:11 +02:00
mk/mksh mksh: migrate to by-name 2023-09-19 00:02:22 -03:00
ml/mlx42 mlx42: init at 2.3.2 2023-10-01 12:53:05 +02:00
na/nawk nawk: update homepage 2023-09-20 09:21:59 -03:00
ne netclient: init at 0.21.0 2023-10-09 15:58:01 +02:00
nf/nfft nfft: init at 3.5.3 2023-10-03 09:18:14 +02:00
ni/nixos-anywhere nixos-anywhere: set mainProgram and use finalAttrs 2023-09-20 08:11:11 +02:00
no/notion notion: migrate to by-name 2023-09-26 12:13:10 -03:00
nu/nuget nuget: 6.3.1.1 -> 6.6.1.2 2023-09-26 21:20:11 +02:00
oe/oelint-adv oelint-adv: init at 3.25.0 2023-09-29 08:50:50 -03:00
op/openpgl openpgl: init at 0.5.0 2023-09-28 18:27:38 -04:00
or/orchard orchard: 0.12.0 -> 0.13.1 2023-10-03 05:32:37 +00:00
ou/outputcheck outputcheck: init at 0.4.2 2023-09-19 22:23:55 +08:00
pa/passes passes: init at 0.8 2023-09-09 20:30:01 +02:00
pd/pdepend pdepend: 2.14.0 -> 2.15.1 2023-10-04 15:12:08 +02:00
pe pekwm: migrate to by-name 2023-09-26 12:13:10 -03:00
ph/phpdocumentor phpdocumentor: init at 3.4.1 2023-09-16 17:23:32 +02:00
pl/platformsh platformsh: 3.79.2 -> 4.10.0 2023-09-17 15:07:02 +02:00
po/poethepoet poethepoet: 0.24.0 -> 0.24.1 2023-10-08 14:14:24 -04:00
pr/prettier-d-slim prettier-d-slim: use buildNpmPackage 2023-09-14 08:16:43 -07:00
px/pxder pxder: use fetchYarnDeps 2023-09-26 10:08:41 -07:00
qu/quicktype quicktype: use buildNpmPackage 2023-09-09 04:20:00 +00:00
ra raft-cowsql: init at 0.17.2 2023-10-07 19:50:40 -04:00
rc/rc rc: migrate to by-name 2023-09-19 00:02:22 -03:00
re regols: init at 0.2.2 2023-10-09 22:10:51 +01:00
ri rimgo: init at 1.2.0 2023-09-29 08:59:59 +02:00
ro robo: init at 4.0.4 2023-09-16 17:24:30 +02:00
ru/rusti-cal rusti-cal: init at 1.1.0 2023-09-08 16:27:47 +02:00
sa/samrewritten samrewritten: init at unstable-2023-05-23 2023-09-24 11:27:26 +09:00
sc scdoc: 1.11.2 -> 1.11.2-unstable-2023-03-08 2023-10-06 19:17:47 -03:00
se/searxng searxng: add 999eagle to maintainers 2023-10-03 20:25:18 +02:00
sh shopware-cli: 0.3.4 -> 0.3.5 2023-10-10 15:48:50 +02:00
si rocm-related: fixup for ROCm 5.7.0 2023-10-09 17:03:19 -05:00
sl slurm-nm: cleanup 2023-09-28 22:44:07 +02:00
sm/smallwm smallwm: migrate to by-name 2023-09-26 12:13:10 -03:00
sp rocm-related: fixup for ROCm 5.7.0 2023-10-09 17:03:19 -05:00
ss/sssnake sssnake: init at 0.3.2 (#253441) 2023-09-05 22:21:56 +02:00
st/static-server static-server: init at 1.2.1 2023-09-20 10:36:19 -04:00
su supersonic: init at 0.5.2 2023-09-29 23:27:17 +10:00
sy/symbolicator symbolicator: 23.9.0 -> 23.9.1 2023-09-20 23:21:09 -04:00
tc/tcsh tcsh: migrate to by-name 2023-09-10 01:35:11 +00:00
th thud: rename from go-thumbnailer, 0.1.0 -> 0.3.0 2023-09-22 08:32:16 -04:00
ti/tinywm tinywm: migrate to by-name 2023-09-26 12:13:10 -03:00
tm/tmuxifier tmuxifier: init at 0.13.0 2023-09-10 18:43:27 +03:00
tr/trealla trealla: 2.28.1 -> 2.28.12 2023-10-05 13:56:49 +00:00
tu/tuxmux tuxmux: init at version 0.1.0 2023-09-30 17:36:07 -03:00
uc/ucg ucg: cleanup 2023-09-13 15:31:38 +00:00
ud Merge pull request #259844 from haruki7049/udev-gothic-nf 2023-10-10 19:04:32 +02:00
ui/uiua uiua: 0.0.17 -> 0.0.18 2023-10-11 04:59:38 +02:00
un unbook: init at 0.7.3 2023-09-30 00:34:54 -03:00
up/upiano upiano: init at 0.1.2 2023-09-08 22:12:29 -04:00
ux/uxn uxn: unstable-2023-08-30 -> unstable-2023-09-06 2023-09-17 18:58:49 -03:00
wa waycheck: init at 0.1.3 2023-10-09 11:00:05 +02:00
wi/windowmaker windowmaker: 0.95.9 -> 0.96.0 2023-09-10 12:14:55 +00:00
wo/wonderdraft wonderdraft: init at 1.1.7.3 2023-09-09 21:15:07 +02:00
xm/xmldiff xmldiff: 2.4 -> 2.6.3 2023-10-04 21:56:31 -03:00
xo/xorriso xorriso: 1.5.6.pl02 -> 1.5.7 2023-09-20 22:51:30 -03:00
ye/yeahwm yeahwm: migrate to by-name 2023-09-26 12:13:10 -03:00
yt/ytui-music ytui-music: init at 2.0.0-rc1 2023-09-23 00:54:46 +10:00
zc/zcfan zcfan: init at 1.2.1 2023-09-08 19:43:02 +02:00
zi/zitadel zitadel: init at 2.37.2; nixos/zitadel: init (#254896) 2023-10-03 07:11:18 +02:00
zp/zpaqfranz zpaqfranz: 58.9 -> 58.10 2023-10-04 09:50:53 -03:00
zx/zxpy zxpy: init at 1.6.3 2023-09-08 23:27:41 -04:00
README.md by-name: make the way of adding packages clearer 2023-10-09 19:12:29 +02:00

Name-based package directories

The structure of this directory maps almost directly to top-level package attributes. This is the recommended way to add new top-level packages to Nixpkgs when possible.

Packages found in the named-based structure do not need to be explicitly added to the top-level/all-packages.nix file unless they require overriding the default value of an implicit attribute (see below).

Example

The top-level package pkgs.some-package may be declared by setting up this file structure:

pkgs
└── by-name
   ├── so
   ┊  ├── some-package
      ┊  └── package.nix

Where some-package is the package name and so is the lowercased 2-letter prefix of the package name.

The package.nix may look like this:

# A function taking an attribute set as an argument
{
  # Get access to top-level attributes for use as dependencies
  lib,
  stdenv,
  libbar,

  # Make this derivation configurable using `.override { enableBar = true }`
  enableBar ? false,
}:

# The return value must be a derivation
stdenv.mkDerivation {
  # ...
  buildInputs =
    lib.optional enableBar libbar;
}

You can also split up the package definition into more files in the same directory if necessary.

Once defined, the package can be built from the Nixpkgs root directory using:

nix-build -A some-package

See the general package conventions for more information on package definitions.

Changing implicit attribute defaults

The above expression is called using these arguments by default:

{
  lib = pkgs.lib;
  stdenv = pkgs.stdenv;
  libbar = pkgs.libbar;
}

But the package might need pkgs.libbar_2 instead. While the function could be changed to take libbar_2 directly as an argument, this would change the .override interface, breaking code like .override { libbar = ...; }. So instead it is preferable to use the same generic parameter name libbar and override its value in pkgs/top-level/all-packages.nix:

libfoo = callPackage ../by-name/so/some-package/package.nix {
  libbar = libbar_2;
};

Manual migration guidelines

Most packages are still defined in all-packages.nix and the category hierarchy. Please hold off migrating your maintained packages to this directory.

  1. An automated migration for the majority of packages is being worked on. In order to save on contributor and reviewer time, packages should only be migrated manually afterwards if they couldn't be migrated automatically.

  2. Manual migrations should only be lightly encouraged if the relevant code is being worked on anyways. For example with a package update or refactoring.

  3. Manual migrations should not remove definitions from all-packages.nix with custom arguments. That is a backwards-incompatible change because it changes the .override interface. Such packages may still be moved to pkgs/by-name however, while keeping the definition in all-packages.nix. See also changing implicit attribute defaults.

Limitations

There's some limitations as to which packages can be defined using this structure:

  • Only packages defined using pkgs.callPackage. This excludes packages defined using pkgs.python3Packages.callPackage ....

    Instead use the category hierarchy for such attributes.

  • Only top-level packages. This excludes packages for other package sets like pkgs.pythonPackages.*.

    Refer to the definition and documentation of the respective package set to figure out how such packages can be declared.

Validation

CI performs certain checks on the pkgs/by-name structure. This is done using the nixpkgs-check-by-name tool. The version of this tool used is the one that corresponds to the NixOS channel of the PR base branch. See here for details.

The tool can be run locally using

nix-build -A tests.nixpkgs-check-by-name
result/bin/nixpkgs-check-by-name .