Config

📝 Description

Show current project configuration and details. The config command displays comprehensive information about your Gexd project including template type, creation details, version information, and project structure overview.

⚙️ Usage

gexd info config

📖 Detailed Usage

Show current project configuration

Usage: gexd info config

Displays information about the current Gexd project including:
- Project name and template type
- Creation and update dates  
- Gexd version information
- Project location
- Template description and recommendations

Examples:
  gexd info config                    # Show project configuration

🎯 Key Features

📊 Project Information

  • Project Name: Display the project's configured name

  • Template Type: Show which architecture template is used (GetX/Clean)

  • Project Location: Full path to the project directory

  • Organization: Project package organization details

🕒 Version & Timing

  • Creation Version: Gexd version used to create the project

  • Current Version: Current Gexd version compatibility

  • Creation Date: When the project was initially generated

  • Last Updated: Most recent modification timestamp

📖 Template Context

  • Template Description: Detailed explanation of the chosen architecture

  • Best Use Cases: Recommended scenarios for the template

  • Key Features: Architecture-specific capabilities and benefits

  • Related Commands: Suggested next steps and related operations

📊 Output Structure

The command provides a beautifully formatted output with the following sections:

📄 Project Configuration

📄 Project Configuration
━━━━━━━━━━━━━━━━━━━━━━━━━

🏗️  Template: clean
📝  Project: my_flutter_app  
📍  Location: /Users/developer/projects/my_flutter_app

⚙️  Generated By: Gexd CLI
📦  Creation Version: 1.0.0
🔄  Current Version: 1.0.0

🕒  Created: 2025-11-12
📅  Last Updated: Never

📖 Template Information

📖 Template Information
━━━━━━━━━━━━━━━━━━━━━━━━━
Description: Clean Architecture with domain-driven design principles
Best For: Enterprise applications, complex business logic, scalable architecture
Features: Layered architecture, dependency inversion, testability

💡 Run gexd info template clean --full to see the complete directory structure.

🚀 Real-World Usage Examples

📱 Project Status Check

# Quick project overview for team standup
gexd info config

# Output provides instant context:
# - What template/architecture is used
# - When project was created
# - Current development status

🔍 Troubleshooting Project Issues

# When debugging, check project configuration
gexd info config

# Helps identify:
# - Version compatibility issues
# - Template-specific structure problems
# - Project initialization status

📚 Onboarding New Developers

# New team member exploring project
gexd info config

# Provides instant understanding of:
# - Project architecture approach
# - Setup timeline and version
# - Template-specific conventions

🔧 Development Environment Setup

# After cloning a repository
cd cloned_gexd_project
gexd info config

# Verifies:
# - Correct Gexd project detection
# - Template compatibility
# - Development environment requirements

🎯 Template-Specific Information

🏗️ GetX Template Projects

When run on a GetX template project:

🏗️  Template: getx
📖 Template Information
━━━━━━━━━━━━━━━━━━━━━━━━━
Description: GetX modular architecture with feature-based organization
Best For: Rapid development, medium-sized apps, GetX enthusiasts
Features: Reactive state management, dependency injection, routing

Key Insights:

  • Modular Organization: Feature-based directory structure

  • State Management: Built-in GetX reactive patterns

  • Rapid Development: Optimized for quick prototyping and iteration

🏛️ Clean Architecture Projects

When run on a Clean Architecture project:

🏗️  Template: clean
📖 Template Information
━━━━━━━━━━━━━━━━━━━━━━━━━
Description: Clean Architecture with domain-driven design principles
Best For: Enterprise applications, complex business logic, scalable architecture
Features: Layered architecture, dependency inversion, testability

Key Insights:

  • Layered Structure: Clear separation between domain, data, and presentation

  • Enterprise Ready: Designed for large, complex applications

  • High Testability: Architecture optimized for unit and integration testing

💡 Best Practices

🎯 When to Use

  1. Project Handoffs: When transferring project ownership

  2. Team Onboarding: Introducing new developers to project structure

  3. Architecture Review: Evaluating current project setup

  4. Debugging: Understanding project configuration during troubleshooting

  5. Documentation: Generating project overview for documentation

🔧 Integration Tips

  1. CI/CD Validation: Include in build scripts to verify project setup

  2. Development Workflow: Regular check during development phases

  3. Code Reviews: Reference during architectural discussions

  4. Project Planning: Use insights for future architectural decisions

📊 Team Usage

  1. Standup Reports: Quick project status for team updates

  2. Architecture Discussions: Reference template capabilities and limitations

  3. Code Standards: Align development practices with template conventions

  4. Project Documentation: Generate consistent project overviews

🔍 Configuration File Details

The command reads from .gexd/config.yaml which contains:

📋 Configuration Structure

# Generation Details
generated_by: Gexd CLI
creation_version: 1.0.0
current_version: 1.0.0
generated_date: 2025-11-12
last_updated: null

# Project Information  
project_name: my_flutter_app
template: clean

🔧 Configuration Fields

  • generated_by: Tool used for project creation

  • creation_version: Gexd version at project creation time

  • current_version: Latest compatible Gexd version

  • generated_date: ISO timestamp of project creation

  • last_updated: Last significant update timestamp

  • project_name: Configured project identifier

  • template: Architecture template key (getx|clean)

❓ Troubleshooting

Common Issues

❌ "Not inside a valid Gexd project"

# Problem: Command run outside Gexd project
cd /some/random/directory
gexd info config

# ✅ Solution: Navigate to Gexd project directory
cd your_gexd_project
gexd info config

❌ "Project configuration file not found"

# Problem: Missing .gexd/config.yaml file
gexd info config
# Error: Project configuration file not found.

# ✅ Solution: Verify project integrity or reinitialize
ls -la .gexd/  # Check if config.yaml exists
# If missing, may need to reinitialize project

❌ "Error reading project configuration"

# Problem: Corrupted YAML file
gexd info config  
# Error: Error reading project configuration: Invalid YAML

# ✅ Solution: Validate YAML syntax
cat .gexd/config.yaml  # Check file contents
# Fix YAML syntax errors or restore from backup

🔧 Advanced Troubleshooting

Version Mismatch Issues

If creation and current versions differ significantly:

# Check version compatibility
gexd info config

# Consider upgrading project if needed
gexd upgrade

Template Validation

# Verify template structure matches configuration
gexd info config
gexd info template clean --full  # Compare with expected structure

🚀 Integration with Development Workflow

📋 Project Setup Checklist

# 1. Verify project configuration
gexd info config

# 2. Understand architecture
gexd info template clean --full

# 3. Begin development with proper context
gexd make screen Home

🔄 Regular Development Workflow

# Morning routine: Check project status
gexd info config

# Development: Generate components aligned with architecture
gexd make model User --file assets/user.json
gexd make screen UserProfile

# End of day: Verify project state
gexd info config

📚 Related Commands

🔗 Complementary Commands

🛠️ Development Commands

Generated automatically by gexd_doc

PreviousInfoNextTemplate

Last updated