devenv-machines-deploy(1)

📦 version 2.4.0, in nixpkgs unstable

💅 devenv-machines-deploy(1) — the devenv machines deploy glow-up

okay so bestie, welcome to devenv-machines-deploy (that's the manual-name part of the header, we're keeping it, it's iconic). This is from the General Commands Manual and it's literally your whole fleet's main character moment ✨

🌸 NAME 🌸

devenv-machines-deploy — build, review, and deploy NixOS, nix-darwin, and home-manager together. fr fr, all of them, at once 🫶

https://devenv.sh/machines/#updating-an-existing-host

🎀 SYNOPSIS 🎀

devenv machines deploy [--yes] [--max-concurrent]
[--use-machines-as-builders] [--user-config] [--from]
[-o|--override-input] [-O|--option] [-j|--max-jobs] [-u|--cores]
[-s|--system] [-i|--impure] [--no-impure] [--offline] [--nix-option]
[--nix-debugger] [-c|--clean] [-P|--profile] [--reload] [--no-reload]
[--shell] [--eval-cache] [--no-eval-cache] [--refresh-eval-cache]
[--refresh-task-cache] [--secretspec-provider] [--secretspec-profile]
[--trace-to] [-v|--verbose] [-q|--quiet] [--tui] [--no-tui] [-h|--help]
[NAMES]

🦋 DESCRIPTION 🦋

Build, review, and deploy NixOS, nix-darwin, and home-manager together. That's the whole vibe. No cap.

https://devenv.sh/machines/#updating-an-existing-host

✨ OPTIONS ✨

  • --yes — Apply the displayed fleet plan without an interactive confirmation. it just goes, no "are you sure" moment 💀
  • --max-concurrent <N> — Activate at most N machines per batch (default: 1). Stop after a failed batch — like, it will not keep going after a flop, periodt.
  • --use-machines-as-builders — Treat every machine with a reachable target.host as a candidate Nix remote builder for cross-architecture builds. When a machine's system differs from the local host, a matching machine is used as the builder. basically your machines be building for each other, mutual aid slay 🫶
  • --user-config <USER_CONFIG> — Use this user configuration file instead of the XDG default. (no default-shaming, the XDG one is fine, but you do you)
  • [NAMES] — Machine names to deploy. With no names, deploys every machine in the attrset that has target.host set; machines without a host are skipped. so if you're lazy (same) it just does everything that can be done 💅

🔥 INPUT OVERRIDES 🔥

  • --from <FROM> — Source for devenv.nix.

Can be either a filesystem path (with path: prefix) or a flake input reference.

Examples:

--from github:cachix/devenv
--from github:cachix/devenv?dir=examples/simple
--from path:/absolute/path/to/project
--from path:./relative/path
  • -o, --override-input <NAME> <URI> — Override inputs in devenv.yaml.

Examples:

--override-input nixpkgs github:NixOS/nixpkgs/nixos-unstable
--override-input nixpkgs path:/path/to/local/nixpkgs
  • -O, --option <OPTION:TYPE> <VALUE> — Override configuration options with typed values. (typed!! we love type safety in this house 🎀)

OPTION must include a type: <attribute>:<type>. Supported types: string, int, float, bool, path, pkg, pkgs

List types (pkgs) append to existing values by default. Add a ! suffix to replace instead: pkgs! — that ! is doing so much work, honestly iconic.

Examples:

--option languages.rust.channel:string beta
--option services.postgres.enable:bool true
--option languages.python.version:string 3.10
--option packages:pkgs "ncdu git"       (appends to packages)
--option packages:pkgs! "ncdu git"      (replaces all packages)

🧚 NIX OPTIONS 🧚

  • -j, --max-jobs <MAX_JOBS> — Maximum number of Nix builds to run concurrently.

Defaults to 1/4 of available CPU cores (minimum 1). generous but not too generous 🍓

  • -u, --cores <CORES> — Number of CPU cores available to each build.

Defaults to available cores divided by max-jobs (minimum 1). the math is mathing.

  • -s, --system <SYSTEM> — Override the target system.

Defaults to the host system (e.g. aarch64-darwin, x86_64-linux).

  • -i, --impure — Relax the hermeticity of the environment. living dangerously, we respect it 🙈
  • --no-impure — Force a hermetic environment, overriding config. the responsible friend.
  • --offline — Disable substituters and consider all previously downloaded files up-to-date. no internet? no problem, bestie 💜
  • --nix-option <NAME> <VALUE> — Pass additional options to nix commands.

These options are passed directly to Nix using the --option flag. See man nix.conf for the full list of available options.

Examples:

--nix-option sandbox false
--nix-option keep-outputs true
--nix-option system x86_64-darwin
  • --nix-debugger — Enter the Nix debugger on failure. when things go wrong, we go deep 💀🔍

💖 SHELL OPTIONS 💖

  • -c, --clean [<CLEAN>...] — Ignore existing environment variables when entering the shell. Pass a list of comma-separated environment variables to let through. a little bouncer for your env vars 🚪
  • -P, --profile <PROFILES> — Activate one or more profiles defined in devenv.nix.

Profiles allow you to define different configurations that can be merged with your base configuration.

See https://devenv.sh/profiles for more information.

Examples:

--profile python-3.14
--profile backend --profile fast-startup
  • --reload — Enable auto-reload when config files change (default). it's giving attentive partner.
  • --no-reload — Disable auto-reload when config files change.
  • --shell <SHELL_TYPE> — Shell to use for interactive sessions (bash, zsh, fish, nu).

Possible values:

  • bash
  • zsh
  • fish
  • nu

🌈 CACHE OPTIONS 🌈

  • --eval-cache — Enable caching of Nix evaluation results (default). speed ✨
  • --no-eval-cache — Disable caching of Nix evaluation results.
  • --refresh-eval-cache — Force a refresh of the Nix evaluation cache.
  • --refresh-task-cache — Force a refresh of the task cache.

💜 SECRETSPEC OPTIONS 💜

  • --secretspec-provider <SECRETSPEC_PROVIDER> — Override the secretspec provider 🤫
  • --secretspec-profile <SECRETSPEC_PROFILE> — Override the secretspec profile 🤫

⭐ TRACING OPTIONS ⭐

  • --trace-to <TRACE_TO> — Enable tracing and set output destination(s). Can be repeated for multiple outputs.

Syntax: [format:]destination

Examples:

--trace-to stderr                              # json to stderr
--trace-to pretty:stderr                       # pretty format to stderr
--trace-to json:file:/tmp/trace.json           # JSON to file
--trace-to otlp-grpc                           # OTLP gRPC to default endpoint
--trace-to otlp-grpc:http://collector:4317     # OTLP gRPC to custom endpoint

Multiple outputs:

--trace-to pretty:stderr --trace-to json:file:/tmp/t.json

Destinations: stdout, stderr, file:<path>, http(s)://<host>:<port>. Formats: json (default), pretty, full, otlp-grpc, otlp-http-protobuf, otlp-http-json

When format is omitted, defaults to json. Tracing is disabled by default.

[env: DEVENV_TRACE_TO=] (comma-separated) [env: DEVENV_TRACE_DEFAULT_TO=] (comma-separated, used only when no explicit tracing is configured; set to empty string to suppress)

👑 GLOBAL OPTIONS 👑

  • -v, --verbose — Enable additional debug logs. the group chat gets loud 🗣️
  • -q, --quiet — Silence all logs. not a word. 🤐
  • --tui <TUI> — Enable the interactive terminal interface (default when interactive).

Possible values:

  • true
  • false
  • --no-tui — Disable the interactive terminal interface.
  • -h, --help — Print help (see a summary with -h). classic, we stan a helpful icon 💅

okay that's the whole page bestie, you ate that reading 💖 and for the cute sign-off: this one's sourced from deploy and stamped devenv-machines-deploy(1) — the footer didn't hand us a date, so we're just gonna say it's giving timeless 🎀✨ go deploy something gorgeous 🦋

📦 where this page comes from