splinter-circuit-template-list

Name

splinter-circuit-template-list — Displays all available circuit templates

Synopsis

splinter circuit template list [FLAGS]

Description

Circuit templates help simplify the process of creating new circuits with the splinter circuit propose command. This command lists all available circuit templates.

A Scabbard circuit template is available by default (this template is packaged with the Splinter CLI).

All available templates are located in the default circuit templates directory, /usr/share/splinter/circuit-templates, unless SPLINTER_CIRCUIT_TEMPLATE_PATH is set. Note, if multiple template storage directories are specified in the SPLINTER_CIRCUIT_TEMPLATE_PATH, they are searched from first to last for template files. The first file matching the specified TEMPLATE-NAME will be displayed.

Tip: Use the splinter circuit template arguments command to see the required arguments for a specific circuit template.

Flags

-h, --help

Prints help information

-q, --quiet

Decrease verbosity (the opposite of -v). When specified, only errors or warnings will be output.

-V, --version

Prints version information

-v

Increases verbosity (the opposite of -q). Specify multiple times for more output.

Options

-F, --format FORMAT

Specifies the output format of the circuit templates. (default human). Possible values for formatting are human and csv. The human option displays the circuit template file information in a formatted table, while csv prints the circuit template file information via comma-separated values.

Environment variables

SPLINTER_CIRCUIT_TEMPLATE_PATH

Paths containing circuit template files. Multiple values may be provided, separated by :, using the format DIR1:DIR2:DIR3. If multiple directories are specified, the directories are searched from first to last for template files.

Examples

The following example lists the circuit templates on a system that has only the scabbard_circuit_template template, which is available by default (packaged with the Splinter CLI) in the circuit template directory, /usr/share/splinter/circuit-templates.

$ splinter circuit template list
TEMPLATE                  PATH
scabbard_circuit_template /usr/share/splinter/circuit-templates/
scabbard_circuit_template.yaml

If the SPLINTER_CIRCUIT_TEMPLATE_PATH is set with multiple directories, all YAML files located in these directories will be displayed, including circuit template files with the same file names.

$ export SPLINTER_CIRCUIT_TEMPLATE_PATH='/foo:/bar'
$ splinter circuit template list
TEMPLATE                  PATH
foo                       /foo/foo.yaml
bar                       /foo/bar.yaml
foo                       /bar/foo.yaml
bar                       /bar/bar.yaml
scabbard_circuit_template /usr/share/splinter/circuit-templates/
scabbard_circuit_template.yaml