Config Reference

Type: object

Config file reference for a_cli_tool.

By default a_cli_tool looks for configuration in ./config.yaml, unless another path is specified with the -c/--config parameter.

Type: string

The name of the thing this CLI tool is building for you.

Type: string

The version of the thing this CLI tool will build for you.

This is a SemVer version, e.g:

version: 1.2.3

Type: string or null

Optional: A description of the thing this CLI tool is building for you.

The configuration for the source of data for this tool.

This can either be set to a local file, or a URL.

Any of

Type: object

Set source to a file path.

file: path/to/file.yaml

Type: string

Type: object

Set source to a URL.

url: https://urlofsource.com/sourcedata/

Type: string

A path to write the created thing to.

Type: array

The operations to perform on the data this tool manipulates.

This array of operations will be performed in order and an operation may appear more than once.

E.g:

actions: [ foo, bar, baz, bar ]

Type: enum (of string)

The possible operations to perform on the data this tool manipulates.

See each option below for what it does and how it's referenced in config.