# @ckeditor/ckeditor5-package-tools

> Development environment tools for the CKEditor 5 packages.

Latest version **5.1.0** (published 2026-03-13) · MIT license · 0 weekly downloads

## Install

```sh
npm install @ckeditor/ckeditor5-package-tools
pnpm add @ckeditor/ckeditor5-package-tools
yarn add @ckeditor/ckeditor5-package-tools
bun add @ckeditor/ckeditor5-package-tools
```

Provides the command `ckeditor5-package-tools`.

## Health

**Score 55/100 (C)** — status: stable.

Positive: esm support; no vulnerabilities; high maintenance score.

Warnings: low downloads; no types.

## Facts

| | |
|---|---|
| Version | 5.1.0 |
| Published | 2026-03-13 |
| First published | 2021-08-31 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | ESM + CommonJS |
| Node | >=24.11.0 |
| Dependencies | 20 |
| Unpacked size | 20.2 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 7 |
| Author | CKSource |
| Maintainers | ckeditor |

## Links

- npm: https://www.npmjs.com/package/@ckeditor/ckeditor5-package-tools
- Repository: https://github.com/ckeditor/ckeditor5-package-generator
- Homepage: https://ckeditor.com/ckeditor-5
- Issues: https://github.com/ckeditor/ckeditor5-package-generator/issues
- npm.io page: https://npm.io/package/@ckeditor/ckeditor5-package-tools

## Dependencies (20)

- [glob](https://npm.io/package/glob.md) ^13.0.0
- [chalk](https://npm.io/package/chalk.md) ^5.0.0
- [upath](https://npm.io/package/upath.md) ^2.0.1
- [buffer](https://npm.io/package/buffer.md) ^6.0.3
- [postcss](https://npm.io/package/postcss.md) ^8.4.12
- [process](https://npm.io/package/process.md) ^0.11.10
- [ts-node](https://npm.io/package/ts-node.md) ^10.9.1
- [webpack](https://npm.io/package/webpack.md) ^5.94.0
- [fs-extra](https://npm.io/package/fs-extra.md) ^11.2.0
- [minimist](https://npm.io/package/minimist.md) ^1.2.5
- [ts-loader](https://npm.io/package/ts-loader.md) ^9.4.2
- [css-loader](https://npm.io/package/css-loader.md) ^5.2.7
- [raw-loader](https://npm.io/package/raw-loader.md) ^4.0.2
- [typescript](https://npm.io/package/typescript.md) 5.0.4
- [style-loader](https://npm.io/package/style-loader.md) ^2.0.0
- [postcss-loader](https://npm.io/package/postcss-loader.md) ^4.3.0
- [webpack-dev-server](https://npm.io/package/webpack-dev-server.md) ^5.0.4
- [terser-webpack-plugin](https://npm.io/package/terser-webpack-plugin.md) ^5.3.7
- [@ckeditor/ckeditor5-dev-utils](https://npm.io/package/@ckeditor/ckeditor5-dev-utils.md) ^54.2.0
- [@ckeditor/ckeditor5-dev-translations](https://npm.io/package/@ckeditor/ckeditor5-dev-translations.md) ^54.2.0

## Recent versions

- 5.1.0 (latest) — 2026-03-13
- 3.0.0-alpha.0 (alpha) — 2024-09-19
- 1.0.0-beta.10 (beta) — 2023-03-28
- 5.0.1 — 2025-11-14
- 5.0.0 — 2025-11-13
- 4.1.1 — 2025-10-14
- 4.1.0 — 2025-09-16
- 4.0.2 — 2025-07-23
- 4.0.1 — 2025-06-26
- 4.0.0 — 2025-06-04
- 3.0.1 — 2025-01-07
- 3.0.0 — 2024-11-04
- 2.1.1 — 2024-09-30
- 2.1.0 — 2024-08-07
- 2.0.0 — 2024-06-26
- … 14 more at https://npm.io/package/@ckeditor/ckeditor5-package-tools/versions

## README

# CKEditor 5 Package Tools

[![npm version](https://badge.fury.io/js/@ckeditor%2Fckeditor5-package-tools.svg)](https://badge.fury.io/js/@ckeditor%2Fckeditor5-package-tools)

This package implements the scripts and utils used by [`ckeditor5-package-generator`](https://www.npmjs.com/package/ckeditor5-package-generator).

## Installation

```bash
npm install --save @ckeditor/ckeditor5-package-tools
```

## Usage

The following scripts are available in the package:

* `test` – run tests using [Vitest](https://vitest.dev/) testing framework,
* `test:debug` – run tests using [Vitest](https://vitest.dev/) testing framework and allows debugging them. Once Vitest starts it will stop execution and wait for you to open developer tools that can connect to Node.js inspector,
* `start` – prepares the [development server](https://webpack.js.org/configuration/dev-server/) with the live-reloading mechanism,
* `dll:build` – prepares a file compatible with [CKEditor 5 DLL](https://ckeditor.com/docs/ckeditor5/latest/builds/guides/development/dll-builds.html) that exposes plugins from the package,
* `translations:synchronize` – validates and synchronizes the translation messages by updating all translation files (`*.po` files) to be in sync with the context file,
* `translations:validate` – only validates the translation messages against the context file,
* `export-package-as-javascript` – changes `main` entry in `package.json` file to point to a `.js` file,
* `export-package-as-typescript` – changes `main` entry in `package.json` file to point to a `.ts` file.

There are two ways to integrate these scripts, either with [npm scripts](https://docs.npmjs.com/cli/v7/using-npm/scripts) or Node.js scripts.

### Integration with npm scripts

Available scripts can be called via npm scripts in the `package.json` file, e.g.:

```json
{
  "dll:build": "ckeditor5-package-tools dll:build"
}
```

### Integration with Node.js scripts

Available scripts can be called manually as Node scripts, e.g.:

```js
import packageTools from '@ckeditor/ckeditor5-package-tools';

packageTools[ 'dll:build' ]( /* Ckeditor5PackageToolsOptions */ );
```

All available scripts require the `Ckeditor5PackageToolsOptions` object. Its interface is described in the [`lib/utils/parse-arguments.js`](https://github.com/ckeditor/ckeditor5-package-generator/blob/master/packages/ckeditor5-package-tools/lib/utils/parse-arguments.js) file.

## Contribute

The source code of this package is available on GitHub in https://github.com/ckeditor/ckeditor5-package-generator/tree/master/packages/ckeditor5-package-tools.

## Changelog

See the [`CHANGELOG.md`](https://github.com/ckeditor/ckeditor5-package-generator/blob/master/CHANGELOG.md) file.

## License

The package is licensed under the terms of [MIT license](https://opensource.org/licenses/MIT). Please check the [`LICENSE.md`](https://github.com/ckeditor/ckeditor5-package-generator/blob/master/packages/ckeditor5-package-tools/LICENSE.md) file.

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