Project Structure — Aquilia Documentation
Comprehensive guide and documentation for Project Structure in the Aquilia framework. View API reference, examples, and implementation patterns.
Project Structure File layout, conventions, and generated artifacts Standard Workspace Layout A workspace created with aq init workspace my-api produces the following structure. Every directory and file has a specific purpose: Key Files Explained workspace.py The root configuration file. Aquilia's ConfigLoader looks for this file first (Python-first config). It must export a workspace variable containing the Workspace configuration object. .env Environment variables with the AQ_ prefix are automatically loaded. Nested keys use double underscores. Higher priority than config files but lower than CLI arguments. Module Conventions Each module directory follows conventions that Module.auto_discover() uses to find components: File Discovery Scans For Registration ))} The .aquilia/ Trace Directory The .aquilia/ directory is automatically generated at boot/runtime and contains diagnostic artifacts, credentials, caches, and logs. It should be added to .gitignore: File Contents ))} Use aq inspect to query trace artifacts from the command line, or use aq trace for interactive exploration. CLI-Generated Files The aq CLI generates various files. Understanding where they go: Command Generates , , , , , , , ].map(( , i) => ( ))} Next Steps → Workspace Builder: All configuration options → Controllers: Writing request handlers → CLI Reference: All commands in detail )
Go to Homepage