CLI Usage

The Create TypeScript App CLI provides an interactive interface for generating TypeScript projects with guided prompts and preset selection.

Capabilities

Command Line Interface

The CLI tool is accessible via the package's binary entry point and provides an interactive template runner.

# Via npx (recommended)
npx create-typescript-app

# After global installation
npm install -g create-typescript-app
create-typescript-app

Interactive Template Runner

The CLI uses runTemplateCLI from the bingo package to provide an interactive experience that:

1. Prompts for Configuration: Interactively collects project configuration options
2. Preset Selection: Allows choosing from predefined presets (minimal, common, everything)
3. Custom Block Selection: Enables fine-tuned block selection for advanced users
4. Project Generation: Applies the configuration and generates project files
5. Environment Setup: Initializes the development environment

CLI Workflow

The CLI follows this workflow:

1. Project Information: Prompts for basic project details (name, description, owner)
2. Configuration Options: Collects additional configuration (Node.js version, access level, etc.)
3. Preset or Custom Selection: Choose a preset or configure individual blocks
4. Generation: Creates project structure with selected configuration
5. Post-Generation: Runs initialization commands (npm install, git init, etc.)

Entry Point

// Binary entry point: bin/index.js
// Requires Node.js >= 20.19.0

The CLI binary is automatically available when the package is installed and can be executed directly without importing into a Node.js script.

Runtime Requirements

• Node.js Version: >= 20.19.0 (minimum required)
• Package Manager: npm, yarn, or pnpm supported
• Git: Required for repository initialization
• Operating System: Cross-platform (Windows, macOS, Linux)

Command Execution

The CLI does not accept command-line arguments or flags. All configuration is handled through interactive prompts, making it user-friendly for developers of all experience levels.

# Simple execution - all options configured interactively
npx create-typescript-app

# The CLI will prompt for:
# - Project directory name
# - Project title and description  
# - Repository owner/organization
# - Package access level (public/restricted)
# - Node.js version preferences
# - Preset selection or custom block configuration
# - Additional configuration options