Developer Onboarding

This page consolidates the developer onboarding flow. Use it as the default path; follow the linked pages for deeper details when needed.

1) Get Started

Recommended path: run the devstack locally (WSL2 or Linux) and iterate against real services.

2) Install Options (Offline / Online)

Phase 1.1 supports a lean base install plus post-install model packs.

  • Offline model packs: unison-models install --path /path/to/pack.tgz
  • Online model packs: unison-models install --fetch https://…/pack.tgz
  • Details: Install Options and Model Packs

3) Prerequisites

Unison is developed and tested primarily on Ubuntu (native or under WSL2).

  • OS: Ubuntu 22.04/24.04 (or Windows 11 + WSL2)
  • Tools: Docker (Compose v2), Python 3.10+ (3.12 recommended), Node.js 18+, Git, make
  • Details: Prerequisites

4) Workspace & Repos

The recommended workflow is the workspace meta-repo (submodules) so versions stay aligned.

  • Bootstrap: ./scripts/bootstrap.sh
  • Start devstack: ./scripts/up.sh (ports) or ./scripts/up-security.sh (no host ports)
  • Smoke test: ./scripts/smoke.sh (or ./scripts/smoke-security.sh)
  • Details: Workspace & Repos

5) Devstack Setup

Devstack is the canonical local wiring of the core control plane, renderer, inference, and backing services.

6) Renderer

The experience renderer is the primary “surface” during development and evaluation.

  • How to run and connect surfaces: Renderer

7) Build, Deploy, and Images

For the current Milestone 1 production-track release, the supported installation route is Ubuntu 24.04 native on x86_64.

The concrete platform-side contract for that route lives in unison-platform and centers on install-native.sh, unisonctl, .env.native.template, and compose/compose.native.yaml.

Platform releases may also publish evaluator artifacts for WSL2, Linux VM, and bare metal, but those are secondary to the canonical native install path.

8) Testing

Start with the smallest test that covers your change (unit), then expand to integration/smoke as needed.

9) Hardware Deployment

Use the hardware guidance when you’re validating device installs, networking, and ports on real machines.

10) Releases

Release docs should be read with one priority in mind: - supported route first: Ubuntu native - evaluator artifacts second: WSL2, Linux VM, bare metal