Capsule CLI

Command-line interface for Capsule - Build and deploy PWAs with native capabilities.

Installation

npm install -g @capsule/cli

Usage

capsule [command] [options]

Commands

• create - Create a new Capsule project
• init - Initialize Capsule in an existing project
• migrate - Migrate an existing web app to Capsule
• dev - Start development server
• build - Build the Capsule project
• deploy - Deploy the Capsule project
• test - Run tests
• publish - Publish to app stores
• validate - Validate your app configuration and features
• validate-build - Validate build artifacts
• test-device - Test your app on a device or simulator

Error Handling & Validation

Capsule CLI includes a comprehensive error handling and validation system to provide clear, actionable error messages and ensure your project is correctly configured.

Error Handling Features

• Structured Error Messages: All errors include an error code, description, and suggested solutions
• Categorized Errors: Errors are categorized by type (validation, configuration, environment, build, etc.)
• Actionable Solutions: Each error includes specific steps to resolve the issue
• Documentation Links: Errors link to relevant documentation for more information
• Verbose Mode: Run any command with --verbose for detailed error information

Validation Features

• Configuration Validation: Validates your capsule.config.json against a schema
• Environment Validation: Checks that your development environment is properly set up
• Feature Validation: Validates that required dependencies for native features are installed
• Publishing Validation: Validates your publishing configuration for app stores
• Build Validation: Validates build artifacts before deployment

Using Validation

Run the validation command to check your project:

capsule validate

For specific validation targets:

capsule validate -t native     # Validate native features only
capsule validate -t publishing # Validate publishing pipeline only

Error Codes

Common error codes include:

• INVALID_CONFIG: Configuration validation failed
• MISSING_REQUIRED_FIELD: A required field is missing
• ENVIRONMENT_NOT_SETUP: Development environment not properly configured
• BUILD_FAILED: Build process failed

See the Troubleshooting Guide for a complete list of error codes and solutions.

Development

Building the CLI

npm run build

Running Tests

npm test

Linting

npm run lint

License

MIT