1.0.2 • Published 6 months ago

@bluefly/cli v1.0.2

Weekly downloads
-
License
MIT
Repository
gitlab
Last release
6 months ago

Bluefly CLI - Optimized Edition

Enterprise-grade command line interface for the Bluefly LLM Platform. Built with TypeScript, featuring ecosystem-standard dependencies and professional CLI patterns.

šŸš€ Quick Start

# Install dependencies
npm install

# Build the CLI
npm run build

# Run the CLI
npm run cli --help

# Test functionality
npm run cli workspace list
npm run cli dev test --coverage

✨ Features

  • Ecosystem-Standard Dependencies: Built with proven packages (commander, cosmiconfig, zod, ora, listr2)
  • Type-Safe Configuration: Zod schema validation with auto-completion
  • Professional UI: Rich progress indicators, colors, and formatted output
  • Extensible Architecture: Command-based structure with dependency injection
  • Development Tools: Comprehensive dev, test, and build commands
  • Workspace Management: Multi-package workspace operations

šŸ“ Project Structure

bfcli/
ā”œā”€ā”€ src/
│   ā”œā”€ā”€ cli-optimized.ts      # Main CLI implementation
│   ā”œā”€ā”€ types.d.ts           # Type definitions
│   ā”œā”€ā”€ commands/            # Command implementations
│   ā”œā”€ā”€ services/            # Business logic services
│   ā”œā”€ā”€ utils/               # Utility functions
│   └── types/               # TypeScript types
ā”œā”€ā”€ dist/                    # Compiled output
ā”œā”€ā”€ docs/                    # Documentation
│   ā”œā”€ā”€ guides/              # User guides
│   ā”œā”€ā”€ api/                 # API documentation
│   └── archive/             # Legacy documentation
ā”œā”€ā”€ scripts/                 # Build and maintenance scripts
ā”œā”€ā”€ tests/                   # Test suites
└── templates/               # Code templates

šŸ”§ Development

# Watch mode development
npm run build:watch

# Run tests
npm run test
npm run test:coverage

# Lint and format
npm run lint
npm run format

# Type checking
npm run type-check

# Full validation
npm run validate

šŸ“š Available Commands

Workspace Management

  • bfcli workspace list - List all packages
  • bfcli workspace info <package> - Package information
  • bfcli workspace create <name> - Create new package

Project Operations

  • bfcli project init [name] - Initialize new project
  • bfcli project status - Show project status

Development Tools

  • bfcli dev build - Build project
  • bfcli dev test - Run tests
  • bfcli doctor - System diagnostics

Configuration

  • bfcli config get [key] - Get configuration
  • bfcli config set <key> <value> - Set configuration
  • bfcli config reset - Reset to defaults

šŸ—ļø Architecture

The CLI follows modern patterns:

  • Dependency Injection: Clean separation via CommandContext
  • Command Pattern: Extensible command structure
  • Configuration Management: Cosmiconfig with Zod validation
  • Error Handling: Structured error boundaries
  • Logging: Debug module with namespaces

šŸ”— Dependencies

Core Dependencies

  • commander - CLI framework
  • cosmiconfig - Configuration management
  • zod - Schema validation
  • chalk - Terminal colors
  • ora - Progress spinners
  • listr2 - Task execution
  • enquirer - Interactive prompts

Development Dependencies

  • typescript - Type system
  • vitest - Testing framework
  • eslint - Code linting
  • prettier - Code formatting

šŸ“„ License

MIT License - see LICENSE file for details.

šŸ¤ Contributing

  1. Follow TypeScript strict mode
  2. Use ecosystem-standard patterns
  3. Add tests for new features
  4. Update documentation
  5. Run npm run validate before commits

Documentation Structure

Changelog

See CHANGELOG.md for the full changelog.

Innovation TODO

See TODO_INNOVATION.md for the current innovation and enhancement backlog.


Part of the Bluefly LLM Platform - Enterprise AI orchestration with Drupal 11 as the control plane.