# egg

> A web framework's framework for Node.js

Latest version **3.34.0** (published 2026-01-18) · MIT license · 0 weekly downloads

## Install

```sh
npm install egg
pnpm add egg
yarn add egg
bun add egg
```

## Health

**Score 70/100 (B)** — status: stable.

Positive: has types; no vulnerabilities; has provenance; high maintenance score; high quality score; popular repo.

Warnings: low downloads; no esm support.

## Facts

| | |
|---|---|
| Version | 3.34.0 |
| Published | 2026-01-18 |
| First published | 2013-08-08 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Node | >= 14.20.0 |
| Dependencies | 42 |
| Unpacked size | 158.3 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Provenance | attested (GitHub Actions) |
| GitHub stars | 18977 |
| Maintainers | gxkl, eggjs-admin, fengmk2, atian25, hyj1991, killagu, coolme200, akitasummer, dead_horse, shaoshuai0102, popomore |
| Keywords | web, app, http, application, framework, middleware, koa, egg |

## Links

- npm: https://www.npmjs.com/package/egg
- Repository: https://github.com/eggjs/egg
- Issues: https://github.com/eggjs/egg/issues
- npm.io page: https://npm.io/package/egg

## Dependencies (42)

- [ms](https://npm.io/package/ms.md) ^2.1.3
- [ylru](https://npm.io/package/ylru.md) ^1.3.2
- [urllib](https://npm.io/package/urllib.md) ^2.33.0
- [accepts](https://npm.io/package/accepts.md) ^1.3.8
- [extend2](https://npm.io/package/extend2.md) ^1.0.1
- [urllib4](https://npm.io/package/urllib4.md) npm:urllib@^4.5.0
- [utility](https://npm.io/package/utility.md) ^2.1.0
- [egg-core](https://npm.io/package/egg-core.md) ^5.4.0
- [egg-i18n](https://npm.io/package/egg-i18n.md) ^2.1.1
- [egg-view](https://npm.io/package/egg-view.md) ^2.1.3
- [graceful](https://npm.io/package/graceful.md) ^1.1.0
- [delegates](https://npm.io/package/delegates.md) ^1.0.0
- [egg-jsonp](https://npm.io/package/egg-jsonp.md) ^2.0.0
- [onelogger](https://npm.io/package/onelogger.md) ^1.0.0
- [@types/koa](https://npm.io/package/@types/koa.md) ^2.13.5
- [egg-errors](https://npm.io/package/egg-errors.md) ^2.3.1
- [egg-logger](https://npm.io/package/egg-logger.md) ^3.0.1
- [egg-static](https://npm.io/package/egg-static.md) ^2.2.0
- [is-type-of](https://npm.io/package/is-type-of.md) ^2.1.0
- [egg-cluster](https://npm.io/package/egg-cluster.md) ^2.0.0
- [egg-cookies](https://npm.io/package/egg-cookies.md) ^2.6.1
- [egg-onerror](https://npm.io/package/egg-onerror.md) ^2.1.1
- [egg-session](https://npm.io/package/egg-session.md) ^3.3.0
- [egg-watcher](https://npm.io/package/egg-watcher.md) ^3.1.1
- [humanize-ms](https://npm.io/package/humanize-ms.md) ^1.2.1
- [koa-is-json](https://npm.io/package/koa-is-json.md) ^1.0.0
- [on-finished](https://npm.io/package/on-finished.md) ^2.4.1
- [sendmessage](https://npm.io/package/sendmessage.md) ^2.0.0
- [urllib-next](https://npm.io/package/urllib-next.md) npm:urllib@^3.27.1
- [egg-schedule](https://npm.io/package/egg-schedule.md) ^4.0.0
- [egg-security](https://npm.io/package/egg-security.md) ^3.0.0
- [koa-override](https://npm.io/package/koa-override.md) ^3.0.0
- [egg-multipart](https://npm.io/package/egg-multipart.md) ^3.1.0
- [@types/accepts](https://npm.io/package/@types/accepts.md) ^1.3.5
- [agentkeepalive](https://npm.io/package/agentkeepalive.md) ^4.2.1
- [cluster-client](https://npm.io/package/cluster-client.md) ^3.3.0
- [egg-logrotator](https://npm.io/package/egg-logrotator.md) ^3.1.0
- [koa-bodyparser](https://npm.io/package/koa-bodyparser.md) ^4.4.1
- [egg-development](https://npm.io/package/egg-development.md) ^3.0.0
- [@types/koa-router](https://npm.io/package/@types/koa-router.md) ^7.4.4
- [cache-content-type](https://npm.io/package/cache-content-type.md) ^1.0.1
- [circular-json-for-egg](https://npm.io/package/circular-json-for-egg.md) ^1.0.0

## Alternatives

- [@opentelemetry/exporter-zipkin](https://npm.io/package/@opentelemetry/exporter-zipkin.md) — 14.8M weekly downloads
- [pusher-js](https://npm.io/package/pusher-js.md) — 2.0M weekly downloads
- [browserify](https://npm.io/package/browserify.md) — 1.7M weekly downloads
- [sqs-consumer](https://npm.io/package/sqs-consumer.md) — 1.7M weekly downloads
- [@sanity/eventsource](https://npm.io/package/@sanity/eventsource.md) — 930.8K weekly downloads

## Recent versions

- 3.34.0 (latest) — 2026-01-18
- 4.1.2-beta.26 (beta) — 2026-08-07
- 4.0.10 (next) — 2025-03-10
- 2.37.0 (latest-2) — 2022-09-23
- 1.21.0 (latest-1) — 2020-09-08
- 4.1.2-beta.25 — 2026-07-13
- 4.1.2-beta.24 — 2026-07-12
- 4.1.2-beta.23 — 2026-07-11
- 4.1.2-beta.22 — 2026-07-11
- 4.1.2-beta.20 — 2026-07-09
- 4.1.2-beta.19 — 2026-06-29
- 4.1.2-beta.17 — 2026-06-28
- 4.1.2-beta.16 — 2026-06-26
- 4.1.2-beta.15 — 2026-06-26
- 4.1.2-beta.14 — 2026-06-25
- … 261 more at https://npm.io/package/egg/versions

## README

English | [简体中文](./README.zh-CN.md)

<div style="text-align:center">
	<img src="site/public/assets/egg-banner.png" />
</div>

[![NPM version](https://img.shields.io/npm/v/egg/release-3.x.svg?style=flat-square)](https://www.npmjs.com/package/egg/v/release-3.x)
[![NPM quality](http://npm.packagequality.com/shield/egg.svg?style=flat-square)](http://packagequality.com/#?package=egg)
[![NPM download](https://img.shields.io/npm/dm/egg.svg?style=flat-square)](https://npmjs.org/package/egg)
[![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2Feggjs%2Fegg.svg?type=shield)](https://app.fossa.com/projects/git%2Bgithub.com%2Feggjs%2Fegg?ref=badge_shield)

[![Continuous Integration](https://github.com/eggjs/egg/actions/workflows/nodejs-3.x.yml/badge.svg)](https://github.com/eggjs/egg/actions?query=branch%3A3.x)
[![codecov](https://codecov.io/gh/eggjs/egg/branch/3.x/graph/badge.svg?token=2sKMCDNkcl)](https://app.codecov.io/gh/eggjs/egg/tree/3.x)
[![Known Vulnerabilities](https://snyk.io/test/npm/egg/badge.svg?style=flat-square)](https://snyk.io/test/npm/egg)
[![Open Collective backers and sponsors](https://img.shields.io/opencollective/all/eggjs?style=flat-square)](https://opencollective.com/eggjs)

## Features

- Built-in Process Management
- Plugin System
- Framework Customization
- Lots of [plugins](https://github.com/search?q=topic%3Aegg-plugin&type=Repositories)

## Quickstart

Follow the commands listed below.

```bash
$ mkdir showcase && cd showcase
$ npm init egg --type=simple # Optionally pnpm create egg --type=simple
$ npm install
$ npm run dev
$ open http://localhost:7001
```

> Node.js >= 14.20.0 required.

## Documentations

- [Documentations](https://v3.eggjs.org/)
- [Plugins](https://github.com/search?q=topic%3Aegg-plugin&type=Repositories)
- [Frameworks](https://github.com/search?q=topic%3Aegg-framework&type=Repositories)
- [Examples](https://github.com/eggjs/examples)

## Contributors

[![contributors](https://contrib.rocks/image?repo=eggjs/egg&max=240&columns=26)](https://github.com/eggjs/egg/graphs/contributors)

## How to Contribute

Please let us know how can we help. Do check out [issues](https://github.com/eggjs/egg/issues) for bug reports or suggestions first.

To become a contributor, please follow our [contributing guide](CONTRIBUTING.md).

## Sponsors and Backers

[![sponsors](https://opencollective.com/eggjs/tiers/sponsors.svg?avatarHeight=48)](https://opencollective.com/eggjs#support)
[![backers](https://opencollective.com/eggjs/tiers/backers.svg?avatarHeight=48)](https://opencollective.com/eggjs#support)

## License

[MIT](LICENSE)

[![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2Feggjs%2Fegg.svg?type=large)](https://app.fossa.com/projects/git%2Bgithub.com%2Feggjs%2Fegg?ref=badge_large)

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