Skip to content

Getting Started

Welcome to the CLI Template documentation! This guide will help you get started with creating your own command-line application using this template.

What is CLI Template?

CLI Template is a modern, production-ready template for building command-line applications. It provides:

  • TypeScript support with strict type checking
  • Commander.js for command-line argument parsing
  • Vitest for unit testing
  • ESLint and Prettier for code quality
  • GitHub Actions for CI/CD
  • VitePress documentation
  • Interactive mode support
  • And much more!

Quick Start

  1. Clone the repository:

    bash
    git clone https://github.com/Shironex/cli-template.git my-cli
    cd my-cli
  2. Install dependencies:

    bash
    pnpm install
  3. Start development:

    bash
    pnpm dev
  4. Build your CLI:

    bash
    pnpm build

Documentation Sections

Released under the MIT License.