Skip to content

AndreiPiatrou/code-guardian

Repository files navigation

CircleCI

code-guardian

Simple cli tool to check a code against different kinds of issues

Currently supported checks

  • sensitive data: keys, secrets, passwords
  • private key and certificate files

How to install

npm i -g code-guardian

How to start

cd your-repo
code-guardian

# for more details
code-guardian --help

Options:
  --help              Show help                                        [boolean]
  --version           Show version number                              [boolean]
  --path, -p          Repo path to check                         [default: "./"]
  --excludes, -e      File path to excludes file
                      [default: "/home/user/code-guardian/.fileignore"]
  --entropyThreshold                                                [default: 2]
  --checkers          Specify checkers to be used
                      [array] [choices: "private.keys", "secret"]  [default: []]

Practices and tools applied

  • CircleCI: test for all branches, deploy only for master
  • ESLint: injected as a build step
  • mocha: npm t is a part of CI build step
  • semantic-versioning

About

Simple cli tool to check a code against different kinds of issues

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Contributors 4

  •  
  •  
  •  
  •