path: root/src/nix-env/help.txt

Usage: nix-env [OPTIONS...] [ARGUMENTS...]

`nix-env' is a tool to manipulate Nix user environments.

Operations:

  --install / -i: add derivations to the user environment
  --upgrade / -u: upgrade derivation in the user environment
  --set: create a user environment containing a single derivation
  --uninstall / -e: remove derivations from the user environment
  --query / -q: perform a query on an environment or Nix expression

The previous operations take a list of derivation names.  The special
name `*' may be used to indicate all derivations.

  --switch-profile / -S [FILE]: switch to specified profile
  --switch-generation / -G NUMBER: switch to specified generation of profile
  --rollback: switch to the previous generation
  --list-generations: list available generations of a profile
  --delete-generations GENERATIONS...: deleted listed generations,
      `old' for all non-current generations
  
  --import / -I FILE: set default Nix expression

  --version: output version information
  --help: display help

Install / upgrade / uninstall flags:

  --dry-run: show what would be done, but don't do it

Installation sources:

  --from-expression / -E EXPR...: evaluate expressions specified on
      the command line; expressions should be functions that take the
      default Nix expression as an argument
  --from-profile PROFILE NAMES...: copy named packages from PROFILE
  --attr / -A ATTRS...: select attributes by name from the default Nix
      expression

Upgrade flags:

  --lt: upgrade if the current version is older (default)
  --leq: upgrade if the current version is older or equal
  --eq: "upgrade" if the current version is equal
  --always: upgrade regardless of current version

Query sources:

  --installed: use installed derivations (default)
  --available / -a: use derivations available in Nix expression

Query flags:

  --status / -s: print installed/present status
  --no-name: hide derivation names
  --attr / -A: shows the unambiguous attribute name of the
      derivation which can be used when installing with -A
  --system: print the platform type of the derivation 
  --compare-versions / -c: compare version to available or installed
  --drv-path: print path of derivation
  --out-path: print path of derivation output
  --prebuilt-only: only show derivations whose prebuilt binaries are
      available on this machine or are downloadable

Options:

  --profile / -p LINK: use specified profile instead of target of ~/.nix-profile
  --file / -f FILE: use Nix expression FILE for installation, etc.
  --verbose / -v: verbose operation (may be repeated)
  --keep-failed / -K: keep temporary directories of failed builds
  --preserve-installed: do not replace currently installed versions in `-i'
  --system-filter SYSTEM: only use derivations for specified platform