Warning
This program is experimental and its interface is subject to change.
Name
nix run - run a Nix application
Synopsis
nix run [option...] installable args...
Examples
- 
Run the default app from the
blender-binflake:# nix run blender-bin - 
Run a non-default app from the
blender-binflake:# nix run blender-bin#blender_2_83Tip: you can find apps provided by this flake by running
nix flake show blender-bin. - 
Run
vimfrom thenixpkgsflake:# nix run nixpkgs#vimNote that
vim(as of the time of writing of this page) is not an app but a package. Thus, Nix runs the eponymous file from thevimpackage. - 
Run
vimwith arguments:# nix run nixpkgs#vim -- --help 
Description
nix run builds and runs installable, which must evaluate to an
app or a regular Nix derivation.
If installable evaluates to an app (see below), it executes the program specified by the app definition.
If installable evaluates to a derivation, it will try to execute the
program <out>/bin/<name>, where out is the primary output store
path of the derivation, and name is the first of the following that
exists:
- The 
meta.mainProgramattribute of the derivation. - The 
pnameattribute of the derivation. - The name part of the value of the 
nameattribute of the derivation. 
For instance, if name is set to hello-1.10, nix run will run
$out/bin/hello.
Flake output attributes
If no flake output attribute is given, nix run tries the following
flake output attributes:
- 
apps.<system>.default - 
packages.<system>.default 
If an attribute name is given, nix run tries the following flake
output attributes:
- 
apps.<system>.<name> - 
packages.<system>.<name> - 
legacyPackages.<system>.<name> 
Apps
An app is specified by a flake output attribute named
apps.<system>.<name>. It looks like this:
apps.x86_64-linux.blender_2_79 = {
  type = "app";
  program = "${self.packages.x86_64-linux.blender_2_79}/bin/blender";
};
The only supported attributes are:
- 
type(required): Must be set toapp. - 
program(required): The full path of the executable to run. It must reside in the Nix store. 
Options
Common evaluation options
- 
--argname exprPass the value expr as the argument name to Nix functions.
 - 
--argstrname stringPass the string string as the argument name to Nix functions.
 - 
Start an interactive environment if evaluation fails.
 - 
--eval-storestore-urlThe URL of the Nix store to use for evaluation, i.e. to store derivations (
.drvfiles) and inputs referenced by them. - 
Allow access to mutable paths and repositories.
 - 
--include/-IpathAdd path to the Nix search path. The Nix search path is initialized from the colon-separated
NIX_PATHenvironment variable, and is used to look up the location of Nix expressions using paths enclosed in angle brackets (i.e.,<nixpkgs>).For instance, passing
-I /home/eelco/Dev -I /etc/nixoswill cause Nix to look for paths relative to
/home/eelco/Devand/etc/nixos, in that order. This is equivalent to setting theNIX_PATHenvironment variable to/home/eelco/Dev:/etc/nixosIt is also possible to match paths against a prefix. For example, passing
-I nixpkgs=/home/eelco/Dev/nixpkgs-branch -I /etc/nixoswill cause Nix to search for
<nixpkgs/path>in/home/eelco/Dev/nixpkgs-branch/pathand/etc/nixos/nixpkgs/path.If a path in the Nix search path starts with
http://orhttps://, it is interpreted as the URL of a tarball that will be downloaded and unpacked to a temporary location. The tarball must consist of a single top-level directory. For example, passing-I nixpkgs=https://github.com/NixOS/nixpkgs/archive/master.tar.gztells Nix to download and use the current contents of the
masterbranch in thenixpkgsrepository.The URLs of the tarballs from the official
nixos.orgchannels (see the manual page fornix-channel) can be abbreviated aschannel:<channel-name>. For instance, the following two flags are equivalent:-I nixpkgs=channel:nixos-21.05 -I nixpkgs=https://nixos.org/channels/nixos-21.05/nixexprs.tar.xzYou can also fetch source trees using flake URLs and add them to the search path. For instance,
-I nixpkgs=flake:nixpkgsspecifies that the prefix
nixpkgsshall refer to the source tree downloaded from thenixpkgsentry in the flake registry. Similarly,-I nixpkgs=flake:github:NixOS/nixpkgs/nixos-22.05makes
<nixpkgs>refer to a particular branch of theNixOS/nixpkgsrepository on GitHub. - 
--override-flakeoriginal-ref resolved-refOverride the flake registries, redirecting original-ref to resolved-ref.
 
Common flake-related options
- 
Commit changes to the flake's lock file.
 - 
--inputs-fromflake-urlUse the inputs of the specified flake as registry entries.
 - 
Don't allow lookups in the flake registries.
DEPRECATED
Use
--no-use-registriesinstead. - 
Do not allow any updates to the flake's lock file.
 - 
Do not write the flake's newly generated lock file.
 - 
--output-lock-fileflake-lock-pathWrite the given lock file instead of
flake.lockwithin the top-level flake. - 
--override-inputinput-path flake-urlOverride a specific flake input (e.g.
dwarffs/nixpkgs). This implies--no-write-lock-file. - 
Recreate the flake's lock file from scratch.
DEPRECATED
Use
nix flake updateinstead. - 
--reference-lock-fileflake-lock-pathRead the given lock file instead of
flake.lockwithin the top-level flake. - 
--update-inputinput-pathUpdate a specific flake input (ignoring its previous entry in the lock file).
DEPRECATED
Use
nix flake updateinstead. 
Logging-related options
- 
Set the logging verbosity level to 'debug'.
 - 
--log-formatformatSet the format of log output; one of
raw,internal-json,barorbar-with-logs. - 
--print-build-logs/-LPrint full build logs on standard error.
 - 
Decrease the logging verbosity level.
 - 
--verbose/-vIncrease the logging verbosity level.
 
Miscellaneous global options
- 
Show usage information.
 - 
Disable substituters and consider all previously downloaded files up-to-date.
 - 
--optionname valueSet the Nix configuration setting name to value (overriding
nix.conf). - 
Consider all previously downloaded files out-of-date.
 - 
During evaluation, rewrite missing or corrupted files in the Nix store. During building, rebuild missing or corrupted store paths.
 - 
Show version information.
 
Options that change the interpretation of installables
- 
--exprexprInterpret installables as attribute paths relative to the Nix expression expr.
 - 
--file/-ffileInterpret installables as attribute paths relative to the Nix expression stored in file. If file is the character -, then a Nix expression will be read from standard input. Implies
--impure. 
Note
See
man nix.conffor overriding configuration settings with command line flags.