devenv-up(1)

📦
version 2.4.0 · 2 versions
, in nixpkgs unstable

💅 devenv-up — like, the whole entire manual, bestie

okay so this is devenv-up(1), straight out of the General Commands Manual — it's the page for devenv up, and we're gonna go through it together, no skipping, no "you can read the rest later." Periodt. 🎀

✨ NAME ✨

devenv-up — Start processes. Literally what it says on the tin, bestie. https://devenv.sh/processes/

🦋 SYNOPSIS 🦋

devenv up [-d|--detach] [-m|--mode] [--strict-ports] [--no-strict-ports]
[--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] [PROCESSES]

like… yes. that's a lot of flags. we'll get to every single one, don't even worry 💖

🌸 DESCRIPTION 🌸

Start processes. That's the whole vibe. https://devenv.sh/processes/ ✨

👑 OPTIONS 👑

the main character flags

  • -d, --detach — starts your processes in the background. very "i'll be back later" of it. 🫶
  • -m, --mode <MODE> — the execution mode for process tasks, and it lowkey changes how dependency resolution works. default is before. the possible values, in all their glory:
    • single — runs only the task you specified, no dependencies, she's solo.
    • after — runs the task you specified plus the tasks that run after it (downstream tasks).
    • before — runs all the dependency tasks first, then your task (upstream tasks). this is the default, so it's kind of the main character here.
    • all — runs your task with its upstream and downstream tasks. the whole friend group, no one left out. 🔥
  • --strict-ports — errors out if a port is already in use instead of auto-allocating the next available port. it's giving "no, actually, i need that one." 💅
  • --no-strict-ports — disables strict port mode, overriding strict_ports from devenv.yaml. (yes, backticks around the config key, it's a real name.)
  • --user-config <USER_CONFIG> — use this user configuration file instead of the XDG default. not like the XDG default is bad, it's just not her. 🎀
  • [PROCESSES] — start a specific process(es). lowercase gossip: you can name them.

🧚 INPUT OVERRIDES 🧚

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

Can be either a filesystem path (with a path: prefix) or a flake input reference. examples, chef's kiss:

--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. iconic behavior:
--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. fancy.

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

List types (pkgs) append to existing values by default. add a ! suffix to replace instead: pkgs!. so like, she's an appender unless you tell her otherwise.

Examples, all of them, because you deserve them:

--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> — max number of Nix builds to run concurrently. defaults to 1/4 of available CPU cores (minimum 1). she's polite about your CPU.
  • -u, --cores <CORES> — number of CPU cores available to each build. defaults to available cores divided by max-jobs (minimum 1). math! 🔥
  • -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. chaotic neutral, honestly.
  • --no-impure — force a hermetic environment, overriding config. strict queen.
  • --offline — disable substituters and consider all previously downloaded files up-to-date. no wifi, no problem. ✈️
  • --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. the "okay let's actually look at what went wrong" flag. 😭

🐚 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 VIP list, 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 outfit changes. ✨

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 watching. 👀
  • --no-reload — disable auto-reload when config files change. she's looking away.
  • --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). queen of not doing work twice.
  • --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. mysterious. iykyk.
  • --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. so extra. 💅

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. 🤫
  • --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). lowkey the most used flag of all time.
real talk bestie: --tui defaults to on when you're interactive, tracing is off unless you ask for it, and --mode defaults to before. those defaults are doing a lot of heavy lifting, so don't forget them. 💀

okay and that's the whole page, no cap. it came from the up side of the manual, dated to the devenv-up(1) page itself — so shoutout to up and devenv-up(1), mwah, the icons that they are 💖✨🎀🦋

📦 where this page comes from