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
Project Handoffs: When transferring project ownership
Team Onboarding: Introducing new developers to project structure
Architecture Review: Evaluating current project setup
Debugging: Understanding project configuration during troubleshooting
Documentation: Generating project overview for documentation
π§ Integration Tips
CI/CD Validation: Include in build scripts to verify project setup
Development Workflow: Regular check during development phases
Code Reviews: Reference during architectural discussions
Project Planning: Use insights for future architectural decisions
π Team Usage
Standup Reports: Quick project status for team updates
Architecture Discussions: Reference template capabilities and limitations
Code Standards: Align development practices with template conventions
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 creationcreation_version: Gexd version at project creation timecurrent_version: Latest compatible Gexd versiongenerated_date: ISO timestamp of project creationlast_updated: Last significant update timestampproject_name: Configured project identifiertemplate: 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
π Related Commands
π Complementary Commands
gexd info template- Explore template structuresgexd create- Create new projects with templatesgexd upgrade- Update project to latest Gexd version
π οΈ Development Commands
gexd make- Generate components following architecturegexd locale generate- Manage internationalization
Generated automatically by gexd_doc
Last updated