9.2.0 • Published 5 months ago

secretlint v9.2.0

Weekly downloads
2,729
License
MIT
Repository
github
Last release
5 months ago

secretlint

Secretlint CLI that scan secret/credential data.

Install

Install with npm:

npm install secretlint

Usage

Usage
  $ secretlint [file|glob*]

Note
  supported glob syntax is based on microglob
  https://github.com/micromatch/micromatch#matching-features

Options
  --init             setup config file. Create .secretlintrc.json file from your package.json
  --format           [String] formatter name. Default: "stylish". Available Formatter: ${getFormatterList()
      .map((item) => item.name)
      .join(", ")}
  --output           [path:String] output file path that is written of reported result.
  --no-color         disable ANSI-color of output.
  --no-terminalLink  disable terminalLink of output.
  --maskSecrets      enable masking of secret values. replace actual secrets with "***".
  --secretlintrc     [path:String] path to .secretlintrc config file. Default: .secretlintrc.*
  --secretlintignore [path:String] path to .secretlintignore file. Default: .secretlintignore

Options for Developer
  --profile          Enable performance profile. 
  --secretlintrcJSON [String] a JSON string of .secretlintrc. use JSON string instead of rc file.

Experimental Options
  --locale            [String] locale tag for translating message. Default: en

Examples
  $ secretlint ./README.md
  # glob pattern should be wrapped with double quote
  $ secretlint "**/*"
  $ secretlint "source/**/*.ini"
  # found secrets and mask the secrets
  $ secretlint .zsh_history --format=mask-result --output=.zsh_history

Exit Status
  Secretlint exits with the following values:

  - 0: 
    - Linting succeeded, no errors found. 
    - Found lint error but --output is specified.
  - 1: 
    - Linting failed, errors found.
  - 2: 
    - Unexpected error occurred, fatal error.

Changelog

See Releases page.

Running tests

Install devDependencies and Run npm test:

npm test

Contributing

Pull requests and stars are always welcome.

For bugs and feature requests, please create an issue.

  1. Fork it!
  2. Create your feature branch: git checkout -b my-new-feature
  3. Commit your changes: git commit -am 'Add some feature'
  4. Push to the branch: git push origin my-new-feature
  5. Submit a pull request :D

Author

License

MIT © azu

9.1.0

5 months ago

9.2.0

5 months ago

8.4.0

10 months ago

8.3.0

10 months ago

8.5.0

10 months ago

8.3.2

10 months ago

8.3.1

10 months ago

8.3.3

10 months ago

9.0.0

10 months ago

8.2.4

1 year ago

8.2.3

1 year ago

8.2.2

1 year ago

8.2.1

1 year ago

8.2.0

1 year ago

8.1.2

1 year ago

8.1.1

2 years ago

8.1.0

2 years ago

7.1.0

2 years ago

7.0.8

2 years ago

7.2.0

2 years ago

8.0.0

2 years ago

7.0.0-beta.66

2 years ago

7.0.0-beta.68

2 years ago

7.0.0-beta.64

2 years ago

7.0.0-beta.65

2 years ago

7.0.7

2 years ago

7.0.6

2 years ago

7.0.5

2 years ago

6.2.4

2 years ago

7.0.0

2 years ago

7.0.4

2 years ago

7.0.3

2 years ago

7.0.2

2 years ago

7.0.1

2 years ago

6.1.0

2 years ago

6.2.1

2 years ago

6.2.0

2 years ago

6.2.3

2 years ago

6.2.2

2 years ago

5.3.0

3 years ago

6.0.1

3 years ago

6.0.2

3 years ago

5.2.4

3 years ago

5.2.3

3 years ago

5.2.2

3 years ago

5.2.1

3 years ago

5.1.3

3 years ago

5.1.2

3 years ago

5.2.0

3 years ago

5.1.1

3 years ago

5.1.0

3 years ago

5.0.1

3 years ago

5.0.0

3 years ago

4.2.0

3 years ago

4.1.4

4 years ago

4.1.3

4 years ago

4.1.1

4 years ago

4.1.0

4 years ago

3.3.1-next.19

4 years ago

4.0.0

4 years ago

3.3.0

4 years ago

3.2.0

4 years ago

3.1.0

4 years ago

2.2.0

4 years ago

3.0.0

4 years ago

2.1.1

5 years ago

2.1.0

5 years ago

2.0.0

5 years ago

1.1.0

5 years ago

1.0.5

5 years ago

1.0.4

5 years ago

1.0.3

5 years ago

1.0.1

5 years ago

1.0.0

5 years ago

0.10.0

5 years ago

0.10.1

5 years ago

0.9.2

5 years ago

0.8.1

5 years ago

0.8.0

5 years ago

0.7.2

5 years ago

0.7.3

5 years ago

0.7.0

5 years ago

0.6.0

5 years ago

0.5.0

5 years ago

0.4.1

5 years ago

0.4.2

5 years ago

0.4.0

5 years ago

0.2.0

5 years ago

0.1.2

5 years ago

0.1.1

5 years ago

0.1.0

5 years ago