nix3-flake-new(1)

📦
version 2.35.3 · 10 versions
, in fedora 44

💖 nix flake new 💖

okay bestie, welcome to the nix3-flake-new(1) page from the General Commands Manual — yes it's a manual-page situation, but make it cute. This is the one that spawns a whole fresh flake in an empty directory like it's no big deal. 🦋

⚠️ Warning This program is experimental and its interface is subject to change. Translation: the vibes are immaculate but the flag names might ghost you in a future release. Proceed with main character energy and a backup of your scripts. 💀

✨ Name ✨

nix flake new — create a flake in the specified directory from a template 🌸

Basically: you point at a directory that does not exist yet, and it births a flake in there. Iconic behaviour honestly.

📜 Synopsis 📜

nix flake new [option…] dest-dir

🌈 Examples 🌈

okay so here's the group chat receipts:

  • 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

see how easy that was? no cap. 🫶

💅 Description 💅

This command creates a flake in the directory dest-dir, which must not already exist. the way it refuses to touch a directory that's already there? that's the boundary-setting we love. 👑

It's equivalent to:

# mkdir dest-dir
# cd dest-dir
# nix flake init

so like... it's literally just doing those three things for you, which is giving "little sister copying your homework but correctly." 🎀

⭐ Options ⭐

  • --template, -t template — The template to use. pick your fighter 💖

🧚 Common evaluation options 🧚

  • --arg name expr — Pass the value expr as the argument name to Nix functions.
  • --arg-from-file name path — Pass the contents of file path as the argument name to Nix functions.
  • --arg-from-stdin name — Pass the contents of stdin as the argument name to Nix functions.
  • --argstr name string — Pass the string string as the argument name to Nix functions.
  • --debugger — Start an interactive environment if evaluation fails. it's giving "when it all goes wrong, at least you get a lil REPL to cry in." 😭
  • --eval-store store-url — The URL of the Nix store to use for evaluation, i.e. to store derivations (.drv files) and inputs referenced by them.
  • --impure — Allow access to mutable paths and repositories. messy but that's the point, bestie 🙈
  • --include, -I path — Add path to search path entries used to resolve lookup paths.

This option may be given multiple times.

Paths added through -I take precedence over the nix-path configuration setting and the NIX_PATH environment variable. so -I is the loudest one in the room, and it wins. 🔥

  • --override-flake original-ref resolved-ref — Override the flake registries, redirecting original-ref to resolved-ref.
  • --debug — Set the logging verbosity level to debug.
  • --log-format format — Set the format of log output; one of raw, internal-json, bar or bar-with-logs.
  • --print-build-logs, -L — Print full build logs on standard error.
  • --quiet — Decrease the logging verbosity level.
  • --verbose, -v — Increase the logging verbosity level.

👑 Miscellaneous global options 👑

  • --help — Show usage information.
  • --offline — Disable substituters and consider all previously downloaded files up-to-date.
  • --option name value — Set the Nix configuration setting name to value (overriding nix.conf).
  • --refresh — Consider all previously downloaded files out-of-date.
  • --repair — During evaluation, rewrite missing or corrupted files in the Nix store. During building, rebuild missing or corrupted store paths.
  • --version — Show version information.
📝 Note See man nix.conf for overriding configuration settings with command line flags.

and that's the whole page babe, every single flag accounted for, nothing skipped, periodt. 💜

sign-off time 🦋✨ this whole thing lives in the nix3-flake-new(1) corner of the manual, and the footer just whispers nix3-flake-new(1) right back at you — no date, no version number, just the page name holding it down at the bottom of the terminal. it's giving mysterious. it's giving minimal. we love that for it. 🫶💖🌸

📦 where this page comes from