Spawn Command Line Interface

Command Line Interface for spawn

spawn

Command Line Interface

spawn [OPTIONS] COMMAND [ARGS]...

Options

--log-level <log_level>

The log level

Options

error|warning|info|debug

--log-console

Write logs to the console

-d <d>

Definitions to override configuration file parameters (e.g. -d spawn.workers=2)

--config-file <config_file>

Path to the config file.

check-config

Check the configuration. Parses the current configuration and prints to stdout

spawn check-config [OPTIONS]

inspect

Expand and write to console the contents of the SPECFILE

spawn inspect [OPTIONS] SPECFILE

Options

-o, --outfile <outfile>

write inspection output to file rather than to console

-f, --format <format>

format of specification inspection

Options

txt|json

Arguments

SPECFILE

Required argument

run

Runs the SPECFILE contents and write output to OUTDIR

spawn run [OPTIONS] SPECFILE OUTDIR

Options

--type <type>

The type of runs to create. Must have a corresponding plugin.

--local, --remote

Run local or remote. Remote running requires a luigi server to be running

Arguments

SPECFILE

Required argument

OUTDIR

Required argument

stats

Analyse the SPECFILE and print stats to the screen

spawn stats [OPTIONS] SPECFILE

Arguments

SPECFILE

Required argument

work

Adds a worker to a remote scheduler

spawn work [OPTIONS]