Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

SHOW STRUCTURE

Synopsis

SHOW 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. 1 shows one line per module with element counts. 2 (default) shows documents with their signatures. 3 shows 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):

SHOW STRUCTURE DEPTH 1

Show default structure (documents with signatures, user modules only):

SHOW STRUCTURE

Show structure of a single module:

SHOW STRUCTURE IN MyFirstModule

Show full detail including all modules:

SHOW STRUCTURE DEPTH 3 ALL

See Also

SHOW MODULES, SHOW ENTITIES, SHOW MICROFLOWS, SHOW PAGES