DESCRIBE STRUCTURE
Synopsis
DESCRIBE STRUCTURE [DEPTH 1|2|3] [IN <module>] [ALL]
Description
Shows a hierarchical overview of the project structure. The output depth and scope can be controlled with optional clauses. By default, displays depth 2 (documents with signatures) for user modules only, excluding system and marketplace modules.
This is useful for getting a quick birds-eye view of what a project contains without examining each element individually.
Parameters
- DEPTH
- Controls the level of detail in the output.
1shows one line per module with element counts.2(default) shows documents with their signatures.3shows full detail including typed attributes and named parameters. - module
- When
IN <module>is specified, restricts output to a single module. Implicitly uses depth 2 unless overridden. - ALL
- Include system and marketplace modules in the output. Without this flag, only user-created modules are shown.
Examples
Show module-level summary (one line per module):
DESCRIBE STRUCTURE DEPTH 1;
Show default structure (documents with signatures, user modules only):
DESCRIBE STRUCTURE;
Describe structure of a single module:
DESCRIBE STRUCTURE IN MyFirstModule;
Show full detail including all modules:
DESCRIBE STRUCTURE DEPTH 3 ALL;