snapdir-cli 1.9.0

snapdir CLI implementation: the library behind the `snapdir` binary (which ships in the `snapdir` crate).
Documentation 
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
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108

```
$ snapdir pull --help
Fetch a snapshot from a store and check it out to the given path

Usage: snapdir pull [OPTIONS] [PATH]

Arguments:
  [PATH]
          Destination directory

Options:
  -q, --quiet
          Suppress stderr banners and the live progress line

      --store <URI>
          Store URI: `protocol://location/path`
          
          [env: SNAPDIR_STORE=]

      --catalog <NAME>
          Catalog adapter to record this snapshot's location in
          
          [env: SNAPDIR_CATALOG=]

      --color <WHEN>
          When to colorize progress output: auto, always, or never

          Possible values:
          - auto:   Color when attached to a TTY and `NO_COLOR` is unset (default)
          - always: Always emit color
          - never:  Never emit color
          
          [default: auto]

      --no-progress
          Disable the live progress line (transfers still run)
          
          [env: SNAPDIR_NO_PROGRESS=]

      --objects-store <URI>
          Shared object-pool store URI: when set, content OBJECTS route to this pool's `.objects/` while MANIFESTS route to `--store`'s `.manifests/`
          
          [env: SNAPDIR_OBJECTS_STORE=]

      --cache-dir <DIR>
          Directory where the object cache is stored
          
          [env: SNAPDIR_CACHE_DIR=]

      --verbose
          Enable verbose output. Honored by the transfer commands (push/fetch/pull/checkout/stage/sync emit an effective-config banner and CACHED/SAVED notices) and verify-cache (purge notices); inert elsewhere

      --id <ID>
          Snapshot ID to operate on

  -j, --jobs <N>
          Max concurrent object transfers (0/auto = number of CPUs, capped)
          
          [env: SNAPDIR_JOBS=]

      --limit-rate <RATE>
          Limit total transfer bandwidth, e.g. 10M, 512K, 1G (wget-style; aggregate across all transfers)
          
          [env: SNAPDIR_LIMIT_RATE=]

      --adaptive[=<FRACTION>]
          Adaptively tune transfer concurrency/bandwidth toward a fraction (default 0.8) of measured CPU/network capacity; backs off under contention. Opt-in; default is full speed.
          
          Presence (with or without a value) opts in; the optional value is the politeness fraction in `(0.0, 1.0]`.
          
          [env: SNAPDIR_ADAPTIVE=]

      --max-jobs <N>
          Adaptive concurrency ceiling (only meaningful with `--adaptive`). When unset, defaults to the auto concurrency; clamped to a sane upper bound
          
          [env: SNAPDIR_MAX_JOBS=]

      --max-retries <N>
          Total retry attempts per network request, including the first (default 5)

      --retry-base-ms <MS>
          Base backoff delay in milliseconds for request retries (default 250)

      --retry-max-ms <MS>
          Maximum backoff delay in milliseconds for request retries (default 30000)

      --max-requests <N>
          Cap request rate (req/s); 0/unset uses the per-backend default

      --linked
          Use symlinks instead of copies

      --force
          Force an action to run

      --keep
          Keep the staging directory

      --dryrun
          Run without making any changes

  -h, --help
          Print help (see a summary with '-h')

  -V, --version
          Print version

```