CLI

The @foundrykit/cli package provides a command-line interface for FoundryKit development, scaffolding, and project management.

Features

• Project scaffolding: Quickly create new FoundryKit projects
• Component generation: Generate components, hooks, and utilities
• Development tools: Built-in development and build tools
• Interactive prompts: User-friendly interactive command interface
• Colorized output: Rich, colorized terminal output

Installation

pnpm add -g @foundrykit/cli

Usage

# Create a new FoundryKit project
foundrykit create my-project

# Generate a new component
foundrykit generate component Button

# Generate a new hook
foundrykit generate hook useLocalStorage

# Start development server
foundrykit dev

# Build for production
foundrykit build

Available Commands

Project Management

• create - Create a new FoundryKit project
• init - Initialize FoundryKit in an existing project
• update - Update FoundryKit packages and configurations

Code Generation

• generate component - Generate a new React component
• generate hook - Generate a new custom hook
• generate page - Generate a new page component
• generate api - Generate API route handlers

Development

• dev - Start development server
• build - Build for production
• lint - Run ESLint on code
• type-check - Run TypeScript type checking

Utilities

• format - Format code with Prettier
• test - Run tests
• clean - Clean build artifacts

Command Options

Global Options

• --verbose - Enable verbose output
• --interactive - Enable interactive mode
• --help - Show help information
• --version - Show version information

Project Creation Options

• --template - Specify project template
• --package-manager - Choose package manager (npm, pnpm, yarn)
• --typescript - Enable TypeScript
• --tailwind - Include Tailwind CSS

Generation Options

• --path - Specify output path
• --template - Choose component template
• --typescript - Generate TypeScript files
• --test - Include test files

Configuration

The CLI can be configured through:

• Command line arguments - Pass options directly to commands
• Interactive prompts - Answer questions when running commands
• Configuration files - Use .foundrykitrc or foundrykit.config.js

Templates

The CLI includes several templates for different use cases:

• default - Standard FoundryKit project template
• minimal - Minimal setup with essential packages
• full - Full setup with all packages and configurations
• custom - Custom template with user-defined configuration

Development Workflow

1. Create project - Use foundrykit create to start a new project
2. Generate components - Use foundrykit generate to create new components
3. Develop - Use foundrykit dev for development
4. Build - Use foundrykit build for production builds
5. Deploy - Deploy your built application

Dependencies

• commander - Command-line interface framework
• chalk - Terminal styling and colors
• inquirer - Interactive command-line prompts
• fs-extra - Enhanced file system operations
• glob - File pattern matching
• node-fetch - HTTP client for API requests