# @sapphire/framework

> Discord bot framework built for advanced and amazing bots.

Latest version **5.5.1** (published 2026-08-22) · MIT license · 0 weekly downloads

## Install

```sh
npm install @sapphire/framework
pnpm add @sapphire/framework
yarn add @sapphire/framework
bun add @sapphire/framework
```

## Health

**Score 75/100 (B)** — status: active.

Positive: has types; esm support; no vulnerabilities; has provenance; recently updated; high maintenance score; high quality score.

Warnings: low downloads.

## Facts

| | |
|---|---|
| Version | 5.5.1 |
| Published | 2026-08-22 |
| First published | 2020-12-22 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Node | >=v18 |
| Dependencies | 9 |
| Unpacked size | 2.1 MB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Provenance | attested (GitHub Actions) |
| GitHub stars | 756 |
| Author | @sapphire |
| Maintainers | favna, vladfrangu, kyranet |
| Keywords | bot, typescript, ts, yarn, discord, sapphire, standalone |

## Links

- npm: https://www.npmjs.com/package/@sapphire/framework
- Repository: https://github.com/sapphiredev/framework
- Homepage: https://www.sapphirejs.dev
- Issues: https://github.com/sapphiredev/framework/issues
- npm.io page: https://npm.io/package/@sapphire/framework

## Dependencies (9)

- [@sapphire/lexure](https://npm.io/package/@sapphire/lexure.md) ^1.1.12
- [@sapphire/pieces](https://npm.io/package/@sapphire/pieces.md) ^4.4.1
- [@sapphire/result](https://npm.io/package/@sapphire/result.md) ^2.8.0
- [@discordjs/builders](https://npm.io/package/@discordjs/builders.md) ^1.13.0
- [@sapphire/stopwatch](https://npm.io/package/@sapphire/stopwatch.md) ^1.5.4
- [@sapphire/utilities](https://npm.io/package/@sapphire/utilities.md) ^3.18.2
- [@sapphire/ratelimits](https://npm.io/package/@sapphire/ratelimits.md) ^2.4.11
- [@sapphire/discord-utilities](https://npm.io/package/@sapphire/discord-utilities.md) ^4.0.0
- [@sapphire/discord.js-utilities](https://npm.io/package/@sapphire/discord.js-utilities.md) ^7.3.3

## Alternatives

- [csv-to-markdown-table](https://npm.io/package/csv-to-markdown-table.md) — 47.0K weekly downloads
- [@sapphire/ratelimits](https://npm.io/package/@sapphire/ratelimits.md) — 4.4K weekly downloads
- [js-csvparser](https://npm.io/package/js-csvparser.md) — 2.0K weekly downloads
- [@adadapted/js-sdk](https://npm.io/package/@adadapted/js-sdk.md) — 251 weekly downloads
- [@grapecity/spread-sheets-sparklines](https://npm.io/package/@grapecity/spread-sheets-sparklines.md) — 103 weekly downloads

## Recent versions

- 5.5.1 (latest) — 2026-08-22
- 5.5.1-next.13d5023 (next) — 2025-12-24
- 5.0.8-pr-737.87e833f.0 (pr-737) — 2024-03-17
- 6.0.0-pr-728.524e708.0 (pr-728) — 2024-03-17
- 5.0.7-pr-716.ddccc23.0 (pr-716) — 2024-01-12
- 5.0.3-pr-701.a075d5f.0 (pr-701) — 2023-12-09
- 5.0.0 (upcoming) — 2023-12-04
- 5.0.0-pr-698.b00ddcb.0 (pr-698) — 2023-12-03
- 4.8.3-pr-695.fedd06b.0 (pr-695) — 2023-11-19
- 4.7.0-pr-673.6aa7846.0 (pr-673) — 2023-10-14
- 5.0.0-pr-668.06c0270.0 (pr-668) — 2023-09-30
- 4.5.4-pr-661.d195bc4.0 (pr-661) — 2023-09-03
- 4.4.0-pr-627.82f5588.0 (pr-627) — 2023-04-12
- 4.2.3-pr-622.23bda1a.0 (pr-622) — 2023-03-23
- 4.1.0-pr-602.94b457c.0 (pr-602) — 2023-02-05
- … 894 more at https://npm.io/package/@sapphire/framework/versions

## README

<div align="center">

![Sapphire Logo](https://raw.githubusercontent.com/sapphiredev/assets/main/banners/SapphireCommunity.png)

# Sapphire

**A pleasant Discord Bot framework**

[![GitHub](https://img.shields.io/github/license/sapphiredev/framework)](https://github.com/sapphiredev/framework/blob/main/LICENSE.md)
[![npm](https://img.shields.io/npm/v/@sapphire/framework?color=crimson&logo=npm&style=flat-square)](https://www.npmjs.com/package/@sapphire/framework)

[![Support Server](https://discord.com/api/guilds/737141877803057244/embed.png?style=banner2)](https://sapphirejs.dev/discord)

</div>

---

## Description

Sapphire is a Discord bot framework built on top of [discord.js] for advanced and amazing bots.

<div align="center" style="padding-top: 2rem; padding-bottom: 1rem">

| [**Click here for the documentation and guides**](https://www.sapphirejs.dev/) |
| ------------------------------------------------------------------------------ |

</div>

## Features

-   Written in TypeScript
-   Command Handler, Arguments, Pre-conditions and Listeners Store
-   Completely Modular and Extendable
-   Advanced Plugins Support
-   Supports many [plugins](https://github.com/sapphiredev/plugins)
-   Full TypeScript & JavaScript support

## Installation

`@sapphire/framework` depends on the following packages. Be sure to install these along with this package!

-   [`discord.js`](https://www.npmjs.com/package/discord.js)

You can use the following command to install this package, or replace `npm install` with your package manager of choice.

```sh
npm install @sapphire/framework discord.js@14.x
```

---

## Buy us some doughnuts

Sapphire Community is and always will be open source, even if we don't get donations. That being said, we know there are amazing people who may still want to donate just to show their appreciation. Thank you very much in advance!

We accept donations through Open Collective, Ko-fi, Paypal, Patreon and GitHub Sponsorships. You can use the buttons below to donate through your method of choice.

|   Donate With   |                       Address                       |
| :-------------: | :-------------------------------------------------: |
| Open Collective | [Click Here](https://sapphirejs.dev/opencollective) |
|      Ko-fi      |      [Click Here](https://sapphirejs.dev/kofi)      |
|     Patreon     |    [Click Here](https://sapphirejs.dev/patreon)     |
|     PayPal      |     [Click Here](https://sapphirejs.dev/paypal)     |

## Contributors

Please make sure to read the [Contributing Guide][contributing] before making a pull request.

Thank you to all the people who already contributed to Sapphire!

<a href="https://github.com/sapphiredev/framework/graphs/contributors">
  <img src="https://contrib.rocks/image?repo=sapphiredev/framework" />
</a>

[contributing]: https://github.com/sapphiredev/.github/blob/main/.github/CONTRIBUTING.md
[discord.js]: https://github.com/discordjs/discord.js

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