max/nix-super
1
0
Fork 0
mirror of https://github.com/privatevoid-net/nix-super.git synced 2024-11-15 10:46:15 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions
nix-super/doc/manual/src/command-ref/nix-copy-closure.md

103 lines
3.5 KiB
Markdown
Raw Normal View History

Markdown test
2020-07-22 14:51:11 +03:00
# Name
`nix-copy-closure` - copy a closure to or from a remote machine via SSH
# Synopsis
Clean up the manpages
2020-07-24 13:56:19 +03:00
`nix-copy-closure`
[`--to` | `--from`]
[`--gzip`]
[`--include-outputs`]
[`--use-substitutes` | `-s`]
[`-v`]
_user@machine_ _paths_
Markdown test
2020-07-22 14:51:11 +03:00
# Description
`nix-copy-closure` gives you an easy and efficient way to exchange
software between machines. Given one or more Nix store _paths_ on the
local machine, `nix-copy-closure` computes the closure of those paths
(i.e. all their dependencies in the Nix store), and copies all paths
in the closure to the remote machine via the `ssh` (Secure Shell)
command. With the `--from` option, the direction is reversed: the
closure of _paths_ on a remote machine is copied to the Nix store on
the local machine.
This command is efficient because it only sends the store paths
that are missing on the target machine.
Since `nix-copy-closure` calls `ssh`, you may be asked to type in the
appropriate password or passphrase. In fact, you may be asked _twice_
because `nix-copy-closure` currently connects twice to the remote
machine, first to get the set of paths missing on the target machine,
nix-copy-closure: improve wording
2022-09-28 02:03:46 +03:00
and second to send the dump of those paths. When using public key
authentication, you can avoid typing the passphrase with `ssh-agent`.
Markdown test
2020-07-22 14:51:11 +03:00
# Options
Replace the trailing markdown spaces by a backslash They are equivalent according to <https://spec.commonmark.org/0.29/#hard-line-breaks>, and the trailing spaces tend to be a pain (because the make git complain, editors tend to want to remove them − the `.editorconfig` actually specifies that − etc..).
2021-04-23 15:30:42 +03:00
- `--to`\
Fix nix-copy-closure manpage
2020-07-24 14:01:00 +03:00
Copy the closure of _paths_ from the local Nix store to the Nix
store on _machine_. This is the default.
Markdown test
2020-07-22 14:51:11 +03:00
Replace the trailing markdown spaces by a backslash They are equivalent according to <https://spec.commonmark.org/0.29/#hard-line-breaks>, and the trailing spaces tend to be a pain (because the make git complain, editors tend to want to remove them − the `.editorconfig` actually specifies that − etc..).
2021-04-23 15:30:42 +03:00
- `--from`\
Fix nix-copy-closure manpage
2020-07-24 14:01:00 +03:00
Copy the closure of _paths_ from the Nix store on _machine_ to the
local Nix store.
Markdown test
2020-07-22 14:51:11 +03:00
Replace the trailing markdown spaces by a backslash They are equivalent according to <https://spec.commonmark.org/0.29/#hard-line-breaks>, and the trailing spaces tend to be a pain (because the make git complain, editors tend to want to remove them − the `.editorconfig` actually specifies that − etc..).
2021-04-23 15:30:42 +03:00
- `--gzip`\
Fix nix-copy-closure manpage
2020-07-24 14:01:00 +03:00
Enable compression of the SSH connection.
Markdown test
2020-07-22 14:51:11 +03:00
Replace the trailing markdown spaces by a backslash They are equivalent according to <https://spec.commonmark.org/0.29/#hard-line-breaks>, and the trailing spaces tend to be a pain (because the make git complain, editors tend to want to remove them − the `.editorconfig` actually specifies that − etc..).
2021-04-23 15:30:42 +03:00
- `--include-outputs`\
link "store derivation" to glossary definition
2022-12-20 16:37:40 +02:00
Also copy the outputs of [store derivation]s included in the closure.
docs: Refer to the glossary with `@docroot@` instead of `..` These unweildy relative paths probably predate the `@docroot@` mechanism.
2024-04-12 18:06:47 +03:00
[store derivation]: @docroot@/glossary.md#gloss-store-derivation
Markdown test
2020-07-22 14:51:11 +03:00
Replace the trailing markdown spaces by a backslash They are equivalent according to <https://spec.commonmark.org/0.29/#hard-line-breaks>, and the trailing spaces tend to be a pain (because the make git complain, editors tend to want to remove them − the `.editorconfig` actually specifies that − etc..).
2021-04-23 15:30:42 +03:00
- `--use-substitutes` / `-s`\
Fix nix-copy-closure manpage
2020-07-24 14:01:00 +03:00
Attempt to download missing paths on the target machine using Nix’s
substitute mechanism. Any paths that cannot be substituted on the
target are still copied normally from the source. This is useful,
for instance, if the connection between the source and target
machine is slow, but the connection between the target machine and
`nixos.org` (the default binary cache server) is
fast.
Markdown test
2020-07-22 14:51:11 +03:00
Replace the trailing markdown spaces by a backslash They are equivalent according to <https://spec.commonmark.org/0.29/#hard-line-breaks>, and the trailing spaces tend to be a pain (because the make git complain, editors tend to want to remove them − the `.editorconfig` actually specifies that − etc..).
2021-04-23 15:30:42 +03:00
- `-v`\
Fix nix-copy-closure manpage
2020-07-24 14:01:00 +03:00
Show verbose output.
Markdown test
2020-07-22 14:51:11 +03:00
Split nix-env and nix-store documentation per-subcommand Documentation on "classic" commands with many sub-commands are notoriously hard to discover due to lack of overview and anchor links. Additionally the information on common options and environment variables is not accessible offline in man pages, and therefore often overlooked by readers. With this change, each sub-command of nix-store and nix-env gets its own page in the manual (listed in the table of contents), and each own man page. Also, man pages for each subcommand now (again) list common options and environment variables. While this makes each page quite long and some common parameters don't apply, this should still make it easier to navigate as that additional information was not accessible on the command line at all. It is now possible to run 'nix-store --<subcommand> --help` to display help pages for the given subcommand. Co-authored-by: Valentin Gagarin <valentin.gagarin@tweag.io>
2023-03-23 17:27:41 +02:00
{{#include ./opt-common.md}}
Markdown test
2020-07-22 14:51:11 +03:00
# Environment variables
Replace the trailing markdown spaces by a backslash They are equivalent according to <https://spec.commonmark.org/0.29/#hard-line-breaks>, and the trailing spaces tend to be a pain (because the make git complain, editors tend to want to remove them − the `.editorconfig` actually specifies that − etc..).
2021-04-23 15:30:42 +03:00
- `NIX_SSHOPTS`\
Fix nix-copy-closure manpage
2020-07-24 14:01:00 +03:00
Additional options to be passed to `ssh` on the command
line.
Markdown test
2020-07-22 14:51:11 +03:00
Split nix-env and nix-store documentation per-subcommand Documentation on "classic" commands with many sub-commands are notoriously hard to discover due to lack of overview and anchor links. Additionally the information on common options and environment variables is not accessible offline in man pages, and therefore often overlooked by readers. With this change, each sub-command of nix-store and nix-env gets its own page in the manual (listed in the table of contents), and each own man page. Also, man pages for each subcommand now (again) list common options and environment variables. While this makes each page quite long and some common parameters don't apply, this should still make it easier to navigate as that additional information was not accessible on the command line at all. It is now possible to run 'nix-store --<subcommand> --help` to display help pages for the given subcommand. Co-authored-by: Valentin Gagarin <valentin.gagarin@tweag.io>
2023-03-23 17:27:41 +02:00
{{#include ./env-common.md}}
Markdown test
2020-07-22 14:51:11 +03:00
# Examples
expand example on `nix-copy-closure` (#10708) * expand example on nix-copy-closure Co-authored-by: Robert Hensing <roberth@users.noreply.github.com>
2024-05-20 23:45:45 +03:00
> **Example**
>
> Copy GNU Hello with all its dependencies to a remote machine:
>
> ```shell-session
> $ storePath="$(nix-build '<nixpkgs>' -I nixpkgs=channel:nixpkgs-unstable -A hello --no-out-link)"
> $ nix-copy-closure --to alice@itchy.example.org "$storePath"
> copying 5 paths...
> copying path '/nix/store/nrwkk6ak3rgkrxbqhsscb01jpzmslf2r-xgcc-13.2.0-libgcc' to 'ssh://alice@itchy.example.org'...
> copying path '/nix/store/gm61h1y42pqyl6178g90x8zm22n6pyy5-libunistring-1.1' to 'ssh://alice@itchy.example.org'...
> copying path '/nix/store/ddfzjdykw67s20c35i7a6624by3iz5jv-libidn2-2.3.7' to 'ssh://alice@itchy.example.org'...
> copying path '/nix/store/apab5i73dqa09wx0q27b6fbhd1r18ihl-glibc-2.39-31' to 'ssh://alice@itchy.example.org'...
> copying path '/nix/store/g1n2vryg06amvcc1avb2mcq36faly0mh-hello-2.12.1' to 'ssh://alice@itchy.example.org'...
> ```
> **Example**
>
> Copy GNU Hello from a remote machine using a known store path, and run it:
>
> ```shell-session
> $ storePath="$(nix-instantiate --eval '<nixpkgs>' -I nixpkgs=channel:nixpkgs-unstable -A hello.outPath | tr -d '"')"
> $ nix-copy-closure --from alice@itchy.example.org "$storePath"
> $ "$storePath"/bin/hello
> Hello, world!
> ```
Reference in a new issue Copy permalink