devenv-container-run(1)

📦
version 2.4.0 · 2 versions
, in nixpkgs unstable

💅 devenv-container-run — the devenv container run glow-up

okay so real talk, bestie: this is the manual page for devenv-container-run, and it lives in the General Commands Manual neighborhood. she's a whole vibe, she runs a container, and yes, we're gonna read the whole thing together. pour something iced. 🧊

✨ NAME ✨

devenv-container-run — literally run a container. that's her job. that's the whole job. 👑

🦋 SYNOPSIS 🦋

devenv container run [--copy-args] [--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>

like yeah, that's a lot of brackets, but every single one of them is eating. don't skip a single flag, i'm watching 👀

🌸 DESCRIPTION 🌸

Run a container. seriously, that's what it says, and honestly? iconic brevity. no notes. 💅

🎀 OPTIONS 🎀

  • --copy-args <COPY_ARGS> — passes <COPY_ARGS> along, no cap.
  • --user-config <USER_CONFIG> — use this user configuration file instead of the XDG default. she's not like the other configs. 💖
  • <NAME> — the name you're pointing at, bestie. gotta name her.

👑 INPUT OVERRIDES 👑

  • --from <FROM> — where your devenv.nix comes from.

it can be either a filesystem path (with the path: prefix, don't forget it ✨) 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> — overrides inputs in devenv.yaml. main character behavior fr.

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. the typed part is doing a lot of heavy lifting here, don't ignore it 👀

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). generous queen. 🫶

  • -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. 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. iykyk 📖

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 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. spring cleaning, but for env vars 🧹
  • -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. it's giving layers. 🎂

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 listening 💖
  • --no-reload — disable auto-reload when config files change. boundaries! ✋
  • --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 etc etc 💅
  • --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. shh. 🤐
  • --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. the more the merrier fr fr.

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 telling you everything. 🗣️
  • -q, --quiet — silence all logs. not a peep. 🤐
  • --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). the classic. the goat. 🐐
ngl bestie, <TUI> and <SHELL_TYPE> take fixed values — don't go freestyling a random string in there, the parser will simply not be amused 😭

aaaaand that's the whole page!! no skips, no cuts, every flag accounted for 💯 this was run from devenv-container-run(1) — mwah, go run a container, you absolute icon 🫶💖✨

📦 where this page comes from