FWH CLI

A CLI tool for installing templates, components, effects, and animations from the Flutter Widget Hub GitHub repository.

Features

• Install Templates: Get complete app templates and UI clones
• Install Components: Access reusable layout components and blocks
• Install Animations: Get smooth, captivating animations
• Install Effects: Access visual effects including shadows, gradients, and transformations
• Category Filtering: Install specific categories (templates, blocks, animations, effects)
• Search Functionality: Search for specific components by name
• Local Storage: Components are saved to your local machine for easy access

Installation

Add this to your pubspec.yaml:

dependencies:
  fwh_cli: ^0.0.1

Then run:

dart pub get

Usage

Basic Usage

import 'package:fwh_cli/fwh_cli.dart';

void main() async {
  final fwhCli = FwhCli();
  
  // Install all components
  await fwhCli.installAll();
  
  // Install specific category
  await fwhCli.installCategory('templates');
  
  // Search and install components
  await fwhCli.searchAndInstall('button');
}

CLI Usage

# Install all components
fwh_cli install all

# Install specific category
fwh_cli install templates
fwh_cli install blocks
fwh_cli install animations
fwh_cli install effects

# Search and install
fwh_cli search button

# List available categories
fwh_cli list categories

# List installed components
fwh_cli list components

Available Categories

🎨 Templates

Complete app templates and UI clones to jumpstart your projects:

• Authentication templates (auth_01 through auth_05)
• App templates (basuu, fruity_lips, nike_zoomer)
• Onboarding templates (doctor, mental_health, online)
• Spotify app template (complete with all screens)

🧱 Blocks

Reusable layout components for consistent and responsive designs:

• Bottom navigation bars (docking_bar)
• Buttons (apple_books_fab)
• Cards
• Tabs (blurred_slide, expandable, liquid_glass, slide)

🎭 Animations

Smooth, captivating animations that enhance user experience:

• Skew card animations
• Custom animated components

✨ Effects

Visual effects including shadows, gradients, and complex transformations:

• Mesh gradient effects (mesh_01, mesh_02)
• Visual effects and meshes

Getting Started

1. Install the package
2. Use the CLI commands or import the library
3. Install the components you need
4. Copy the code to your Flutter project

API Reference

FwhCli

Main class for interacting with Flutter Widget Hub.

Methods

• installAll(): Installs all available components
• installCategory(String category): Installs components from a specific category
• searchAndInstall(String query): Searches and installs matching components
• listCategories(): Lists all available categories
• listComponents(): Lists all installed components

Example

final fwhCli = FwhCli();

// Install all templates
await fwhCli.installCategory('templates');

// Search for button components
await fwhCli.searchAndInstall('button');

ComponentDownloader

Utility class for installing components from GitHub.

Methods

• installFromGitHub(String path): Installs a specific file from GitHub
• installDirectory(String path): Installs an entire directory from GitHub
• getComponentList(): Gets the list of available components

Configuration

The CLI tool connects to the Flutter Widget Hub repository at: https://github.com/yunweneric/flutter-widgethub

Components are installed to a local directory structure that mirrors the repository organization.

Contributing

1. Fork the repository
2. Create a feature branch
3. Make your changes
4. Add tests for your changes
5. Submit a pull request

Issues and Feedback

Please file issues and feature requests on the GitHub repository.

License

This project is licensed under the MIT License - see the LICENSE file for details.

Changelog

See CHANGELOG.md for a list of changes and version history.

Acknowledgments

This CLI tool is built to work with the amazing Flutter Widget Hub project by yunweneric. Thank you for creating such a comprehensive collection of Flutter components!