devenv-update(1)

📦
version 2.4.0 · 2 versions
, in nixpkgs unstable

✨ devenv-update ✨

okay so bestie, welcome to devenv-update(1) from the General Commands Manual — literally the page that tells you how to refresh your devenv.lock and honestly? she ate. 💅

🌸 NAME 🌸

devenv-update — update devenv.lock from devenv.yaml inputs.

also hi, the docs live at http://devenv.sh/inputs/ 🫶

🦋 SYNOPSIS 🦋

no cap, here's the whole shape of it:

devenv update [--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] [NAME]

🎀 DESCRIPTION 🎀

so basically: this command updates devenv.lock from your devenv.yaml inputs. that's the whole vibe. the site is http://devenv.sh/inputs/ — go look, it's giving documentation excellence ✨

💖 OPTIONS 💖

okay the options section is long but stay with me, we're getting through all of them, no skipping, periodt.

  • --user-config <USER_CONFIG> — use this user configuration file instead of the XDG default. you're the main character, you pick the file 🎀
  • [NAME] — yeah, that's it. no description. she's mysterious. iykyk 💀

🌈 INPUT OVERRIDES 🌈

this is where you tell devenv "no actually, use this instead" and she's like "ok queen" 👑

  • --from <FROM> — the source for devenv.nix.

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

examples, literally copy these:

--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. lowkey the most useful thing here.

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. yes, you gotta give her a type, she's not guessing 🧚

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!

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)

see the difference between those last two? appends vs replaces. that ! is doing so much work, honestly iconic ⭐

💜 NIX OPTIONS 💜

  • -j, --max-jobs <MAX_JOBS> — the maximum number of Nix builds running at the same time.

defaults to 1/4 of your available CPU cores (minimum 1). so she's polite about your fans 💅

  • -u, --cores <CORES> — how many CPU cores each build gets.

defaults to available cores divided by max-jobs (minimum 1).

  • -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. she's loosening up 🦋
  • --no-impure — force a hermetic environment, overriding config. back in the bubble with you 🫧
  • --offline — disable substituters and consider all previously downloaded files up-to-date. airplane mode but make it nix ✈️
  • --nix-option <NAME> <VALUE> — pass additional options to nix commands.

these 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, go deeper 😭🔍

🐚 SHELL OPTIONS 🐚

  • --/-c, --clean [<CLEAN>...] — ignore existing environment variables when entering the shell. you can pass a list of comma-separated environment variables to let through, like VIPs at the door 🎟️
  • -P, --profile <PROFILES> — activate one or more profiles defined in devenv.nix.

profiles let you 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). she's always watching 👀✨
  • --no-reload — disable auto-reload when config files change. she's chilling now.
  • --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, slay 💨
  • --no-eval-cache — disable caching of Nix evaluation results. slow but honest.
  • --refresh-eval-cache — force a refresh of the Nix evaluation cache. out with the old 🔄
  • --refresh-task-cache — force a refresh of the task cache. also out with the old 🧹

🔐 SECRETSPEC OPTIONS 🔐

  • --secretspec-provider <SECRETSPEC_PROVIDER> — override the secretspec provider. secrets, but make it specified 🤫
  • --secretspec-profile <SECRETSPEC_PROFILE> — override the secretspec profile. same energy, different profile 💅

⭐ TRACING OPTIONS ⭐

  • --trace-to <TRACE_TO> — enable tracing and set output destination(s). can be repeated for multiple outputs. our multi-tasking queen 👑

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)

ok bestie this one's got layers — env vars and formats and destinations. read it twice, it's worth it 🧚‍♀️

🌟 GLOBAL OPTIONS 🌟

  • -v, --verbose — enable additional debug logs. she's telling you everything 💬
  • -q, --quiet — silence all logs. she's saying nothing. mysterious. 🤐
  • --tui <TUI> — enable the interactive terminal interface (default when interactive).

possible values:

  • true
  • false
  • --no-tui — disable the interactive terminal interface. no pretty boxes for you 🙈
  • -h, --help — print help (see a summary with -h). the classic, the icon, the legend 🎀
ngl that's the whole page — every flag, every default, every example, all accounted for. no cap. 💖

that's a wrap, bestie ✨ this page comes from the source/version update, and it's the devenv-update(1) manual page — go update something and slay 🦋💅

📦 where this page comes from