# Discremy Documentation

Discremy is a Discord bot framework built for speed, structure, and extensibility.

It uses JavaScript, official Discord libraries, and optional modules for storage and APIs.

{% hint style="info" %}
Use Node.js `v20` or higher.
{% endhint %}

## Why Discremy

* Bootstrap a project fast with `npx discremy init`
* Validate config and dependencies before startup
* Add MongoDB or MySQL only when needed
* Load events, commands, and API routes from files

## Start here

<table data-card-size="large" data-view="cards"><thead><tr><th></th><th></th><th></th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td><h4><i class="fa-rocket-launch" style="color:$primary;">:rocket-launch:</i></h4></td><td><h4>Getting Started</h4></td><td>Create your first bot and configure the core runtime.</td><td><a href="/spaces/tnOcQlvxH9qDcbauqaVr/pages/PbYb0GukRhiS4qCHdRal">/spaces/tnOcQlvxH9qDcbauqaVr/pages/PbYb0GukRhiS4qCHdRal</a></td></tr><tr><td><h4><i class="fa-cubes" style="color:$primary;">:cubes:</i></h4></td><td><h4>Modules</h4></td><td>Install optional database modules and use their helpers.</td><td><a href="/spaces/tnOcQlvxH9qDcbauqaVr/pages/EFXeLTHVDQLFgK0Iy51O">/spaces/tnOcQlvxH9qDcbauqaVr/pages/EFXeLTHVDQLFgK0Iy51O</a></td></tr><tr><td><h4><i class="fa-folder-tree" style="color:$primary;">:folder-tree:</i></h4></td><td><h4>Project Structure</h4></td><td>Organize commands, events, and REST routes with files.</td><td><a href="/spaces/tnOcQlvxH9qDcbauqaVr/pages/oUUNprjFZmH3rqDBvb9h">/spaces/tnOcQlvxH9qDcbauqaVr/pages/oUUNprjFZmH3rqDBvb9h</a></td></tr><tr><td><h4><i class="fa-book-open" style="color:$primary;">:book-open:</i></h4></td><td><h4>Reference</h4></td><td>Look up command format, releases, and troubleshooting.</td><td><a href="/spaces/tnOcQlvxH9qDcbauqaVr/pages/AYVJmAXbSHYSDodrPBYA">/spaces/tnOcQlvxH9qDcbauqaVr/pages/AYVJmAXbSHYSDodrPBYA</a></td></tr></tbody></table>

## Quick start

```bash
npx discremy init
```

Or install the core package:

```bash
npm i discremy
```

Optional modules:

```bash
npm i @discremy/mongodb
npm i @discremy/mysql
```

## Next pages

* [Getting Started](/documentation/getting-started/getting-started.md)
* [Configuration](/documentation/getting-started/quickstart.md)
* [CLI Preflight](/documentation/getting-started/cli-preflight.md)
* [Modules](/documentation/modules/modules.md)
* [Troubleshooting](/documentation/reference/troubleshooting.md)


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.discremy.com/documentation/discremy-documentation.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.