Skip to Content
🎉 Hyperse Wizard has been published.
DocumentationIntroduction

Wizard - Modern CLI Framework

@hyperse/wizard is a modern, type-safe CLI framework built with TypeScript that provides powerful command-line tool building capabilities. It combines robust TypeScript support with enhanced features for crafting interactive command-line applications with excellent developer experience.

Key Design Principles

  • Type Safety First - Full TypeScript support with excellent IntelliSense and compile-time error checking
  • Plugin Architecture - Modular design allowing easy extension and customization
  • Event-Driven - Built-in event system for handling complex workflows and async operations
  • Developer Experience - Intuitive APIs with comprehensive documentation and examples

✨ Core Features

  • 🚀 Type Safety: Full TypeScript support, type-safe APIs, great DX
  • 🌍 Internationalization: Built-in multi-language and easy locale switching
  • 🔌 Plugin System: Flexible, extensible plugin architecture
  • 🎯 Event-Driven: Event-based, async-ready, supports middleware
  • 🛠️ Command Builder: Intuitive command definitions, subcommands, type inference
  • 📝 Logging: Built-in multi-level logging, configurable output
  • 🎨 Theme: Colored output, theme customization, cross-platform
  • ⚡ Performance: Fast startup, efficient execution, low overhead

🏗️ Project Architecture

Wizard uses a modular design with the following core packages:

Core Package

  • @hyperse/wizard - Core library providing basic functionality and APIs

Plugin Ecosystem

Wizard provides a rich plugin ecosystem for common CLI functionality:

  • @hyperse/wizard-plugin-help - Comprehensive help information plugin with customizable output formats
  • @hyperse/wizard-plugin-version - Version information plugin with semantic versioning support
  • @hyperse/wizard-plugin-error - Advanced error handling plugin with error recovery and reporting
  • @hyperse/wizard-plugin-loader - Plugin loader with automatic discovery and dependency management

🎯 Next Steps

Ready to get started? Check out the following guides:

Last updated on