shiver-framework

KO | EN

gitlite — search

#javascript #python #hacktoberfest #react #ai #typescript #llm #go #golang #android #machine-learning #rust #deep-learning #linux

shiver-framework

★ 9 Open GitHub ↗

Discord bot framework built on discord.js. Slash and prefix commands, middleware chain, pluggable storage and settings, health endpoints, ping/HTTP push helpers, safe message edit/delete with debounce. Designed for speed, safety, and clarity. Node 18+.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

<h1 align="center">Shiver Framework</h1>

<p align="center">
  High-performance Discord bot framework with AI integration, middleware pipelines, storage adapters, and 50+ modules.
</p>

---

## Features

- **Unified command model** - One file per command. Slash, prefix, context menu, and autocomplete in a single module.
- **Middleware pipeline** - Declarative guards, rate limiters, cooldowns, permission checks, and preconditions.
- **AI-first** - Export commands as OpenAI/Anthropic function schemas, build context from interactions, track conversation history.
- **Pluggable storage** - JSON, Supabase, SQLite, MongoDB. Settings and migrations on top.
- **Production ready** - Health endpoints, anti-crash, multi-instance detection, hot-reload, HTTP push.
- **Components v2** - Full support for Discord's new component system with builders, pagination, and confirmation flows.
- **50+ modules** - Scheduler, broadcast, feature flags, ticket system, giveaway, tags, starboard, guards, and more.

---

## Install

```bash
npm install shiver-framework
```

---

## Quick Start

```js
const { ShiverFramework } = require('shiver-framework');
const { GatewayIntentBits } = require('discord.js');

const framework = new ShiverFramework({
    commandsPath: './src/commands',
    prefix: ',',
    ownerIds: ['YOUR_DISCORD_USER_ID']
});

const client = framework.createClient({
    intents: [
        GatewayIntentBits.Guilds,
        GatewayIntentBits.GuildMessages,
        GatewayIntentBits.MessageContent
    ]
});

async function main() {
    await framework.init(client);
    await client.login(process.env.DISCORD_TOKEN);
}

main().catch(console.error);
```

### Command Example

```js
const { SlashCommandBuilder } = require('discord.js');

module.exports = {
    name: 'ping',
    aliases: ['p'],
    data: new SlashCommandBuilder()
        .setName('ping')
        .setDescription('Check bot latency'),
    async executeSlash(interaction, client) {
        await interaction.editReply({ content: `Pong - ${client.ws.ping}ms` });
    },
    async executePrefix(message, args, client) {
        await message.reply(`Pong - ${client.ws.ping}ms`);
    }
};
```

---

## AI Integration

Shiver Framework is built with AI-first workflows. Wire Discord to GPT-4, build AI agents that execute bot actions, or create smart chatbots.

```js
const { FunctionRegistry } = require('shiver-framework');

const registry = new FunctionRegistry();
registry.registerAllFromCommands(framework.commands.getAllSlash());

const tools = registry.exportOpenAITools();
const response = await openai.chat.completions.create({ model: 'gpt-4o', tools, messages });
```

```js
const { AIContext } = require('shiver-framework');

const ctx = await AIContext.fromInteraction(interaction, framework);
const systemPrompt = ctx.toPromptString();
```

```js
const { PromptBuilder } = require('shiver-framework');

const messages = PromptBuilder.create()
    .addSystem('You are a helpful Discord bot assistant.')
    .addGuildContext(interaction.guild)
    .addUserContext(interaction.user, interaction.member)
    .addCommandList(framework.commands.getAllSlash())
    .addHistory(framework.conversation, channelId, 20)
    .toOpenAI();
```

---

## Modules

| Category | Modules |
|----------|---------|
| **AI** | `FunctionRegistry`, `AIContext`, `ConversationContext`, `PromptBuilder`, `NaturalCommandRouter`, `StructuredOutput` |
| **Interaction** | `ComponentRouter`, `WizardSession`, `FormBuilder`, `VoteManager`, `MessageCollector`, `UserSessionStore` |
| **Infrastructure** | `Scheduler`, `BroadcastManager`, `RequestDeduplicator`, `SafeExecutor`, `FeatureFlagManager`, `CommandDisabledManager` |
| **DX** | `HelpGenerator`, `CommandSuggester`, `DiffTracker`, `AlertManager`, `LocaleSync` |
| **UI** | `ProgressBar`, `TableBuilder`, `ListBuilder` |
| **Systems** | `TicketSystem`, `GiveawaySystem`, `TagSystem`, `StarboardSystem` |
| **Guards** | `OwnerGuard`, `GuildGuard`, `ChannelGuard`, `RoleGuard`, `TimeGuard`, `RateLimitGuard` |
| **Storage** | `JsonStorageAdapter`, `SupabaseStorageAdapter`, `SQLiteStorageAdapter`, `MongoStorageAdapter` |
| **Core** | `CommandRegistry`, `EventBus`, `Container`, `ShiverClient`, `HealthManager`, `StatsManager` |

---

## Configuration

```js
const framework = new ShiverFramework({
    commandsPath: './src/commands',    // Command files directory
    prefix: '!',                       // Prefix for prefix commands
    ownerIds: ['123456789'],          // Owner user IDs
    storage: { backend: 'json', path: './data' },
    health: { enabled: true, port: 8080 },
    slashSync: { guildIds: null },     // null = global sync
    debug: false
});
```

---

## CLI

```bash
npx shiver-framework validate [commandsDir]    # Validate command files
npx shiver-framework sync [token] [commandsDir] # Register slash commands
npx shiver-framework generate command ping     # Scaffold a command
```

---

## Requirements

| Requirement | Version |
|-------------|---------|
| Node.js | >= 18 |
| discord.js | ^14.25.1 |

**Optional:** `redis`, `canvas`, `@discordjs/voice`, `@supabase/supabase-js`, `better-sqlite3`, `mongodb`

---

## Documentation

Full documentation with code examples, API reference, and guides:

**[shiver.one/framework](https://shiver.one/framework)**

---

## Related

- **[Shiver Bot](https://shiver.one)** - The Discord bot built with this framework
- **[GitHub](https://github.com/yuwxd/shiver-framework)** - Source code and issues

---

## License

MIT

shiver-framework

Today's picks

Was this content helpful?

Recent Feedback

shiver-framework

Today's picks

Was this content helpful?

Recent Feedback

Download README