4e8e5069fa
- Added: api-patterns, app-builder, architecture, bash-linux, behavioral-modes, clean-code, code-review-checklist, database-design, deployment-procedures, docker-expert, documentation-templates, game-development, geo-fundamentals, i18n-localization, lint-and-validate, mobile-design, nestjs-expert, nextjs-best-practices, nodejs-best-practices, parallel-agents, performance-profiling, plan-writing, powershell-windows, prisma-expert, python-patterns, react-patterns, red-team-tactics, seo-fundamentals, server-management, tailwind-patterns, tdd-workflow, typescript-expert, vulnerability-scanner - Updated README: skill count 179 → 223 - Added credit for vudovn/antigravity-kit (MIT License) Source: https://github.com/vudovn/antigravity-kit
89 lines
1.7 KiB
Markdown
89 lines
1.7 KiB
Markdown
---
|
|
name: cli-tool
|
|
description: Node.js CLI tool template principles. Commander.js, interactive prompts.
|
|
---
|
|
|
|
# CLI Tool Template
|
|
|
|
## Tech Stack
|
|
|
|
| Component | Technology |
|
|
|-----------|------------|
|
|
| Runtime | Node.js 20+ |
|
|
| Language | TypeScript |
|
|
| CLI Framework | Commander.js |
|
|
| Prompts | Inquirer.js |
|
|
| Output | chalk + ora |
|
|
| Config | cosmiconfig |
|
|
|
|
---
|
|
|
|
## Directory Structure
|
|
|
|
```
|
|
project-name/
|
|
├── src/
|
|
│ ├── index.ts # Entry point
|
|
│ ├── cli.ts # CLI setup
|
|
│ ├── commands/ # Command handlers
|
|
│ ├── lib/
|
|
│ │ ├── config.ts # Config loader
|
|
│ │ └── logger.ts # Styled output
|
|
│ └── types/
|
|
├── bin/
|
|
│ └── cli.js # Executable
|
|
└── package.json
|
|
```
|
|
|
|
---
|
|
|
|
## CLI Design Principles
|
|
|
|
| Principle | Description |
|
|
|-----------|-------------|
|
|
| Subcommands | Group related actions |
|
|
| Options | Flags with defaults |
|
|
| Interactive | Prompts when needed |
|
|
| Non-interactive | Support --yes flags |
|
|
|
|
---
|
|
|
|
## Key Components
|
|
|
|
| Component | Purpose |
|
|
|-----------|---------|
|
|
| Commander | Command parsing |
|
|
| Inquirer | Interactive prompts |
|
|
| Chalk | Colored output |
|
|
| Ora | Spinners/loading |
|
|
| Cosmiconfig | Config file discovery |
|
|
|
|
---
|
|
|
|
## Setup Steps
|
|
|
|
1. Create project directory
|
|
2. `npm init -y`
|
|
3. Install deps: `npm install commander @inquirer/prompts chalk ora cosmiconfig`
|
|
4. Configure bin in package.json
|
|
5. `npm link` for local testing
|
|
|
|
---
|
|
|
|
## Publishing
|
|
|
|
```bash
|
|
npm login
|
|
npm publish
|
|
```
|
|
|
|
---
|
|
|
|
## Best Practices
|
|
|
|
- Provide helpful error messages
|
|
- Support both interactive and non-interactive modes
|
|
- Use consistent output styling
|
|
- Validate inputs with Zod
|
|
- Exit with proper codes (0 success, 1 error)
|