CLI Reference

← Home

• Synopsis
• Options
• Usage Examples
• Input Validation

---

Synopsis

solarxy [OPTIONS]

Options

Flag	Description	Default	Applies To
-m, --model <PATH>	Path to a model file	--	All modes (optional in view, required in analyze)
-M, --mode <MODE>	Operation mode: view, analyze, preferences, docs	view	--
-f, --format <FORMAT>	Output format: text or json	text	Analyze mode only
-o, --output <PATH>	Write report to file	--	Analyze mode only
--about	Print version and project info	--	--
--help	Print help message	--	--
--version	Print version number	--	--

Usage Examples

# View a model (default mode)
solarxy -m dragon.obj

# Launch the viewer empty -- drag and drop a file onto the window
solarxy

# Analyze a model in the interactive TUI
solarxy -M analyze -m dragon.glb

# Export a text report to a file
solarxy -M analyze -m dragon.glb -o report.txt

# Export a JSON report (auto-named as <model>.json)
solarxy -M analyze -m dragon.glb -f json

# Export a JSON report to a specific file
solarxy -M analyze -m dragon.glb -f json -o analysis.json

# Pipe JSON output to jq for processing
solarxy -M analyze -m dragon.glb -f json | jq .meshes

# Open the preferences editor
solarxy -M preferences

# Open the built-in documentation
solarxy -M docs

# Print version and project info
solarxy --about

Input Validation

The CLI validates your input before proceeding. Here are the messages you may see:

Condition	Message
File does not exist	Model file does not exist: <path>
Path is a directory	Path is not a file: <path>
Unsupported extension	Invalid file extension '.<ext>', expected '.obj', '.stl', '.ply', '.gltf', or '.glb'
No file extension	File has no extension, expected '.obj', '.stl', '.ply', '.gltf', or '.glb'
JSON format outside analyze mode	Error: --format json requires --mode analyze
No model in analyze mode	Model path is required for analyze mode (use -m <path>)

---

See also: Installation · Keyboard Shortcuts · Troubleshooting · User Guide