Skip to content

Latest commit

 

History

History
101 lines (74 loc) · 3.72 KB

README.md

File metadata and controls

101 lines (74 loc) · 3.72 KB

support server npm version npm downloads

create-commandkit

create-commandkit is a CLI utility to quickly instantiate a Discord bot with CommandKit.

Features

  • Interactive, beautiful command-line interface 🖥️
  • Supports CommonJS and ES Modules 📦
  • Dynamic template system with examples from GitHub 🚀
  • Support for all major package managers (npm, pnpm, yarn, bun, deno) 📦
  • TypeScript and JavaScript support 🔧

Documentation

You can find the full documentation here.

Usage

Basic Usage

npx create-commandkit@latest

With Project Name

npx create-commandkit@latest my-bot

Using Examples

# Use a curated example
npx create-commandkit@latest --example with-database

# Use a custom GitHub repository
npx create-commandkit@latest --example "https://github.com/user/repo"

# Use a specific path within a repository
npx create-commandkit@latest --example "https://github.com/user/repo" --example-path "examples/bot"

CLI Options

  • -h, --help - Show all available options
  • -V, --version - Output the version number
  • -e, --example <name-or-url> - An example to bootstrap the app with
  • --example-path <path> - Specify the path to the example separately
  • --use-npm - Use npm as package manager
  • --use-pnpm - Use pnpm as package manager
  • --use-yarn - Use yarn as package manager
  • --use-bun - Use bun as package manager
  • --use-deno - Use deno as package manager
  • --skip-install - Skip installing packages
  • --no-git - Skip git initialization
  • --yes - Use defaults for all options
  • --list-examples - List all available examples from the official repository

Available Examples

Examples

# Create a basic TypeScript bot, skip installation
npx create-commandkit@latest --example basic-ts --skip-install

# Create a bot with all defaults (no prompts)
npx create-commandkit@latest --yes

# Create a bot from custom repository
npx create-commandkit@latest --example "https://github.com/username/my-commandkit-template"

# Create a bot with pnpm
npx create-commandkit@latest --use-pnpm

# List all available examples
npx create-commandkit@latest --list-examples

Support and Suggestions

Submit any queries or suggestions in our Discord community.