Skip to Content
Use Botify
Packages

@use-botify/router

File-based features/ router with (tier) route groups, dynamic [param] callbacks, and menu sync.

@use-botify/router lets you register features either declaratively via defineFeature or automatically from disk with createFsRouter.

Installation

Terminal
pnpm add @use-botify/router grammy

Entrypoints

Import PathPurpose
@use-botify/routerProgrammatic createRouter and defineFeature builders
@use-botify/router/fscreateFsRouter filesystem scanner & dynamic module loader
@use-botify/router/typesFeature, command, callback, and router TypeScript interfaces

Filesystem Mounting

src/main.ts
import path from "node:path";

import { createBot } from "@use-botify/core";
import { createFsRouter } from "@use-botify/router/fs";

const app = createBot({ token: process.env.BOT_TOKEN! });

const router = await createFsRouter({
  featuresDir: path.resolve(import.meta.dirname, "features"),
  logger: app.logger,
});

app.use(router.composer);
await app.start();

Read the File-Based Routing guide for folder conventions and route groups.

On this page