CLI Guide

The sruja command-line interface is your primary tool for interacting with Sruja projects.

Commands

export

Exports the architecture to various formats.

Usage:

sruja export [format] [file]

Supported Formats:

• markdown: Generates Markdown docs with diagrams.
• mermaid: Generates Mermaid diagram code.
• svg: Exports rendered SVG diagrams.
• json: Exports structured JSON of the architecture.
• d2: Generates D2 diagram code.

Example:

sruja export markdown architecture.sruja
sruja export mermaid architecture.sruja
sruja export svg architecture.sruja
sruja export json architecture.sruja
sruja export d2 architecture.sruja

tree

Displays the architecture structure as a tree in the terminal.

Usage:

sruja tree --file [file]

Options:

• --json: Output as JSON.
• --system [ID]: Show tree for a specific system.

Example:

sruja tree --file architecture.sruja

fmt

Formats the Sruja file to a canonical style.

Usage:

sruja fmt [file]

lint

Validates the Sruja file against rules and best practices.

Usage:

sruja lint [file]