# audit-badge

> Generates an npm audit badge

Latest version **1.0.0** (published 2018-07-02) · MIT license · 0 weekly downloads

## Install

```sh
npm install audit-badge
pnpm add audit-badge
yarn add audit-badge
bun add audit-badge
```

Provides the command `audit-badge`.

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.0 |
| Published | 2018-07-02 |
| First published | 2018-07-02 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 3 |
| Unpacked size | 15.3 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Sebastian Golasch |
| Maintainers | asciidisco |
| Keywords | audit, badge |

## Links

- npm: https://www.npmjs.com/package/audit-badge
- Repository: https://github.com/asciidisco/audit-badge
- Homepage: https://github.com/asciidisco/audit-badge#readme
- Issues: https://github.com/asciidisco/audit-badge/issues
- npm.io page: https://npm.io/package/audit-badge

## Dependencies (3)

- [badge-up](https://npm.io/package/badge-up.md) 2.3.0
- [commander](https://npm.io/package/commander.md) 2.16.0
- [npm-auditor](https://npm.io/package/npm-auditor.md) 1.1.1

## Recent versions

- 1.0.0 (latest) — 2018-07-02

## README

# audit-badge

Generates a badge with the number of vulnarable packages in your `package.json`

## Installing

For local usage:

```bash
npm i audit-badge --save-dev
```

For global usage:

```bash
npm i audit-badge -g
```

One time remote execution:

```bash
npx audit-badge
```

## Usage

```bash
$ audit-badge -h

  Usage: audit-badge [options]

  Options:

    -v, --version            output the version number
    -c, --config <location>  Set path for package.json to be introspected, uses cwd as default
    -p, --production         Scan for production vulnarabilities only
    -q, --quiet              No reporting output
    -o, --output <file>      Pathname of the output file, will write to stdout if not given
    -h, --help               output usage information
```

## Running the tests

You can run the test with:

```bash
npm test
```

### And coding style tests

This project adheres to the rules of [StandardJS](https://standardjs.com/)

```bash
npm run lint
```

## Built With

* [Dropwizard](http://www.dropwizard.io/1.0.2/docs/) - The web framework used
* [Maven](https://maven.apache.org/) - Dependency Management
* [ROME](https://rometools.github.io/rome/) - Used to generate RSS Feeds

## Contributing

Please read [CONTRIBUTING.md](CONTRIBUTING.md) for details on the process for submitting pull requests to us and [code-of-conduct.md](code-of.conduct.md) for details on our code of conduct when contributing.

## Versioning

We use [SemVer](http://semver.org/) for versioning. For the versions available, see the [tags on this repository](https://github.com/asciidisco/audit-badge/tags).

## Authors

* **Sebastian Golasch** - *Initial work* - [asciidisco](https://github.com/asciidisco)

See also the list of [contributors](https://github.com/asciidisco/audit-badge/contributors) who participated in this project.

## License

This project is licensed under the MIT License - see the [LICENSE.md](LICENSE) file for details

---
_Source: https://npm.io/package/audit-badge · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._