.\" -*- mode: troff; coding: utf-8 -*-
.TH "nix3-copy" "1" ""
.RS
.PP
\fBWarning\fR 
.br
This program is
\fB\fBexperimental\fR\fR
and its interface is subject to change.
.RE
.SH Name
.LP
\f(CRnix copy\fR - copy paths between Nix stores
.SH Synopsis
.LP
\f(CRnix copy\fR [\fIoption\fR\[u2026]] \fIinstallables\fR\[u2026]
.SH Examples
.IP "\(bu" 3
Copy Firefox from the local store to a binary cache in \f(CR/tmp/cache\fR:
.LP
.EX
# nix copy --to file:///tmp/cache $(type -p firefox)
.EE
.IP
Note the \f(CRfile://\fR - without this, the destination is a chroot
store, not a binary cache.
.IP "\(bu" 3
Copy all store paths from a local binary cache in \f(CR/tmp/cache\fR to the local store:
.LP
.EX
# nix copy --all --from file:///tmp/cache
.EE
.IP "\(bu" 3
Copy the entire current NixOS system closure to another machine via
SSH:
.LP
.EX
# nix copy --substitute-on-destination --to ssh://server /run/current-system
.EE
.IP
The \f(CR-s\fR flag causes the remote machine to try to substitute missing
store paths, which may be faster if the link between the local and
remote machines is slower than the link between the remote machine
and its substituters (e.g. \f(CRhttps://cache.nixos.org\fR).
.IP "\(bu" 3
Copy a closure from another machine via SSH:
.LP
.EX
# nix copy --from ssh://server /nix/store/a6cnl93nk1wxnq84brbbwr6hxw9gp2w9-blender-2.79-rc2
.EE
.IP "\(bu" 3
Copy Hello to a binary cache in an Amazon S3 bucket:
.LP
.EX
# nix copy --to s3://my-bucket?region=eu-west-1 nixpkgs#hello
.EE
.IP
or to an S3-compatible storage system:
.LP
.EX
# nix copy --to s3://my-bucket?region=eu-west-1&endpoint=example.com nixpkgs#hello
.EE
.IP
Note that this only works if Nix is built with AWS support.
.IP "\(bu" 3
Copy a closure from \f(CR/nix/store\fR to the chroot store \f(CR/tmp/nix/nix/store\fR:
.LP
.EX
# nix copy --to /tmp/nix nixpkgs#hello --no-check-sigs
.EE
.SH Description
.LP
\f(CRnix copy\fR copies store path closures between two Nix stores. The
source store is specified using \f(CR--from\fR and the destination using
\f(CR--to\fR. If one of these is omitted, it defaults to the local store.
.SH Options
.IP "\(bu" 3
\fB\f(CR--from\fR\fR \fIstore-uri\fR
.IP
URL of the source Nix store.
.IP "\(bu" 3
\fB\f(CR--no-check-sigs\fR\fR
.IP
Do not require that paths are signed by trusted keys.
.IP "\(bu" 3
\fB\f(CR--stdin\fR\fR
.IP
Read installables from the standard input. No default installable applied.
.IP "\(bu" 3
\fB\f(CR--substitute-on-destination\fR\fR / \f(CR-s\fR
.IP
Whether to try substitutes on the destination store (only supported by SSH stores).
.IP "\(bu" 3
\fB\f(CR--to\fR\fR \fIstore-uri\fR
.IP
URL of the destination Nix store.
.SS
Common evaluation options
.IP "\(bu" 3
\fB\f(CR--arg\fR\fR \fIname\fR \fIexpr\fR
.IP
Pass the value \fIexpr\fR as the argument \fIname\fR to Nix functions.
.IP "\(bu" 3
\fB\f(CR--arg-from-file\fR\fR \fIname\fR \fIpath\fR
.IP
Pass the contents of file \fIpath\fR as the argument \fIname\fR to Nix functions.
.IP "\(bu" 3
\fB\f(CR--arg-from-stdin\fR\fR \fIname\fR
.IP
Pass the contents of stdin as the argument \fIname\fR to Nix functions.
.IP "\(bu" 3
\fB\f(CR--argstr\fR\fR \fIname\fR \fIstring\fR
.IP
Pass the string \fIstring\fR as the argument \fIname\fR to Nix functions.
.IP "\(bu" 3
\fB\f(CR--debugger\fR\fR
.IP
Start an interactive environment if evaluation fails.
.IP "\(bu" 3
\fB\f(CR--eval-store\fR\fR \fIstore-url\fR
.IP
The \fBURL of the Nix store\fR
to use for evaluation, i.e. to store derivations (\f(CR.drv\fR files) and inputs referenced by them.
.IP "\(bu" 3
\fB\f(CR--impure\fR\fR
.IP
Allow access to mutable paths and repositories.
.IP "\(bu" 3
\fB\f(CR--include\fR\fR / \f(CR-I\fR \fIpath\fR
.IP
Add \fIpath\fR to search path entries used to resolve \fBlookup paths\fR
.IP
This option may be given multiple times.
.IP
Paths added through \f(CR-I\fR take precedence over the \fB\f(CRnix-path\fR configuration setting\fR and the \fB\f(CRNIX_PATH\fR environment variable\fR.
.IP "\(bu" 3
\fB\f(CR--override-flake\fR\fR \fIoriginal-ref\fR \fIresolved-ref\fR
.IP
Override the flake registries, redirecting \fIoriginal-ref\fR to \fIresolved-ref\fR.
.SS
Common flake-related options
.IP "\(bu" 3
\fB\f(CR--commit-lock-file\fR\fR
.IP
Commit changes to the flake\(cqs lock file.
.IP "\(bu" 3
\fB\f(CR--inputs-from\fR\fR \fIflake-url\fR
.IP
Use the inputs of the specified flake as registry entries.
.IP "\(bu" 3
\fB\f(CR--no-registries\fR\fR
.IP
Don\(cqt allow lookups in the flake registries.
.RS
.IP
\fBDEPRECATED\fR
.IP
Use \fB\f(CR--no-use-registries\fR\fR instead.
.RE
.IP "\(bu" 3
\fB\f(CR--no-update-lock-file\fR\fR
.IP
Do not allow any updates to the flake\(cqs lock file.
.IP "\(bu" 3
\fB\f(CR--no-write-lock-file\fR\fR
.IP
Do not write the flake\(cqs newly generated lock file.
.IP "\(bu" 3
\fB\f(CR--output-lock-file\fR\fR \fIflake-lock-path\fR
.IP
Write the given lock file instead of \f(CRflake.lock\fR within the top-level flake.
.IP "\(bu" 3
\fB\f(CR--override-input\fR\fR \fIinput-path\fR \fIflake-url\fR
.IP
Override a specific flake input (e.g. \f(CRdwarffs/nixpkgs\fR). This implies \f(CR--no-write-lock-file\fR.
.IP "\(bu" 3
\fB\f(CR--recreate-lock-file\fR\fR
.IP
Recreate the flake\(cqs lock file from scratch.
.RS
.IP
\fBDEPRECATED\fR
.IP
Use \fB\f(CRnix flake update\fR\fR instead.
.RE
.IP "\(bu" 3
\fB\f(CR--reference-lock-file\fR\fR \fIflake-lock-path\fR
.IP
Read the given lock file instead of \f(CRflake.lock\fR within the top-level flake.
.IP "\(bu" 3
\fB\f(CR--update-input\fR\fR \fIinput-path\fR
.IP
Update a specific flake input (ignoring its previous entry in the lock file).
.RS
.IP
\fBDEPRECATED\fR
.IP
Use \fB\f(CRnix flake update\fR\fR instead.
.RE
.SS
Logging-related options
.IP "\(bu" 3
\fB\f(CR--debug\fR\fR
.IP
Set the logging verbosity level to \(oqdebug\(cq.
.IP "\(bu" 3
\fB\f(CR--log-format\fR\fR \fIformat\fR
.IP
Set the format of log output; one of \f(CRraw\fR, \f(CRinternal-json\fR, \f(CRbar\fR or \f(CRbar-with-logs\fR.
.IP "\(bu" 3
\fB\f(CR--print-build-logs\fR\fR / \f(CR-L\fR
.IP
Print full build logs on standard error.
.IP "\(bu" 3
\fB\f(CR--quiet\fR\fR
.IP
Decrease the logging verbosity level.
.IP "\(bu" 3
\fB\f(CR--verbose\fR\fR / \f(CR-v\fR
.IP
Increase the logging verbosity level.
.SS
Miscellaneous global options
.IP "\(bu" 3
\fB\f(CR--help\fR\fR
.IP
Show usage information.
.IP "\(bu" 3
\fB\f(CR--offline\fR\fR
.IP
Disable substituters and consider all previously downloaded files up-to-date.
.IP "\(bu" 3
\fB\f(CR--option\fR\fR \fIname\fR \fIvalue\fR
.IP
Set the Nix configuration setting \fIname\fR to \fIvalue\fR (overriding \f(CRnix.conf\fR).
.IP "\(bu" 3
\fB\f(CR--refresh\fR\fR
.IP
Consider all previously downloaded files out-of-date.
.IP "\(bu" 3
\fB\f(CR--repair\fR\fR
.IP
During evaluation, rewrite missing or corrupted files in the Nix store. During building, rebuild missing or corrupted store paths.
.IP "\(bu" 3
\fB\f(CR--version\fR\fR
.IP
Show version information.
.SS
Options that change the interpretation of \fBinstallables\fR
.IP "\(bu" 3
\fB\f(CR--all\fR\fR
.IP
Apply the operation to every store path.
.IP "\(bu" 3
\fB\f(CR--derivation\fR\fR
.IP
Operate on the \fBstore derivation\fR rather than its outputs.
.IP "\(bu" 3
\fB\f(CR--expr\fR\fR \fIexpr\fR
.IP
Interpret \fB\fIinstallables\fR\fR as attribute paths relative to the Nix expression \fIexpr\fR.
.IP "\(bu" 3
\fB\f(CR--file\fR\fR / \f(CR-f\fR \fIfile\fR
.IP
Interpret \fB\fIinstallables\fR\fR 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. Implies \f(CR--impure\fR.
.IP "\(bu" 3
\fB\f(CR--no-recursive\fR\fR
.IP
Apply operation to specified paths only.
.RS
.LP
\fBNote\fR
.PP
See \fB\f(CRman nix.conf\fR\fR for overriding configuration settings with command line flags.
.RE