devenv(1)

📦
version 2.4.0 · 2 versions
, in nixpkgs unstable

🦋 devenv(1) — the manual, but make it make sense

ok so bestie, this is the devenv(1) page — General Commands Manual energy — and it's literally about devenv 2.4.0 (aarch64-darwin): Fast, Declarative, Reproducible, and Composable Developer Environments over at https://devenv.sh. sit down, hydrate, and let's go 💖

✨ SYNOPSIS ✨

devenv [--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] [-V|--version] <subcommands>

like, that's the whole vibe in one block, no cap 🫶

🌸 DESCRIPTION 🌸

https://devenv.sh 2.4.0 (aarch64-darwin): Fast, Declarative, Reproducible, and Composable Developer Environments

that's it. that's the description. iconic, honestly. main character energy ✨

💅 OPTIONS 💅

  • --user-config <USER_CONFIG> — use this user configuration file instead of the XDG default. not me overriding the default, but make it slay 🎀
  • -V, --version — print version. that's it, that's the whole job 👑

🔥 INPUT OVERRIDES 🔥

--from <FROM>

Source for devenv.nix.

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

Examples, laid out for you bestie:

--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.

--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, typed. she's specific 💅

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)

⚡ 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).
  • -u, --cores <CORES> — number of CPU cores available to each build. 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. living dangerously, love that for you 🙈
  • --no-impure — force a hermetic environment, overriding config. the responsible friend 🧚
  • --offline — disable substituters and consider all previously downloaded files up-to-date.
  • --nix-option <NAME> <VALUE> — pass additional options to nix commands.

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

--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 sideways, go in 💀

🐚 SHELL OPTIONS 🐚

  • -c, --clean [<CLEAN>...] — ignore existing environment variables when entering the shell. pass a list of comma-separated environment variables to let through.
  • -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 ✨

--profile python-3.14
--profile backend --profile fast-startup
  • --reload — enable auto-reload when config files change (default).
  • --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).
  • --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.

new cache, who dis 🦋

🔐 SECRETSPEC OPTIONS 🔐

  • --secretspec-provider <SECRETSPEC_PROVIDER> — override the secretspec provider. secrets, but make it spec'd.
  • --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, bestie, repeat away.

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. she's chatty and we love her.
  • -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').

👑 SUBCOMMANDS 👑

okay this is the whole cast, no skips, and each one links to its own page:

⭐ VERSION ⭐

v2.4.0 (aarch64-darwin)

and that's the page, bestie — this whole thing is devenv 2.4.0 (aarch64-darwin), served fresh from the devenv(1) general commands manual. go forth and be reproducible 💜🫶✨

📦 where this page comes from