Skip to main content

Sapphire Logo


Plugin for @sapphire/framework so you can have pattern commands.

GitHub codecov npm bundle size npm


With pattern commands you can define rulesets to which the bot may respond.

Important notes

  • Starting August 31, 2022 this plugin will only work with Message Intent. This is because this plugin relies on scanning messages, which is impossible without the intent.


  • Fully ready for TypeScript!
  • Includes ESM ready entrypoint
  • Type generics for easy extension in TypeScript
  • Input/Output mapping


@sapphire/plugin-pattern-commands depends on the following packages. Be sure to install these along with this package!

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

npm install @sapphire/plugin-pattern-commands @sapphire/framework @sapphire/utilities @sapphire/stopwatch discord.js


  • Paste this in your Bot.ts (or where you initiate your client)
import '@sapphire/plugin-pattern-commands/register';
  • Create a new pattern-commands directory under /src
  • Make your first pattern command:
import type { Message } from 'discord.js';
import { PatternCommand } from '@sapphire/plugin-pattern-commands';
import { ApplyOptions } from '@sapphire/decorators';

aliases: ['cat', 'postman'],
chance: 85
export class AwooCommand extends PatternCommand {
public messageRun(message: Message) {

In this example there's a 85% chance when your bot will bark at someone who says cat or postman. The matcher is case-insensitive and can match at substrings as well (so in the example above the word catnip also can trigger your bot) For aliases you can use regexp as well, but you have to encapsulate them as a string. For example:

aliases: ['a{3,}'],

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 WithAddress
Open CollectiveClick Here
Ko-fiClick Here
PatreonClick Here
PayPalClick Here


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

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