Skip to Content
Use Botify

CLI Flags & Options

Complete reference for create-use-botify interactive prompts, CLI flags, and programmatic scaffolding API.

create-use-botify works both as an interactive wizard and as a fully scriptable CLI for CI pipelines or repeat setups.

Usage

Terminal
pnpm create use-botify [project-name] [options]

You can also invoke it with npx create-use-botify@latest, bun create use-botify, or yarn create use-botify.

Options Reference

FlagDescriptionDefault
-y, --yesSkip all prompts and scaffold with defaultsfalse
--src / --no-srcPlace application files inside src/true
--alias <pattern>TypeScript & Vite import alias (e.g. @/*, ~/*)@/*
--admin / --no-adminInclude (admin)/panel feature & ADMIN_IDS guardtrue
--developer / --no-developerInclude (developer) custom emoji tools (/add_icon, /list_icons, /remove_icon)true
--images / --no-imagesInclude @use-botify/plugins/images manifest & file_id cachingfalse
--pm <pm>Package manager: pnpm, npm, yarn, or bunDetected
--use-pnpm, --use-npm, --use-yarn, --use-bunShorthand package manager selectors—
--skip-install / --no-installWrite files without running dependency installationfalse
--no-gitSkip git init after scaffoldingfalse
--overwrite / --forceAllow scaffolding into a non-empty target directoryfalse
-v, --versionPrint installed CLI version—
-h, --helpPrint CLI help message—

Common Recipes

Minimal bot without optional plugins

Terminal
pnpm create use-botify lean-bot --yes --no-admin --no-developer --no-images

Only installs @use-botify/core, @use-botify/router, grammy, and zod as runtime dependencies, keeping @use-botify/tooling in devDependencies.

Root-level layout with custom alias and image caching

Terminal
pnpm create use-botify media-bot --yes --no-src --alias "~/*" --images

Scaffold into the current directory

Terminal
pnpm create use-botify . --yes --overwrite

Programmatic API

create-use-botify also exports its template engine and disk writer for custom tooling or monorepo generators:

scaffold-example.ts
import {
  renderProjectFiles,
  resolveScaffoldOptions,
  scaffoldProject,
} from "create-use-botify";

const options = resolveScaffoldOptions({
  projectName: "support-bot",
  useSrcDir: true,
  importAlias: "@/*",
  admin: true,
  developer: false,
  images: true,
  install: false,
  git: false,
});

// Preview generated files in memory without touching disk
const files = renderProjectFiles(options);

// Or write the project directly to options.targetDir
const result = await scaffoldProject(options);
console.log(
  `Created ${result.files.length} files at ${result.options.targetDir}`,
);

On this page