# bundlewatch > Keep watch of your bundle size Latest version **0.4.2** (published 2026-04-21) · MIT license · 0 weekly downloads ## Install ```sh npm install bundlewatch pnpm add bundlewatch yarn add bundlewatch bun add bundlewatch ``` Provides the command `bundlewatch`. ## Health **Score 45/100 (D)** — status: active. Positive: no vulnerabilities. Warnings: low downloads; no types; no esm support; pre 1.0. ## Facts | | | |---|---| | Version | 0.4.2 | | Published | 2026-04-21 | | First published | 2018-05-01 | | Weekly downloads | 0 | | License | MIT | | TypeScript types | none | | Module format | CommonJS | | Node | >=16 | | Dependencies | 10 | | Unpacked size | 44.3 KB | | Known vulnerabilities | 0 (+12 in 1 direct dependencies) | | Install scripts | no | | GitHub stars | 444 | | Author | bundlewatch | | Maintainers | charpeni, jakebolam, iamogbz | | Keywords | library, size, check, build, maxSize | ## Links - npm: https://www.npmjs.com/package/bundlewatch - Repository: https://github.com/bundlewatch/bundlewatch - Homepage: https://github.com/bundlewatch/bundlewatch#readme - Issues: https://github.com/bundlewatch/bundlewatch/issues - npm.io page: https://npm.io/package/bundlewatch ## Dependencies (10) - [glob](https://npm.io/package/glob.md) ^7.1.2 - [axios](https://npm.io/package/axios.md) ^0.31.1 - [bytes](https://npm.io/package/bytes.md) ^3.1.1 - [chalk](https://npm.io/package/chalk.md) ^4.0.0 - [ci-env](https://npm.io/package/ci-env.md) ^1.17.0 - [jsonpack](https://npm.io/package/jsonpack.md) ^1.1.5 - [commander](https://npm.io/package/commander.md) ^5.0.0 - [gzip-size](https://npm.io/package/gzip-size.md) ^6.0.0 - [read-pkg-up](https://npm.io/package/read-pkg-up.md) ^7.0.1 - [lodash.merge](https://npm.io/package/lodash.merge.md) ^4.6.1 ## Alternatives - [raw-loader](https://npm.io/package/raw-loader.md) — 4.3M weekly downloads - [plop](https://npm.io/package/plop.md) — 1.4M weekly downloads - [webpack-deadcode-plugin](https://npm.io/package/webpack-deadcode-plugin.md) — 80.3K weekly downloads - [@storybook/preact-vite](https://npm.io/package/@storybook/preact-vite.md) — 54.2K weekly downloads - [vite-plugin-transform](https://npm.io/package/vite-plugin-transform.md) — 2.4K weekly downloads ## Recent versions - 0.4.2 (latest) — 2026-04-21 - 0.4.1 — 2025-04-08 - 0.4.0 — 2024-07-24 - 0.3.3 — 2022-01-14 - 0.3.2 — 2021-01-26 - 0.3.1 — 2020-09-22 - 0.3.0 — 2020-09-09 - 0.2.7 — 2020-05-07 - 0.2.6 — 2020-03-11 - 0.2.5 — 2019-06-17 - 0.2.4 — 2019-06-16 - 0.2.3 — 2019-06-16 - 0.2.2 — 2019-06-15 - 0.2.1 — 2018-05-07 - 0.2.0 — 2018-05-06 - … 4 more at https://npm.io/package/bundlewatch/versions ## README


Keep watch of your bundle size. [![Version](https://badge.fury.io/js/bundlewatch.svg)](https://www.npmjs.org/package/bundlewatch) [![Monthly Downloads](https://img.shields.io/npm/dm/bundlewatch)](https://www.npmjs.org/package/bundlewatch) [![Coveralls](https://coveralls.io/repos/github/bundlewatch/bundlewatch/badge.svg?branch=master)](https://coveralls.io/github/bundlewatch/bundlewatch?branch=master) [![GitHub License](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/bundlewatch/bundlewatch/blob/master/LICENSE)
BundleWatch checks file sizes, ensuring bundled browser assets don't jump in file size. Sharp increases in BundleWatch can signal that something is wrong, such as adding a package that bloats the slug, an incorrect import, or forgetting to minify. Inspired by [Siddharth Kshetrapal's `bundlesize`][bundlesize] ## Getting Started Install the BundleWatch package: ```sh npm install bundlewatch --save-dev ``` Add some basic configuration to your `package.json` ```json { "name": "my package name", "version": "0.0.1", "bundlewatch": { "files": [ { "path": "myfolder/*.js", "maxSize": "100kB" } ] } } ``` > [!NOTE] > You can also use a `bundlewatch.config.js` file instead of the `package.json` field. See the [documentation][bundlewatch-docs-url] for more details. ### Usage ```sh npm run bundlewatch ``` This will give you command line output. If you want BundleWatch to report build status on your pull requests, see below. ## Adding Build Status BundleWatch can report its status on your GitHub Pull Requests.
build status preview
### CI Auth Variables Needed by BundleWatch - `BUNDLEWATCH_GITHUB_TOKEN` You will need to give BundleWatch access to your GitHub Statuses, which can be done by heading to: [https://service.bundlewatch.io/setup-github][setup-github-url] This will give you your `BUNDLEWATCH_GITHUB_TOKEN`. You will need to set this as an environment variable in CI. ### CI Variables Needed by BundleWatch The most efficient way to get this running is to ensure that some environment variables are available for BundleWatch to find. - `CI_REPO_OWNER` github.com/**facebook**/react - `CI_REPO_NAME` github.com/facebook/**react** - `CI_COMMIT_SHA` - `CI_BRANCH` If you're using, _Travis_, _CircleCI_, _Wrecker_, _Drone_ or _GitHub Actions_ these should all work out of the box. > [!TIP] > Have a look at the source code to see which variables are automatically found: [`getCIVars`][get-ci-vars-source] ### Viewing the results breakdown After setting up the above you will have BuildStatus on your Pull Requests. Clicking the _details_ link on the reported status will show you a results file breakdown.
build results preview
--- ## Additional Documentation Full [documentation available on bundlewatch.io][bundlewatch-docs-url] ### I use bundlesize, why should I switch to BundleWatch - Bundlesize has entered maintenance mode and pull requests are left hanging, so we wanted to reboot the community through creating BundleWatch - New [BundleWatch service][bundlewatch-service] with infrastructure as code - Launched [bundlewatch.io documentation website][bundlewatch-docs-url] - Enough test coverage to support CD - Node API Support - Lower barrier to contributing (automated testing and publishing), build a trusted community of contributors to have continuous improvement ### Additional Features - [x] Config validation to stop users from guessing why BundleWatch won't work - [x] Support for config file path - [x] Better results breakdown page - [x] Better comparisons between branches, support branches other than master - [x] Support for your own server for storing data - [x] New and improved CI behaviour - [ ] Show history of BundleWatchs over time ### Contributors ### Want to Help? Become a Contributor Contributions of any kind are welcome! [See the Contributing docs][contrib-docs-url]. [bundlesize]: https://github.com/siddharthkp/bundlesize [bundlewatch-docs-url]: https://bundlewatch.io/ [bundlewatch-service]: https://github.com/bundlewatch/service [contrib-docs-url]: https://github.com/bundlewatch/bundlewatch/blob/master/CONTRIBUTING.md [get-ci-vars-source]: https://github.com/bundlewatch/bundlewatch/blob/master/src/app/config/getCIVars.js [setup-github-url]: https://service.bundlewatch.io/setup-github --- _Source: https://npm.io/package/bundlewatch · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._