devenv-use...ig-validate(1)

📦 version 2.4.0, in nixpkgs unstable

💅 devenv-user-config-validate — the manual page, bestie edition

okay so real talk, the page you're reading is from the devenv-use...ig-validate(1) manual — that whole devenv-user-config-validate corner of the world. It's short, it's sweet, and it's literally just about checking that your user config file is valid. No cap. 🎀

✨ NAME ✨

devenv-user-config-validate — validate the user configuration file. that's it, that's the job. 💖

🦋 SYNOPSIS 🦋

devenv user-config validate [--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]

🌸 DESCRIPTION 🌸

Validate the user configuration file. yes, that's the entire description. it's giving "confident and concise." the vibes are immaculate and the purpose is clear: it checks your user config and tells you if it's a slay or a mess. 👑

💅 OPTIONS 💅

  • --user-config <USER_CONFIG> — use this user configuration file instead of the XDG default. main character file energy, fr fr.

🧚 INPUT OVERRIDES 🧚

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

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

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. you can just say "actually use this one" and it will. iconic.

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.

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!. the ! is doing so much work and honestly? respect.

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). not me rationing your cores like a snack.

  • -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. chaos mode (affectionate).
  • --no-impure — force a hermetic environment, overriding config. no chaos allowed, periodt.
  • --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 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, you get to go in there yourself. detective era. 🔍

🐚 SHELL OPTIONS 🐚

  • -c, --clean [<CLEAN>...] — ignore existing environment variables when entering the shell. pass a list of comma-separated environment variables to let through. like a bouncer with a guest list, honestly.
  • -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 just keeps up with you. 🫶
  • --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). work smarter, not harder.
  • --no-eval-cache — disable caching of Nix evaluation results.
  • --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.

🙈 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. (yes, off by default — you have to ask for the lore.)

[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 girlies love a paper trail.
  • -q, --quiet — silence all logs. 🧘‍♀️
  • --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). yes, the summary version is the trailer, the full one is the director's cut. 💀
ok that's genuinely everything on the page — every flag, every default, every example, every env var. nothing skipped, nothing invented. you're so welcome. 💖

🌸 and that's the whole manual, bestie! brought to you by validate (the source/version) and dated devenv-use...ig-validate(1) (the date, as these things go) — see you in the next --help. slay responsibly. 🫶✨

📦 where this page comes from