Warning
This program is experimental and its interface is subject to change.
Name
nix flake new
- create a flake in the specified directory from a template
Synopsis
nix flake new
[option...] dest-dir
Examples
-
Create a flake using the default template in the directory
hello
:# nix flake new hello
-
List available templates:
# nix flake show templates
-
Create a flake from a specific template in the directory
hello
:# nix flake new hello -t templates#trivial
Description
This command creates a flake in the directory dest-dir
, which must
not already exist. It's equivalent to:
# mkdir dest-dir
# cd dest-dir
# nix flake init
Options
-
--template
/-t
templateThe template to use.
Common evaluation options
-
--arg
name exprPass the value expr as the argument name to Nix functions.
-
--arg-from-file
name pathPass the contents of file path as the argument name to Nix functions.
-
--arg-from-stdin
namePass the contents of stdin as the argument name to Nix functions.
-
--argstr
name stringPass the string string as the argument name to Nix functions.
-
Start an interactive environment if evaluation fails.
-
--eval-store
store-urlThe URL of the Nix store to use for evaluation, i.e. to store derivations (
.drv
files) and inputs referenced by them. -
Allow access to mutable paths and repositories.
-
--include
/-I
pathAdd path to search path entries used to resolve lookup paths
This option may be given multiple times.
Paths added through
-I
take precedence over thenix-path
configuration setting and theNIX_PATH
environment variable. -
--override-flake
original-ref resolved-refOverride the flake registries, redirecting original-ref to resolved-ref.
Logging-related options
-
Set the logging verbosity level to 'debug'.
-
--log-format
formatSet the format of log output; one of
raw
,internal-json
,bar
orbar-with-logs
. -
--print-build-logs
/-L
Print full build logs on standard error.
-
Decrease the logging verbosity level.
-
--verbose
/-v
Increase the logging verbosity level.
Miscellaneous global options
-
Show usage information.
-
Disable substituters and consider all previously downloaded files up-to-date.
-
--option
name 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.
Note
See
man nix.conf
for overriding configuration settings with command line flags.