nixpkgs/pkgs/by-name
2023-11-03 18:25:17 +01: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
ab/aba aba: init at 0.7.0 2023-10-26 08:02:21 -03: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 airlift: init at 0.3.0 2023-10-30 05:46:38 -06:00
al alpine-make-rootfs: init at 0.7.0 2023-10-19 06:17:02 -07:00
am/amazon-ssm-agent amazon-ssm-agent: 3.2.1630.0 -> 3.2.1705.0 2023-10-25 11:30:48 +02:00
ao/aocl-utils aocl-utils: init at 4.1 2023-10-06 10:34:01 +02:00
ar argtable: 3.2.1 -> 3.2.2 2023-10-21 10:50:31 -03:00
as Merge pull request #262602 from NotAShelf/master 2023-11-01 17:44:06 +01:00
aw/aws-azure-login aws-azure-login: use fetchYarnDeps 2023-09-30 13:39:56 -07:00
ax/axmldec axmldec: init at 1.2.0 2023-10-31 20:30:27 -03:00
ba bashly: init at 1.1.1 2023-10-20 18:59:06 +02:00
be bemoji: init at 0.3.0 2023-10-18 19:28:55 +02:00
bi Merge pull request #259645 from otavio/bb-lsp 2023-10-11 16:46:11 +01:00
bm/bmake bmake: more accurate metainfo about brokenness 2023-09-22 01:38:23 -03:00
bo boogie: 3.0.4 -> 3.0.5 2023-10-11 12:37:10 +00:00
br/bruno bruno: 0.17.0 -> 0.27.0 2023-10-22 22:42:10 -03:00
c2/c2fmzq c2fmzq: 0.4.8 -> 0.4.9 2023-10-27 13:45:00 +00:00
ca cargo-xwin: 0.14.8 -> 0.14.9 2023-10-31 12:20:07 +00:00
cb/cbmbasic cbmbasic: init at unstable-2022-12-18 2023-10-16 06:17:35 +02:00
cd cdk: 5.0-20221025 -> 5.0-20230201 2023-10-09 23:50:05 -03:00
ce celeste-classic: init at unstable-2020-12-08 2023-11-01 17:52:06 +02:00
ci circom: init at 2.1.6 2023-10-30 16:12:01 +01:00
cl Merge pull request #258967 from sagikazarmark/add-clarity-city 2023-10-13 00:24:48 +02:00
cn/cntb cntb: init at 1.4.6 2023-09-22 12:21:36 +00:00
co Merge pull request #262347 from adamcstephens/incus/module 2023-11-03 09:42:24 -04:00
cp/cpu-x cpu-x: migrate to by-name 2023-10-17 14:59:10 +11:00
cr/create-react-app treewide: remove myself (ma27) from a few packages 2023-10-18 15:47:20 -03:00
ct/ctx ctx: migrate to by-name 2023-10-05 17:53:27 -03:00
cy/cyme cyme: add darwin support 2023-10-25 08:49:01 +02:00
db/dbus-cpp dbus-cpp: Fix pkg-config file 2023-10-18 23:48:22 +02:00
de debianutils: 5.13 -> 5.14 2023-11-03 06:35:38 -03:00
di disarchive: rename from guile-disarchive, fix program 2023-10-28 18:07:35 +02: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 dotbot: init at 1.20.1 2023-11-03 01:21:12 -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: 1.0.11 -> 1.0.12 2023-11-03 16:10:04 +00:00
ei/eiwd eiwd: init at 2.8-1 (#208844) 2023-11-03 09:26:41 +02:00
ek/eksctl eksctl: 0.161.0 -> 0.163.0 2023-10-26 18:26:43 +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.15.1 -> 0.15.2 2023-11-02 12:21:04 +01:00
fa/fantomas fantomas: init at 6.2.2 2023-10-19 21:23:43 +02:00
fc fcitx5-nord: init at unstable-2021-07-27 2023-10-26 10:16:55 +08:00
fi/firewalk firewalk: init at 5.0 2023-10-20 17:08:27 +02:00
fl flip: init at 1.2 2023-10-20 08:00:10 -06:00
fm/fm-tune fm-tune: migrate to by-name 2023-10-17 15:10:39 +11:00
fo/fortune-kind fortune-kind: 0.1.6 -> 0.1.7 2023-11-02 10:03:13 +01:00
fr/freecell-solver freecell-solver: 4.18.0 -> 6.8.0 2023-10-14 23:08:29 -03:00
ga gash-utils: use generic wrapping 2023-10-11 18:30:32 +02:00
gb/gbar gbar: init at unstable-2023-09-21 2023-10-05 18:17:38 +08:00
ge Merge pull request #260642 from Madouura/pr/geticons 2023-10-20 13:08:45 +02:00
gh gh-screensaver: init at 2.0.1 2023-09-29 09:23:45 +02:00
gi git-get: init at 0.5.0 2023-10-16 12:04:32 -06:00
gm/gmic gmic: 3.2.6 -> 3.3.1 2023-10-09 19:01:25 -03:00
go go-camo: migrate to by-name 2023-10-17 14:56:01 +11:00
gr grun: init at 0.9.3 2023-10-19 03:26:17 +03:00
gu guile-aspell: init at 0.5.0 2023-11-03 07:49:18 +08:00
ha haunt: migrate to by-name 2023-10-11 23:42:04 -03:00
he headphones-toolbox: 0.0.4 -> 0.0.5 2023-10-18 10:17:54 -04:00
hi/hifile hifile: init at 0.9.9.5 2023-10-20 18:35:32 +02:00
ho hottext: reinit at 20231003 2023-10-31 18:34:48 +00: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.3 -> 3.4.4 2023-11-03 10:48:27 -03:00
if/ifrextractor-rs ifrextractor-rs: init at 1.5.1 2023-09-08 16:39:00 +02:00
im immersed-vr: init at 9.6 2023-10-12 15:29:17 +09:00
in nixos/incus: init module and tests 2023-11-02 19:54:02 -04:00
ir/ironbar ironbar: init at 0.13.0 2023-09-09 20:48:37 +02:00
ja/jasper jasper: 3.0.0 -> 4.0.0 2023-10-30 16:33:30 -03:00
ji jitterentropy-rngd: init at 1.2.8 2023-10-20 10:04:11 +02: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
kc/kconfig-frontends kconfig-frontends: update expression 2023-10-22 07:38:40 -03:00
kd/kdsingleapplication kdsingleapplication: init at 1.0.0 2023-10-28 12:07:24 +03:00
ke/kermit-terminal kermit-terminal: update 2023-10-11 23:42:04 -03:00
km/kmsvnc kmsvnc: init at 0.0.5 2023-10-19 10:03:51 -04:00
ko konbucase: init at 4.1.1 2023-10-21 07:35:34 +08: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 lanzaboote-tool: init at 0.3.0 2023-10-28 21:49:04 +02:00
le Merge pull request #257784 from tricktron/fix-lemminx-on-x86_64-linux 2023-10-12 18:08:12 +02:00
li Merge pull request #264675 from chayleaf/libaribcaption 2023-11-01 11:01:14 +01:00
ll/llama-cpp llama-cpp: init at 1469 2023-11-02 09:31:40 +01:00
lu/luastatus luastatus: init at 0.6.0 2023-09-23 15:40:55 +10:00
lx/lxd-to-incus lxd-to-incus: 0.1 -> 0.2 2023-10-27 23:21:18 -04:00
m2 m2-mesoplanet: init at 1.11.0 2023-11-02 18:30:32 -07:00
ma matrix-commander-rs: 0.1.32 -> 0.3.0 2023-10-15 13:56:56 +00:00
me mescc-tools-extra: init at 1.3.0 2023-11-02 18:26:39 -07:00
mf/mfoc-hardnested mfoc-hardnested: unstable-2021-08-14 -> unstable-2023-03-27 2023-09-13 23:24:14 +08:00
mi Merge pull request #261705 from gepbird/minecraftia-init 2023-10-18 21:12:49 +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
mo monophony: init at 2.3.1 2023-10-30 14:11:10 -04:00
my/mystmd mystmd: add version tester 2023-10-28 04:20:00 +00:00
n2/n2 n2: init at unstable-2023-10-10 2023-10-18 12:45:52 +02:00
na namespace-cli: 0.0.301 -> 0.0.302 2023-10-24 18:16:30 +00:00
ne Merge pull request #262904 from jakuzure/netnewswire 2023-10-28 18:52:41 +02:00
nf/nfft nfft: init at 3.5.3 2023-10-03 09:18:14 +02:00
ni nim_lk: init at 20231031 2023-10-31 18:34:48 +00:00
nl/nls nls: delete Cargo.lock 2023-10-11 22:20:32 -03:00
no/notion notion: migrate to by-name 2023-09-26 12:13:10 -03:00
ns/nsxiv nsxiv: 31 -> 32 2023-10-12 01:30:41 -03:00
nu numbat: Add support for darwin 2023-11-01 15:31:03 +01:00
oc ocsinventory-agent: init at 2.10.1 2023-10-30 17:57:52 +01:00
oe/oelint-adv oelint-adv: 3.26.1 -> 3.26.2 2023-11-02 22:40:49 +00:00
on onedrivegui: init at 1.0.3 2023-10-23 16:31:30 +00:00
op/openpgl openpgl: Fix aarch64 compilation 2023-10-13 16:06:42 -07:00
or/orchard orchard: 0.14.1 -> 0.14.3 2023-11-03 02:51:44 +00:00
ou/outputcheck outputcheck: init at 0.4.2 2023-09-19 22:23:55 +08:00
ow/owncloud-client owncloud-client: 4.2.0 -> 5.0.0 2023-10-28 12:07:42 +03:00
pa paper-age: 1.1.4 -> 1.2.0 2023-10-22 04:20:00 +00: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
pg/pgmoneta pgmoneta: 0.7.0 -> 0.7.1 2023-10-23 12:57:35 +00:00
ph phel: add postCheckInstall step 2023-11-01 12:13:04 +01:00
pi Merge pull request #258928 from psibi/pid1-rs 2023-10-18 11:21:37 -04: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
pp/ppsspp ppsspp: 1.16.5 -> 1.16.6 2023-10-13 12:31:01 -03:00
pr prox: init at 0.5.2 2023-10-26 13:09:42 -07:00
px/pxder pxder: use fetchYarnDeps 2023-09-26 10:08:41 -07:00
py pyspread: 2.0.2 -> 2.2.2 2023-10-30 16:34:26 -03:00
pz/pzip pzip: init at 0.2.0 2023-10-24 08:18:00 +02:00
qu quicksand: init at 2.0-unstable-2021-01-15 2023-10-18 12:49:51 +02:00
ra nixos/incus: init module and tests 2023-11-02 19:54:02 -04:00
rc/rc rc: migrate to by-name 2023-09-19 00:02:22 -03:00
re Merge pull request #258555 from rexxDigital/reactphysics3d 2023-10-19 23:24:26 +02:00
ri Merge pull request #260445 from adamcstephens/river-bnf/init 2023-10-23 06:38:26 -05:00
ro robodoc: refactor 2023-10-11 23:42:04 -03:00
rs rst2html5: migrate to by-name 2023-10-11 23:42:04 -03:00
ru rustplayer: init at unstable-2022-12-29 2023-10-17 10:24:30 +08:00
sa/samrewritten samrewritten: init at unstable-2023-05-23 2023-09-24 11:27:26 +09:00
sc Remove unused dists binary post install 2023-10-25 11:09:31 +02:00
se Merge pull request #257083 from rudolfvesely/master 2023-10-18 00:48:21 +02:00
sh shopware-cli: 0.3.5 -> 0.3.6 2023-10-19 12:42:14 +00: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
so/sound-of-sorting sound-of-sorting: update 2023-10-11 23:42:04 -03:00
sp spigot: add a simple test 2023-10-31 20:29:23 -03:00
ss/sssnake sssnake: init at 0.3.2 (#253441) 2023-09-05 22:21:56 +02:00
st steamguard-cli: 0.12.2 -> 0.12.3 2023-10-25 19:12:12 +02:00
su supersonic: Add MediaPlayer framework on Darwin 2023-10-24 20:24:00 +02:00
sv/svix-server svix-server: init at 1.13.0 2023-10-21 22:40:49 -04:00
sw/swipe-guess swipe-guess: init at 0.2.1 2023-10-16 19:57:50 -04:00
sy Merge pull request #262822 from siph/systemctl-tui 2023-10-24 14:15:30 +02:00
ta tailwindcss-language-server: init at 0.0.14 2023-11-02 09:59:42 +00:00
tc/tcsh tcsh: migrate to by-name 2023-09-10 01:35:11 +00:00
te terraform-plugin-docs: ensure go is in the PATH 2023-11-01 08:21:17 +01:00
th thud: add passthru.updateScript 2023-10-31 11:18:31 -04:00
ti tilda: migrate to by-name 2023-10-11 23:42:04 -03:00
tk/tkdiff tkdiff: patch to trigger recursive inline diffs 2023-10-31 11:01:37 -07:00
tm/tmuxifier tmuxifier: init at 0.13.0 2023-09-10 18:43:27 +03:00
tp/tpm2-totp tpm2-totp: init at 0.3.0 2023-10-21 13:36:52 +02:00
tr Merge pull request #262676 from ProminentRetail/tradingview-2 2023-10-28 17:47:17 +02:00
tu tusc-sh: 1.1.0 -> 1.1.1 2023-11-03 15:35:10 +00:00
tx/txr txr: migrate to by-name 2023-10-11 23:42:04 -03:00
uc uclibc-ng: refactor 2023-10-11 23:42:04 -03:00
ud Merge pull request #259844 from haruki7049/udev-gothic-nf 2023-10-10 19:04:32 +02:00
ui uiua368: update description 2023-10-30 23:48:39 +01:00
un unbook: init at 0.7.3 2023-09-30 00:34:54 -03:00
up uplosi: 0.1.1 -> 0.1.2 2023-10-13 20:36:34 +02:00
uu/uuu uuu: init at 1.5.125 2023-10-31 15:09:00 -03:00
ux/uxn uxn: unstable-2023-09-06 -> unstable-2023-09-29 2023-10-22 07:37:51 -03:00
ve vesktop: add pluiedev as maintainer 2023-11-03 14:42:34 +01:00
vi/virtio-win virtio-win: rename from win-virtio 2023-10-18 00:27:06 +02:00
wa waybar-mpris: init at unstable-2022-01-27 2023-10-22 19:18:41 -05:00
wb/wb32-dfu-updater wb32-dfu-updater: apply suggestions from code review 2023-10-18 17:10:13 +02:00
wh whatsapp-emoji-font: move to by-name 2023-10-22 20:37:35 -03:00
wi/windowmaker windowmaker.dockapps.wmcube: init 2023-10-20 00:53:54 -03:00
wo/wonderdraft wonderdraft: init at 1.1.7.3 2023-09-09 21:15:07 +02:00
ws/wslay swlay: actually enable tests 2023-10-28 18:16:59 +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
xs xsct: init at 2.0 2023-10-13 13:37:18 +02:00
ye/yeahwm yeahwm: migrate to by-name 2023-09-26 12:13:10 -03:00
yg/yggdrasil yggdrasil: 0.4.7 -> 0.5.1 2023-10-30 22:23:34 +00:00
yt/ytui-music ytui-music: init at 2.0.0-rc1 2023-09-23 00:54:46 +10:00
yu/yunfaavatar yunfaavatar: init at 0.2.0 2023-10-28 13:39:52 +03: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 zpix-pixel-font: init at 3.1.8 2023-10-31 23:54:54 +01: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 .