Command-Line Help for neomake

This document contains the help content for the neomake command-line program.

Command Overview:

• neomake↴
• neomake man↴
• neomake autocomplete↴
• neomake workflow↴
• neomake workflow init↴
• neomake workflow schema↴
• neomake plan↴
• neomake execute↴
• neomake describe↴
• neomake list↴

neomake

A makefile alternative / task runner.

Usage: neomake [OPTIONS] <COMMAND>

Subcommands:

• man — Renders the manual.
• autocomplete — Renders shell completion scripts.
• workflow — Workflow related subcommands.
• plan — Creates an execution plan.
• execute — Executes an execution plan.
• describe — Describes which nodes are executed in which stages.
• list — Lists all available nodes.

Options:

• -e, --experimental <EXPERIMENTAL> — Enables experimental features.

neomake man

Renders the manual.

Usage: neomake man --out <out> --format <format>

Options:

• -o, --out <OUT>

• -f, --format <FORMAT>

  Possible values: manpages, markdown

neomake autocomplete

Renders shell completion scripts.

Usage: neomake autocomplete --out <out> --shell <shell>

Options:

• -o, --out <OUT>

• -s, --shell <SHELL>

  Possible values: bash, zsh, fish, elvish, powershell

neomake workflow

Workflow related subcommands.

Usage: neomake workflow [COMMAND]

Subcommands:

• init — Initializes a new template workflow.
• schema — Renders the workflow schema to STDOUT.

neomake workflow init

Initializes a new template workflow.

Usage: neomake workflow init [OPTIONS]

Options:

• -t, --template <TEMPLATE> — The template to init with.

  Default value: min

  Possible values: min, max, python

• -o, --output <OUTPUT> — The file to render the output to. "-" renders to STDOUT.

  Default value: ./.neomake.yaml

neomake workflow schema

Renders the workflow schema to STDOUT.

Usage: neomake workflow schema

neomake plan

Creates an execution plan.

Usage: neomake plan [OPTIONS]

Options:

• --workflow <WORKFLOW> — The workflow file to use.

  Default value: ./.neomake.yaml

• -n, --node <NODE> — Adding a node to the plan.

• -r, --regex <REGEX> — Adding a node to the plan.

• -a, --arg <ARG> — Specifies a value for handlebars placeholders.

• -o, --output <OUTPUT> — Specifies the output format.

  Default value: yaml

  Possible values: yaml

neomake execute

Executes an execution plan.

Usage: neomake execute [OPTIONS]

Options:

• -f, --format <FORMAT> — The format of the execution plan.

  Default value: yaml

  Possible values: yaml

• -w, --workers <WORKERS> — Defines how many worker threads are created in the OS thread pool.

  Default value: 1

• --no-stdout <NO-STDOUT> — Disables any output to STDOUT. Useful for preventing leakage of secrets and keeping the logs clean.

• --no-stderr <NO-STDERR> — Disables any output to STDERR. Useful for preventing leakage of secrets and keeping the logs clean.

neomake describe

Describes which nodes are executed in which stages.

Usage: neomake describe [OPTIONS]

Options:

• --workflow <WORKFLOW> — The workflow file to use.

  Default value: ./.neomake.yaml

• -n, --node <NODE> — Adding a node.

• -r, --regex <REGEX> — Adding a node to the plan.

• -o, --output <OUTPUT> — The output format.

  Default value: yaml

  Possible values: yaml

neomake list

Lists all available nodes.

Usage: neomake list [OPTIONS]

Options:

• --workflow <WORKFLOW> — The workflow file to use.

  Default value: ./.neomake.yaml

• -o, --output <OUTPUT> — The output format.

  Default value: yaml

  Possible values: yaml

This document was generated automatically by clap-markdown.