Orbit Help
Getting Started
1. Configure: Create orbit.yml with your machine_id and scan_roots
2. Scan: orbit scan --config orbit.yml --output shared/
3. Push: orbit push --server http://your-server:4319 --token <token>
4. Assess: orbit assess --path /path/to/project
Configuration (orbit.yml)
machine_id: my-laptop
scan_roots:
- path: C:\dev
mode: dedicated
depth: 2
CLI Commands
orbit scan — Scan local projects, compute health scores, export JSON
orbit push — Upload scan results to the central Orbit server
orbit assess — Run AI commercial analysis on a project (needs ANTHROPIC_API_KEY)
orbit status — Show project health in terminal
orbit api — Start the API server locally
Environment Variables
ANTHROPIC_API_KEY — Required for orbit assess
ORBIT_API_TOKEN — API authentication token
ORBIT_DASHBOARD_PASSWORD — Dashboard login password
Health Score (0-100)
- Freshness (30pts): How recently code was committed
- Documentation (30pts): README, BACKLOG, CI, infra configs
- Hygiene (20pts): Clean git state, CI passing
- Tasks (20pts): Completion percentage of tracked tasks
Commercial Assessment Fields
- Score: Overall commercial viability (0-100)
- Stage: idea → prototype → mvp → launched → mature
- Priority: low / medium / high / critical
- Market: niche / small / medium / large
- ARR Potential: Estimated annual revenue range