README.md

codenarc-cli

Conveniently run CodeNarc from the command-line.

Prequisites

• Groovy

Install

1. Download the codenarc-cli zip
2. Unzip codenarc-cli-master.zip

Example

# Display the command-line help
/path/to/unzipped/codenarc-cli/codenarc -help

# Analyze the current directory using the rules configured in `.codenarcrc`
/path/to/unzipped/codenarc-cli/codenarc -basedir=. -rulesetfiles=file:.codenarcrc -report=console

Platforms

Only tested on MacOS

Links

• CodeNarc Command-Line Parameters
• CodeNarc Starter RuleSet