Skip to content

desflow examples get

The help of desflow examples get, generated from the command's code. CLI lists every command, and Command Line uses this one on the shop.

 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
Usage: desflow examples get [OPTIONS] {name}

  Download an example into <dest>/<name>/<api>/, at the installed release.

Arguments:
  name  The example, as `desflow examples` lists it.  [required]

Options:
  --api <str>           Only this version: yaml, builder or low-level.
  --dest <path>         The folder to download into.  [default: .]
  --ref <str>           A git tag or branch. Defaults to the installed release's
                        tag.
  --force / --no-force  Replace files that are already there.  [default: no-
                        force]
  --help                Show this message and exit.

  Examples:

    # Download the three versions of an example into ./local/

    $ desflow examples get local

    # Download only the YAML version into another folder

    $ desflow examples get local --api yaml --dest work

    # Download it from the main branch

    $ desflow examples get local --ref main