.. | ||
_4/_4th | ||
aa/aarch64-esr-decoder | ||
af/afterstep | ||
ai/airscan | ||
al | ||
ar | ||
as/asciiquarium-transparent | ||
aw/aws-azure-login | ||
ba | ||
be/berry | ||
bi/binsort | ||
bm/bmake | ||
bo | ||
ca | ||
cd/cdwe | ||
ce/celluloid | ||
ci/circle-flags | ||
cl/clzip | ||
cn/cntb | ||
co | ||
de/debianutils | ||
dj/djent | ||
dm/dmenu-bluetooth | ||
ec/ecmtools | ||
el/elvish | ||
en/engage | ||
es/esbuild-config | ||
ez/eza | ||
fl/fleng | ||
ga | ||
gh | ||
gi/gitmoji-cli | ||
go/goat | ||
gr/grimblast | ||
gu | ||
ha/ha-mqtt-discoverable-cli | ||
he | ||
hy | ||
i3/i3bar-river | ||
if/ifrextractor-rs | ||
ir/ironbar | ||
ji/jinja2-cli | ||
ju/justbuild | ||
ka/katriawm | ||
kt/ktfmt | ||
la/labwc | ||
le | ||
li | ||
lu/luastatus | ||
ma | ||
mf/mfoc-hardnested | ||
mk/mksh | ||
na/nawk | ||
ne/netproc | ||
ni/nixos-anywhere | ||
no/notion | ||
oe/oelint-adv | ||
op/openpgl | ||
or/orchard | ||
ou/outputcheck | ||
pa/passes | ||
pd/pdepend | ||
pe | ||
ph/phpdocumentor | ||
pl/platformsh | ||
po/poethepoet | ||
pr/prettier-d-slim | ||
px/pxder | ||
qu/quicktype | ||
ra/ratpoison | ||
rc/rc | ||
re | ||
ri/ripsecrets | ||
ro | ||
ru/rusti-cal | ||
sa/samrewritten | ||
sc/screentest | ||
si/simplex-chat-desktop | ||
sl | ||
sm/smallwm | ||
ss/sssnake | ||
st/static-server | ||
su/sunpaper | ||
sy/symbolicator | ||
tc/tcsh | ||
th | ||
ti/tinywm | ||
tm/tmuxifier | ||
tr/trealla | ||
uc/ucg | ||
ui/uiua | ||
un | ||
up/upiano | ||
ux/uxn | ||
wa | ||
wi/windowmaker | ||
wo/wonderdraft | ||
xo/xorriso | ||
ye/yeahwm | ||
yt/ytui-music | ||
zc/zcfan | ||
zp/zpaqfranz | ||
zx/zxpy | ||
README.md |
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.
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.
-
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.
-
Manual migrations should only be lightly encouraged if the relevant code is being worked on anyways. For example with a package update or refactoring.
-
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 topkgs/by-name
however, while keeping the definition inall-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 usingpkgs.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 .