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

πŸ“– Template Information


πŸš€ Real-World Usage Examples

πŸ“± Project Status Check

πŸ” Troubleshooting Project Issues

πŸ“š Onboarding New Developers

πŸ”§ Development Environment Setup


🎯 Template-Specific Information

πŸ—οΈ GetX Template Projects

When run on a GetX template project:

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:

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

πŸ”§ 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"

❌ "Project configuration file not found"

❌ "Error reading project configuration"

πŸ”§ Advanced Troubleshooting

Version Mismatch Issues

If creation and current versions differ significantly:

Template Validation


πŸš€ Integration with Development Workflow

πŸ“‹ Project Setup Checklist

πŸ”„ Regular Development Workflow


πŸ”— Complementary Commands

πŸ› οΈ Development Commands

  • gexd make - Generate components following architecture

  • gexd locale generate - Manage internationalization


Generated automatically by gexd_doc

Last updated