.\" -*- mode: troff; coding: utf-8 -*-
.TH "nix3-edit" "1" ""
.PP
\fBWarning\fR: This program is \fBexperimental\fR and its interface is subject to change.
.SH Name
\fCnix edit\fR - open the Nix expression of a Nix package in $EDITOR
.SH Synopsis
\fCnix edit\fR [\fIoption\fR\[u2026]] \fIinstallable\fR
.SH Examples
.IP "\(bu" 2
Open the Nix expression of the GNU Hello package:
.LP
.EX
# nix edit nixpkgs#hello
.EE
.IP "\(bu" 2
Get the filename and line number used by \fCnix edit\fR:
.LP
.EX
# nix eval --raw nixpkgs#hello.meta.position
/nix/store/fvafw0gvwayzdan642wrv84pzm5bgpmy-source/pkgs/applications/misc/hello/default.nix:15
.EE
.SH Description
This command opens the Nix expression of a derivation in an
editor. The filename and line number of the derivation are taken from
its \fCmeta.position\fR attribute. Nixpkgs\[u2019] \fCstdenv.mkDerivation\fR sets
this attribute to the location of the definition of the
\fCmeta.description\fR, \fCversion\fR or \fCname\fR derivation attributes.
.PP
The editor to invoke is specified by the \fCEDITOR\fR environment
variable. It defaults to \fCcat\fR. If the editor is \fCemacs\fR, \fCnano\fR,
\fCvim\fR or \fCkak\fR, it is passed the line number of the derivation using
the argument \fC+<lineno>\fR.
.SH Options
\fBCommon evaluation options:\fR
.IP "\(bu" 2
\fC--arg\fR \fIname\fR \fIexpr\fR
.br
Pass the value \fIexpr\fR as the argument \fIname\fR to Nix functions.
.IP "\(bu" 2
\fC--argstr\fR \fIname\fR \fIstring\fR
.br
Pass the string \fIstring\fR as the argument \fIname\fR to Nix functions.
.IP "\(bu" 2
\fC--eval-store\fR \fIstore-url\fR
.br
The Nix store to use for evaluations.
.IP "\(bu" 2
\fC--impure\fR
.br
Allow access to mutable paths and repositories.
.IP "\(bu" 2
\fC--include\fR / \fC-I\fR \fIpath\fR
.br
Add \fIpath\fR to the list of locations used to look up \fC<...>\fR file names.
.IP "\(bu" 2
\fC--override-flake\fR \fIoriginal-ref\fR \fIresolved-ref\fR
.br
Override the flake registries, redirecting \fIoriginal-ref\fR to \fIresolved-ref\fR.
.LP
\fBCommon flake-related options:\fR
.IP "\(bu" 2
\fC--commit-lock-file\fR
.br
Commit changes to the flake\[u2019]s lock file.
.IP "\(bu" 2
\fC--inputs-from\fR \fIflake-url\fR
.br
Use the inputs of the specified flake as registry entries.
.IP "\(bu" 2
\fC--no-registries\fR
.br
Don\[u2019]t allow lookups in the flake registries. This option is deprecated; use \fC--no-use-registries\fR.
.IP "\(bu" 2
\fC--no-update-lock-file\fR
.br
Do not allow any updates to the flake\[u2019]s lock file.
.IP "\(bu" 2
\fC--no-write-lock-file\fR
.br
Do not write the flake\[u2019]s newly generated lock file.
.IP "\(bu" 2
\fC--override-input\fR \fIinput-path\fR \fIflake-url\fR
.br
Override a specific flake input (e.g. \fCdwarffs/nixpkgs\fR). This implies \fC--no-write-lock-file\fR.
.IP "\(bu" 2
\fC--recreate-lock-file\fR
.br
Recreate the flake\[u2019]s lock file from scratch.
.IP "\(bu" 2
\fC--update-input\fR \fIinput-path\fR
.br
Update a specific flake input (ignoring its previous entry in the lock file).
.LP
\fBOptions that change the interpretation of installables:\fR
.IP "\(bu" 2
\fC--derivation\fR
.br
Operate on the store derivation rather than its outputs.
.IP "\(bu" 2
\fC--expr\fR \fIexpr\fR
.br
Interpret installables as attribute paths relative to the Nix expression \fIexpr\fR.
.IP "\(bu" 2
\fC--file\fR / \fC-f\fR \fIfile\fR
.br
Interpret installables as attribute paths relative to the Nix expression stored in \fIfile\fR. If \fIfile\fR is the character -, then a Nix expression will be read from standard input.