Skip to content

CLI

The desflow command and each of its commands, generated from their code, so each page shows the help the installed release prints. Command Line uses every command on the shop. Cheat Sheet shows the commands in use.

Command What it does
desflow run Build the simulation in FILE and run it, or run replications of it.
desflow explain Show the model in SOURCE as a graph, with its utilisation, status, waits and tuning hints where the queueing formulas apply, and why where they do not.
desflow experiment Run the experiment in FILE and write its artifacts and report.
desflow report Build the report of an experiment again from the artifacts in FOLDER.
desflow fit Fit a column of FILE to the distribution families, and exit 1 if none is usable.
desflow dist List the distribution families, or convert parameters to a mean and std and back.
desflow schema Print the blueprint JSON Schema.
desflow examples List the examples, or download one at the version you have installed.
desflow examples list List the examples, with what each shows and what it needs.
desflow examples get Download an example into <dest>/<name>/<api>/, at the installed release. 
 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
Usage: desflow [OPTIONS] COMMAND [ARGS]...

  Run, explain and analyse desflow simulations, fit their inputs, and download
  the examples.

Options:
  --version  Print the installed version and exit.
  --help     Show this message and exit.

Commands:
  run         Build the simulation in FILE and run it, or run replications...
  explain     Show the model in SOURCE as a graph, with its utilisation,...
  experiment  Run the experiment in FILE and write its artifacts and report.
  report      Build the report of an experiment again from the artifacts in...
  fit         Fit a column of FILE to the distribution families, and exit 1...
  dist        List the distribution families, or convert parameters to a...
  schema      Print the blueprint JSON Schema.
  examples    List the examples, or download one at the version you have...

  Examples:

    # Run a blueprint, sending its records to its sinks

    $ desflow run shop.yaml

    # Print the first five events, with no services

    $ desflow run shop.yaml --sample 5

    # Find the bottleneck before running

    $ desflow explain shop.yaml

    # List the examples, then download one

    $ desflow examples list

    $ desflow examples get local