> For the complete documentation index, see [llms.txt](https://gexd.gitbook.io/gexd-docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://gexd.gitbook.io/gexd-docs/gexd-documentation/readme.md).

# Introduction

<div align="center"><img src="https://github.com/altwaireb/gexd/raw/main/assets/logos/icon_with_text/svg/logo.svg" alt="GEXD Logo" width="80"></div>

{% hint style="success" %}
**Welcome to GEXD!** A powerful Flutter project generator for clean architecture.
{% endhint %}

GEXD is a comprehensive Flutter project scaffolding tool that helps you create scalable applications using the **GetX pattern** with **clean architecture principles**. Generate complete project structures with predefined templates, manage configurations, and maintain consistent code organization.

## ✨ What is GEXD?

GEXD (GetX Development) is a CLI tool that automates the creation of Flutter projects with:

* **Clean Architecture** structure
* **GetX State Management** integration
* **Predefined Templates** for rapid development
* **Configuration Management** for project settings
* **Best Practices** enforcement

***

## 🚀 Quick Start

```bash
# Install GEXD globally (Using Dart)
dart pub global activate gexd

# Alternative: Install using Flutter  
flutter pub global activate gexd

# Create a new project
gexd create my_app

# Get help
gexd --help
```

***

## 📋 Available Commands

### Project Commands

* [**Create**](/gexd-docs/project-commands/create_command.md) - Create a new Flutter project using gexd templates
* [**Init**](/gexd-docs/project-commands/init_command.md) - Initialize an existing Flutter project with gexd structure
* [**Add**](/gexd-docs/project-commands/add_command.md) - Add packages to your Flutter project
* [**Remove**](/gexd-docs/project-commands/remove_command.md) - Remove packages from your Flutter project
* [**Upgrade**](/gexd-docs/project-commands/upgrade_command.md) - Upgrade packages in your Flutter project
* [**Self-update**](/gexd-docs/project-commands/self_update_command.md) - Update gexd CLI tool to the latest version

### Information Commands

* [**Info**](/gexd-docs/information-commands/info_command.md) - Display project and template information
* [**Config**](/gexd-docs/information-commands/info_command/config_command.md) - Show current project configuration
* [**Template**](/gexd-docs/information-commands/info_command/template_command.md) - Display template information and structure

### Localization Commands

* [**Locale**](/gexd-docs/localization-commands/locale_command.md) - Manage GetX locale translations
* [**Generate**](/gexd-docs/localization-commands/generate_command.md) - Generate locale files from JSON

### Component Generation Commands

* [**Make**](/gexd-docs/make-commands/make_command.md) - Generate various project files and components
* [**Binding**](/gexd-docs/make-commands/make_command/binding_command.md) - Generate binding files for dependency injection
* [**Controller**](/gexd-docs/make-commands/make_command/controller_command.md) - Generate controller files for state management
* [**View**](/gexd-docs/make-commands/make_command/view_command.md) - Generate view files for UI components
* [**Widget**](/gexd-docs/make-commands/make_command/widget_command.md) - Generate reusable Flutter widgets
* [**Screen**](/gexd-docs/make-commands/make_command/screen_command.md) - Generate complete screen with controller and view
* [**Service**](/gexd-docs/make-commands/make_command/service_command.md) - Generate service files for business logic
* [**Repository**](/gexd-docs/make-commands/make_command/repository_command.md) - Generate repository files for data access
* [**Provider**](/gexd-docs/make-commands/make_command/provider_command.md) - Generate provider files for data providers
* [**Model**](/gexd-docs/make-commands/make_command/model_command.md) - Generate model files for data structures
* [**Entity**](/gexd-docs/make-commands/make_command/entity_command.md) - Generate domain entities for Clean Architecture
* [**Interface**](/gexd-docs/make-commands/make_command/interface_command.md) - Generate interface files for abstractions
* [**Util**](/gexd-docs/make-commands/make_command/util_command.md) - Generate utility helper classes
* [**Constant**](/gexd-docs/make-commands/make_command/constant_command.md) - Generate constant files
* [**Exception**](/gexd-docs/make-commands/make_command/exception_command.md) - Generate custom exception classes
* [**Middleware**](/gexd-docs/make-commands/make_command/middleware_command.md) - Generate middleware files for routing

***

## ✨ Features

* 🏗️ **Clean Architecture** - Well-structured project templates
* 🎨 **GetX Integration** - State management and routing
* 📱 **Flutter Ready** - Mobile-first development
* ⚡ **Fast Setup** - Get started in seconds
* 🛠️ **Customizable** - Flexible project configuration

***

## 📖 Navigation

Use the sidebar to explore detailed documentation for each command. Each command page includes usage examples, available options, and practical guides.

*This documentation is generated automatically by `gexd_doc`*