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.

• Next step: Prerequisites
• Then: Workspace & Repos → Devstack Setup

2) Install Options (Offline / Online)¶

Model packs are experimental, versioned additions to the development stack.

• 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.

• Bring-up and profiles: Devstack Setup

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¶

There is no supported installation yet. Ubuntu 24.04 LTS on x86-64 UEFI hardware is the first native support candidate.

The candidate contract lives in unison-platform and centers on the native installer, unisonctl, compose/compose.supported.yaml, digest-pinned image inputs, and the deterministic release manifest.

The current platform release publishes one native x86-64 unsupported preview. WSL2 remains useful for development, but current releases do not publish WSL, VM, or ISO images.

• How builds/releases are orchestrated: Build, Deploy, and Images
• Image types + local reproduction commands: Images, Builds, and Releases

8) Testing¶

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

• Details: Testing

9) Hardware Deployment¶

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

• Details: Hardware Deployment

10) Releases¶

Release docs should be read with one priority in mind:

• current Ubuntu native preview and its verification evidence first

• historical evaluator artifacts only as archived engineering context

• Start here: Releases