.\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.49.3.
.TH PUPPET-LINT "1" "February 2024" "puppet-lint 4.2.4" "User Commands"
.SH NAME
puppet-lint \- Puppet Lint
.SH DESCRIPTION
.IP
puppet\-lint
.IP
Basic Command Line Usage:
.IP
puppet\-lint [OPTIONS] PATH
.TP
PATH
The path to the Puppet manifest.
.IP
Option:
.TP
\fB\-\-version\fR
Display the current version.
.TP
\fB\-\-no\-config\fR
Do not load default puppet\-lint option files.
.TP
\fB\-c\fR, \fB\-\-config\fR FILE
Load puppet\-lint options from file.
.TP
\fB\-\-with\-context\fR
Show where in the manifest the problem is.
.TP
\fB\-\-with\-filename\fR
Display the filename before the warning.
.TP
\fB\-\-fail\-on\-warnings\fR
Return a non\-zero exit status for warnings
.TP
\fB\-\-error\-level\fR LEVEL
The level of error to return (warning, error or all).
.TP
\fB\-\-show\-ignored\fR
Show problems that have been ignored by control comments
.TP
\fB\-\-relative\fR
Compare module layout relative to the module root
.TP
\fB\-l\fR, \fB\-\-load\fR FILE
Load a file containing custom puppet\-lint checks.
.TP
\fB\-\-load\-from\-puppet\fR MODULEPATH
Load plugins from the given Puppet module path.
.TP
\fB\-f\fR, \fB\-\-fix\fR
Attempt to automatically fix errors
.TP
\fB\-\-log\-format\fR FORMAT
Change the log format.
Overrides \fB\-\-with\-filename\fR.
The following placeholders can be used:
%{filename} \- Filename without path.
%{path}     \- Path as provided to puppet\-lint.
%{fullpath} \- Expanded path to the file.
%{line}     \- Line number.
%{column}   \- Column number.
%{kind}     \- The kind of message (warning, error).
%{KIND}     \- Uppercase version of %{kind}.
%{check}    \- The name of the check.
%{message}  \- The message.
.TP
\fB\-\-json\fR
Log output as JSON
.TP
\fB\-\-sarif\fR
Log output as SARIF
.TP
\fB\-\-codeclimate\-report\-file\fR FILE
Save a code climate compatible report to this file
.TP
\fB\-\-list\-checks\fR
List available check names.
.IP
Checks:
.TP
\fB\-\-only\-checks\fR CHECKS
A comma separated list of checks that should be run
.TP
\fB\-\-ignore\-paths\fR PATHS
A comma separated list of patterns to ignore
.TP
\fB\-\-no\-arrow_on_right_operand_line\-check\fR
Skip the arrow_on_right_operand_line check.
.HP
\fB\-\-no\-autoloader_layout\-check\fR Skip the autoloader_layout check.
.TP
\fB\-\-no\-class_inherits_from_params_class\-check\fR
Skip the class_inherits_from_params_class check.
.TP
\fB\-\-class_inherits_from_params_class\-check\fR
Enable the class_inherits_from_params_class check.
.HP
\fB\-\-no\-code_on_top_scope\-check\fR Skip the code_on_top_scope check.
.TP
\fB\-\-code_on_top_scope\-check\fR
Enable the code_on_top_scope check.
.TP
\fB\-\-no\-inherits_across_namespaces\-check\fR
Skip the inherits_across_namespaces check.
.TP
\fB\-\-no\-names_containing_dash\-check\fR
Skip the names_containing_dash check.
.TP
\fB\-\-no\-names_containing_uppercase\-check\fR
Skip the names_containing_uppercase check.
.TP
\fB\-\-no\-nested_classes_or_defines\-check\fR
Skip the nested_classes_or_defines check.
.TP
\fB\-\-no\-parameter_order\-check\fR
Skip the parameter_order check.
.TP
\fB\-\-no\-right_to_left_relationship\-check\fR
Skip the right_to_left_relationship check.
.TP
\fB\-\-no\-variable_scope\-check\fR
Skip the variable_scope check.
.TP
\fB\-\-no\-slash_comments\-check\fR
Skip the slash_comments check.
.TP
\fB\-\-no\-star_comments\-check\fR
Skip the star_comments check.
.TP
\fB\-\-no\-case_without_default\-check\fR
Skip the case_without_default check.
.TP
\fB\-\-no\-selector_inside_resource\-check\fR
Skip the selector_inside_resource check.
.TP
\fB\-\-no\-documentation\-check\fR
Skip the documentation check.
.TP
\fB\-\-no\-unquoted_node_name\-check\fR
Skip the unquoted_node_name check.
.TP
\fB\-\-no\-duplicate_params\-check\fR
Skip the duplicate_params check.
.TP
\fB\-\-no\-ensure_first_param\-check\fR
Skip the ensure_first_param check.
.TP
\fB\-\-no\-ensure_not_symlink_target\-check\fR
Skip the ensure_not_symlink_target check.
.TP
\fB\-\-no\-file_mode\-check\fR
Skip the file_mode check.
.TP
\fB\-\-no\-unquoted_file_mode\-check\fR
Skip the unquoted_file_mode check.
.TP
\fB\-\-no\-unquoted_resource_title\-check\fR
Skip the unquoted_resource_title check.
.TP
\fB\-\-no\-double_quoted_strings\-check\fR
Skip the double_quoted_strings check.
.TP
\fB\-\-no\-only_variable_string\-check\fR
Skip the only_variable_string check.
.TP
\fB\-\-no\-puppet_url_without_modules\-check\fR
Skip the puppet_url_without_modules check.
.TP
\fB\-\-no\-quoted_booleans\-check\fR
Skip the quoted_booleans check.
.TP
\fB\-\-quoted_booleans\-check\fR
Enable the quoted_booleans check.
.TP
\fB\-\-no\-single_quote_string_with_variables\-check\fR
Skip the single_quote_string_with_variables check.
.TP
\fB\-\-no\-variables_not_enclosed\-check\fR
Skip the variables_not_enclosed check.
.TP
\fB\-\-no\-variable_contains_dash\-check\fR
Skip the variable_contains_dash check.
.TP
\fB\-\-no\-variable_is_lowercase\-check\fR
Skip the variable_is_lowercase check.
.TP
\fB\-\-no\-140chars\-check\fR
Skip the 140chars check.
.TP
\fB\-\-no\-2sp_soft_tabs\-check\fR
Skip the 2sp_soft_tabs check.
.TP
\fB\-\-no\-80chars\-check\fR
Skip the 80chars check.
.TP
\fB\-\-80chars\-check\fR
Enable the 80chars check.
.TP
\fB\-\-no\-arrow_alignment\-check\fR
Skip the arrow_alignment check.
.TP
\fB\-\-no\-hard_tabs\-check\fR
Skip the hard_tabs check.
.TP
\fB\-\-no\-trailing_whitespace\-check\fR
Skip the trailing_whitespace check.
.TP
\fB\-\-no\-legacy_facts\-check\fR
Skip the legacy_facts check.
.TP
\fB\-\-no\-top_scope_facts\-check\fR
Skip the top_scope_facts check.