CLI documentation

The following section is auto-generated from the CLI parameters in the code.

netlint

Perform static analysis on network device configuration files.

netlint [OPTIONS] COMMAND [ARGS]...

Options

-i, --input <input_path>

--glob <glob>

Glob pattern to match files in the path with.

Default

*.conf

--prefix <prefix>

Prefix for configuration lines output to the CLI.

Default

->

-o, --output <output>

Optional output file.

--exit-zero

Exit code 0 even if errors are found.

--format <format_>

The format of the output data.

Options

json | normal | csv

--select <select>

Comma-separated list of check names to include (mutually exclusive with –exclude).

--exclude <exclude>

Comma-separated list of check names to exclude (mutually exclusive with –select).

--exclude-tags <exclude_tags>

Comma-separated list of check tags to exclude.

-q, --quiet

Don’t output non-errors.

-p, --plain

Plain output.

--color, --no-color

Show colored output.

-c, --config <config>

Path to TOML configuration file.

Default

pyproject.toml

-V, --version

Show the version and exit.

Environment variables

NO_COLOR

Provide a default for --color

get

Get live configuration off of devices.

netlint get [OPTIONS] HOSTNAME

Options

-d, --driver <driver_name>

Name of the NAPALM driver to connect with.

-u, --username <username>

-p, --password <password>

Arguments

HOSTNAME

Required argument