User guide

User Guide

Demo Path

For a clean first look, follow demo walkthrough. For a route-by-route view of the current UI, see UI feature map.

Short path:

1. Start Docker Compose and complete first-run setup.
2. Upload one STL/3MF and one G-code file.
3. Open the model detail page to show metadata, thumbnails, revisions, and the mesh viewer.
4. Add a Moonraker printer or open provider diagnostics to show capability checks.
5. Export metadata from Settings as JSON or CSV.

Current UI Workflows

Area	Current workflows
Vault	Browse models in grid/list view; search by name/metadata; filter by collection, tag, printer, or printer presence; sort; create collections; drag models between collections; upload mesh/G-code files with collection and tag assignment.
Uploads	Upload STL/3MF/OBJ, G-code, or mesh+G-code together; override model name; create tags inline; track background ingestion through task notifications.
Model detail	Inspect source files, recommended G-code, print settings, mesh metadata, thumbnails, and printer presence from one screen.
Viewers	Switch between 3D model and G-code toolpath view; use solid, X-ray, and wireframe display modes; fit, zoom, reset, screenshot, and build-plate grid controls.
Revisions	Add G-code revisions; mark known-good/needs-test/failed/archived; add labels and notes; choose the recommended revision; compare two revisions side by side.
Print history	Manually log completed/failed jobs and import matching Moonraker history for known G-code files.
Printers	Manage Moonraker/Klipper and beta Bambu LAN printers; view live status, temperatures, current print, progress, jobs, diagnostics, and provider capability checks.
Printer files	Sync Moonraker remote file inventory, match remote files back to vault models, and start supported remote files from the UI.
Profiles	Manage filament presets with cost/kg and printer presets with nozzle/profile metadata; see live usage counts from indexed files.
Settings	Export JSON/CSV metadata, manage API keys, configure storage/backups, choose card metrics and metadata visibility, restore or purge trash, and view version history.

Known rough spots live in known limitations.

OrcaSlicer Hook

The hook is one Python file, stdlib only, and exits 0 even if the vault is offline so it never breaks a slice/export.

# OrcaSlicer -> Print Settings -> Advanced -> Post-processing Scripts
/usr/bin/python3 /path/to/PrintStash/scripts/printstash_orca_push.py \
  --url http://your-printstash-host:8000 \
  --username YOUR_USERNAME \
  --password YOUR_PASSWORD \
  --category "Functional/Brackets"

After that, exported G-code is pushed into PrintStash automatically.