# performancebudget-io

> CLI for creating a performance budget

Latest version **0.0.3** (published 2019-09-13) · MIT license · 0 weekly downloads

## Install

```sh
npm install performancebudget-io
pnpm add performancebudget-io
yarn add performancebudget-io
bun add performancebudget-io
```

Provides the command `perfbudget`.

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.3 |
| Published | 2019-09-13 |
| First published | 2019-09-13 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 7 |
| Unpacked size | 12.6 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Jonathan Fielding |
| Maintainers | jonthanfielding |
| Keywords | example |

## Links

- npm: https://www.npmjs.com/package/performancebudget-io
- npm.io page: https://npm.io/package/performancebudget-io

## Dependencies (7)

- [ts-jest](https://npm.io/package/ts-jest.md) ^24.0.2
- [inquirer](https://npm.io/package/inquirer.md) ^7.0.0
- [cli-table](https://npm.io/package/cli-table.md) ^0.3.1
- [commander](https://npm.io/package/commander.md) ^3.0.1
- [typescript](https://npm.io/package/typescript.md) ^3.6.2
- [@types/inquirer](https://npm.io/package/@types/inquirer.md) ^6.5.0
- [@types/cli-table](https://npm.io/package/@types/cli-table.md) ^0.3.0

## Recent versions

- 0.0.3 (latest) — 2019-09-13
- 0.0.2 — 2019-09-13
- 0.0.1 — 2019-09-13

## README

# `perfbudget` cli

A CLI for creating and testing a performance budget.

## Installing

To install use npm to install globally:

```npm i performancebudget-io -g```

## Using `perfbudget`

The simplest way to use `perfbudget` is to run the CLI along with the file you want to run it against. e.g

```perfbudget```

### Additional Options:

`-v`, `--version` -  output the version number

`-c`, `--create` - create a new budget

`-o`, `--output <path>` - specify an output path to export as lighthouse budget (use with --create)

`-h`, `--help` - output usage information

`-d`, `--debug` - output extra debugging

## Contributing

To setup `perfbudget` for development you will need to:

1 - clone https://github.com/jonathan-fielding/perfbudget-cli.git

2 - run `npm i`

3 - run `npm run perfbudget -- <OPTIONS>` to run the development

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