@intuit/standardly NPM

Introduction

Prerequisites For Installing

node 10.16.0
npm
git

How To Use

Download/clone this repository, to clone:

git clone https://github.com/intuit/standardly.git

Change your working directory so that you are inside the Standardly repository:

cd standardly

Before you can run the tool first install the dependencies it needs:

npm install

Now Standardly is equipped to start scanning your resource!

standardly --localdir <directory_location> --rulesfile <fullpath_of_rules_file>

standardly -l <directory_location> -r <fullpath_of_rules_file>

or if running in a bash shell, simply run

./standardly -l <directory_location> -r <fullpath_of_rules_file>

To scan a github repo, run:

standardly --giturl <url_of_gitrepo_to_scan> --rulesfile <fullpath_of_rules_file>

standardly -g <url_of_gitrepo_to_scan> -r <fullpath_of_rules_file>

The output is created as a results.csv file in a folder named 'reports' under the current directory. If you would like to change the location of the results.csv file pass a --outputdir (or simply -o) parameter to output where you want the results.csv file to be. Below is an example of explicitly specifying the outputdir.

standardly -g https://github.com/argoproj/argo -r /Users/standardlyRocks/Desktop/standardly/sample/rules.json -o /Users/standardlyRocks/Desktop/reports

When this command is executed, a results.csv file will be created in the /Users/standardlyRocks/Desktop/reports directory