Quick Reference

Goal Command / Path Notes
Format everything cargo fmt --all Run before sending PRs; CI enforces formatting.
Run focused viewer tests cargo test -p orbitron-ui-shell --lib viewer_state::tests::start_new_session_uses_truly_empty_scene Useful when iterating on backbone/viewer interactions.
Launch viewer from workspace root cargo run --release -p orbitron-cli --features gui -- view fixtures/benzene.xyz Mirrors the user workflow in the User Guide (§3 Graphical Viewer).
GUI smoke test ORBITRON_AUTOCLOSE_MS=200 cargo test -p orbitron-cli --features gui --test view Opens the desktop viewer in a blank session and auto-closes after ~200 ms.
TUI smoke test ORBITRON_TUI_AUTOCLOSE=1 cargo test -p orbitron-cli --features tui --test view Loads the terminal UI with an empty scene and exits immediately (CI-friendly).
TUI render benchmark cargo bench -p orbitron-tui --bench render Profiles ASCII glyph/bond rendering via Criterion (density vs. bonds).
Build Python bridge cd extensions/python-bridge && maturin develop Ensure the orbitron-dev environment is active.
Verify remote access orbitron --remote [user@]host:/root fs list Confirm plain ssh <host> works first; the same config/agent/2FA apply.
Inspect selection engine cargo run -p orbitron-cli -- select "element C and within_atom(1, 3.0)" -s fixtures/benzene.xyz Uses the query stack described in §5.2.
Generate release bundle (macOS) bash scripts/build-macos-release.sh (or see scripts/BUILD_RELEASE.md) Wraps the steps in Packaging & Distribution.

Smoke Test Checklist (Pre-release)

  • cargo run --release -p orbitron-cli --bin orbitron -- info io/pipelines/tests/fixtures/xyz/water.xyz --json
  • cargo run --release -p orbitron-cli --bin orbitron -- analyze geometry fixtures/benzene.xyz --json
  • cargo run --release -p orbitron-cli --features gui --bin orbitron -- view --blank
  • cargo run --release -p orbitron-cli --features gui --bin orbitron -- view io/pipelines/tests/fixtures/xyz/water.xyz
  • cargo run --release -p orbitron-cli --bin orbitron -- render --output smoke.png io/pipelines/tests/fixtures/xyz/water.xyz
  • TUI (manual): cargo run --release -p orbitron-tui io/pipelines/tests/fixtures/xyz/water.xyz