nix3-flake-new - Man Page
create a flake in the specified directory from a template
Warning
This program is experimental and its interface is subject to change.
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/-ttemplateThe template to use.
Common evaluation options
--argname exprPass the value expr as the argument name to Nix functions.
--arg-from-filename pathPass the contents of file path as the argument name to Nix functions.
--arg-from-stdinnamePass the contents of stdin as the argument name to Nix functions.
--argstrname stringPass the string string as the argument name to Nix functions.
--debuggerStart 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.--impureAllow access to mutable paths and repositories.
--include/-IpathAdd path to search path entries used to resolve lookup paths
This option may be given multiple times.
Paths added through
-Itake precedence over thenix-pathconfiguration setting and theNIX_PATHenvironment variable .--override-flakeoriginal-ref resolved-refOverride the flake registries, redirecting original-ref to resolved-ref.
Miscellaneous global options
--helpShow usage information.
--offlineDisable substituters and consider all previously downloaded files up-to-date.
--optionname valueSet the Nix configuration setting name to value (overriding
nix.conf).--refreshConsider all previously downloaded files out-of-date.
--repairDuring evaluation, rewrite missing or corrupted files in the Nix store. During building, rebuild missing or corrupted store paths.
--versionShow version information.
Note
See
man nix.conffor overriding configuration settings with command line flags.