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
Clone the repository:
bashgit clone https://github.com/Shironex/cli-template.git my-cli cd my-cli
Install dependencies:
bashpnpm install
Start development:
bashpnpm dev
Build your CLI:
bashpnpm build
Documentation Sections
- Installation - Learn how to install and set up the template
- Basic Commands - Understand the built-in commands and how to create your own
- Interactive Mode - Explore the interactive command mode
- Testing - Learn how to write and run tests
- Contributing - Guidelines for contributing to the project
- Best Practices - Tips and best practices for CLI development