Info


πŸ“ Description

Display project and template information. The info command provides comprehensive information about your current Gexd project and available templates, helping you understand your project structure and explore different architectural options.


βš™οΈ Usage

gexd info <subcommand> [arguments] [options]

πŸ“š Available Subcommands

πŸ”§ Project Information

Description: Show current project configuration and details

gexd info config                    # Display project configuration

Features:

  • πŸ“„ Project name and template information

  • πŸ“ Project location and paths

  • πŸ•’ Creation and update timestamps

  • πŸ“¦ Gexd version information

  • πŸ“– Template description and best practices


πŸ—οΈ Template Information

Description: Display template information and directory structure

gexd info template                  # List all available templates
gexd info template clean            # Show clean template details
gexd info template clean --full     # Show complete directory structure

Features:

  • πŸ›οΈ Complete template overview

  • πŸ“ Directory structure visualization

  • πŸ“– Detailed architecture descriptions

  • ✨ Key features and best practices

  • 🎯 Usage recommendations


πŸš€ Common Usage Patterns

πŸ“Š Project Analysis

# Check current project details
gexd info config

# Understand project architecture
gexd info template clean --full

πŸ” Template Exploration

# Explore all available templates
gexd info template

# Compare template features
gexd info template getx
gexd info template clean

# See complete structure before choosing
gexd info template getx --full
gexd info template clean --full

πŸ’‘ Development Workflow

# 1. Check current project setup
gexd info config

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

# 3. Explore alternative templates
gexd info template getx

# 4. Make informed architectural decisions

🎯 Use Cases

For New Developers

  • πŸ“š Learn Architecture: Understand Clean Architecture and GetX patterns

  • πŸ—οΈ Explore Structure: See how projects are organized

  • πŸ’‘ Best Practices: Learn recommended approaches

For Project Teams

  • πŸ“Š Project Overview: Quick project information sharing

  • πŸ” Template Comparison: Choose the right architecture

  • πŸ“– Documentation: Generate project structure documentation

For Experienced Developers

  • ⚑ Quick Reference: Fast access to project details

  • πŸ”§ Template Analysis: Evaluate architectural decisions

  • πŸ“ Structure Planning: Plan component organization


πŸ’‘ Pro Tips

🎯 Best Practices

  1. Regular Check-ins: Run gexd info config to verify project status

  2. Template Research: Use --full flag for detailed structure analysis

  3. Team Sharing: Share template information with team members

  4. Architecture Planning: Compare templates before starting new projects

πŸš€ Efficiency Tips

  1. Quick Overview: Use without arguments for general information

  2. Detailed Analysis: Add --full for comprehensive structure view

  3. Template Comparison: Check multiple templates before deciding

  4. Project Validation: Verify you're in the right project directory


πŸ”§ Integration with Other Commands

Project Creation Workflow

# 1. Explore templates
gexd info template

# 2. Get detailed template information
gexd info template clean --full

# 3. Create project with chosen template
gexd create my_project --template clean

# 4. Verify project configuration
cd my_project && gexd info config

Development Workflow

# Check project status
gexd info config

# Understand architecture for new components
gexd info template clean --full

# Generate components following the architecture
gexd make screen UserProfile
gexd make model User --file assets/user.json

πŸ“– Output Examples

Project Configuration Output

πŸ“„ Project Configuration
━━━━━━━━━━━━━━━━━━━━━━━━━

πŸ—οΈ  Template: clean
πŸ“  Project: my_flutter_app
πŸ“  Location: /path/to/project

βš™οΈ  Generated By: Gexd CLI
πŸ“¦  Creation Version: 1.0.0
πŸ”„  Current Version: 1.0.0

πŸ•’  Created: 2025-11-12
πŸ“…  Last Updated: Never

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

Template Information Output

πŸ—οΈ Available Templates
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

πŸ“ GetX Standard Architecture (getx)
   Description: Feature-based modular architecture...
   Best For: Rapid development, medium-sized apps

πŸ“ Clean Architecture (clean)
   Description: Domain-driven design with clear separation...
   Best For: Enterprise applications, complex business logic

Template Guides

Command References


❓ Troubleshooting

Common Issues

Issue: "Not inside a valid Gexd project"

# βœ… Solution: Run from within a Gexd project directory
cd your_gexd_project
gexd info config

Issue: Command not found

# βœ… Solution: Update to latest Gexd version
gexd self-update

Issue: Template not recognized

# βœ… Solution: Check available templates
gexd info template

Generated automatically by gexd_doc

Last updated