aboutsummaryrefslogtreecommitdiff
path: root/src/nix/ping-store.md
blob: 1296ef685b117d5a699130f196b4a449a7baac76 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
R""(

# Examples

* Test whether connecting to a remote Nix store via SSH works:

  ```console
  # nix store ping --store ssh://mac1
  ```

* Test whether a URL is a valid binary cache:

  ```console
  # nix store ping --store https://cache.nixos.org
  ```

* Test whether the Nix daemon is up and running:

  ```console
  # nix store ping --store daemon
  ```

# Description

This command tests whether a particular Nix store (specified by the
argument `--store` *url*) can be accessed. What this means is
dependent on the type of the store. For instance, for an SSH store it
means that Lix can connect to the specified machine.

If the command succeeds, Lix returns a exit code of 0 and does not
print any output.

)""