@bestwu/xx-cli

XX-CLI

A versatile CLI tool for scaffolding projects from various templates. Support for Vue TypeScript projects and TypeScript library development, with an extensible architecture for future templates.

Installation

npm install -g @bestwu/xx-cli

Usage

Create a new project

Interactive mode (recommended):

xx-cli create

Create a project with specific name:

xx-cli create my-project

Create a project with specific template:

xx-cli create my-project --template vue-ts
xx-cli create my-lib --template lib-ts

List available templates

xx-cli list

Available Templates

vue-ts

• Description: Vue TypeScript project template for daily development
• Repository: https://github.com/xx-template/vue-ts.git
• Use case: Web applications, SPAs, Vue projects

lib-ts

• Description: TypeScript library template for package development
• Repository: https://github.com/xx-template/lib-ts.git
• Use case: NPM packages, TypeScript libraries, reusable components

Features

• 🎯 Template Selection: Choose from multiple project templates
• 🚀 Interactive CLI: User-friendly prompts for template and project name selection
• 📦 Automatic Setup: Package.json updates and clean git history
• 🔧 Command Line Options: Direct template specification for automation
• 📋 Template Listing: View all available templates and their descriptions
• 🎨 Extensible: Easy to add new templates in the future

CLI Commands

Command	Description	Options
create [project-name]	Create a new project	-t, --template <template>
list	List all available templates	-

Development

• Clone this repository
• Install dependencies:

  npm install
  

• Build the project:

  npm run build
  

• Link the package globally:

  npm link
  

Adding New Templates

To add a new template, update the templates array in src/index.ts:

{
  name: 'template-name',
  description: 'Template description',
  repository: 'https://github.com/xx-template/template-repo.git',
  postCloneInstructions: [
    'npm install',
    'npm run start'
  ]
}

License

MIT