Skip to main content

unitport — UnitPort local helper

Headless daemon that connects a local GPU / Isaac Lab host (workstation or the user's own cloud server) to the UnitPort cloud canvas. The canvas is the remote control (遥控器); this process has no GUI — only terminal output.

Authoritative design: ../knowledges/local_helper_design.md (rulings LH-D1…LH-D6, contracts C10 pairing / C11 control protocol).

What it is (and is not)

  • Is: an outbound-only WebSocket agent exposing a fixed verb set to the cloud (report capabilities, publish an asset index, receive a bundle from the user's own canvas, start/stop a training run, stream telemetry).
  • Is not: a shell, an exec server, or a GUI. The cloud can never send an arbitrary command — only the fixed verbs, only from a paired session of the same account, only bundles that originate from the user's own canvas (least-privilege red line, LH-D4 / C11).

The same binary serves execution target ① (UserServerTarget, user cloud server) and ③ (LocalHelperTarget, local host) — only the host differs (LH-D5).

Install

pip install unitport

Cross-platform (Windows + Linux). Runtime deps: websockets (the live link) and, on Python < 3.11, tomli (TOML reader). Everything else is stdlib.

CLI (headless — everything else is driven remotely from the canvas)

Command Purpose
unitport login Browser-approve device pairing; stores a refreshable helper token
unitport up (serve) Dial out to the cloud relay and serve the fixed verb set
unitport status Connection / run state, paired account, config summary
unitport config Declare Isaac/MuJoCo interpreter paths + resource roots
unitport doctor Fail-loud self-check (interpreters, deps, cloud, token)

There are deliberately no pull / train / push local subcommands — those are remote verbs, triggered from the canvas (C11 §4).

Keep the terminal window open. Before a run from the canvas starts on this machine, and before the canvas changes which programs the helper launches, the helper asks in this window: type y and press Enter to allow it. Anything else, or no answer within 3 minutes, refuses it. A helper started without a terminal (redirected input, a background service) refuses every such request.

Config

  • Config dir: %APPDATA%\unitport\ (Windows) · $XDG_CONFIG_HOME/unitport/ or ~/.config/unitport/ (POSIX). Override with UNITPORT_HOME.
  • config.toml — cloud base URL, engine interpreter paths, resource_roots, workspace dir. Human-editable; also managed by unitport config.
  • token.json — the helper token (secret; chmod 600 on POSIX). Never printed, never logged.
  • device.json — the persistent (non-secret) device_id.

Status

Under active construction (phases LH-P1…LH-P8, Isaac Lab first). See the design doc §12 for the phase map. This tree currently implements the local foundation (config, capability detection, doctor, CLI) plus the pairing/transport clients; the workers/relay Durable Object cloud side lives in ../workers/relay.

Metadata

Release files for unitport 0.0.128

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for unitport 0.0.128
File Size Uploaded Provenance Actions
unitport-0.0.128.tar.gz 907.9 kB Without provenance Details for unitport-0.0.128.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for unitport 0.0.128
File Interpreter ABI Platform Actions
unitport-0.0.128-py3-none-any.whl Python 3 none any Details for unitport-0.0.128-py3-none-any.whl

Total release size: 1.8 MB

Release files / unitport-0.0.128.tar.gz

Download URL unitport-0.0.128.tar.gz
Size 907.9 kB
Tags Source
SHA-256 checksum
How to use checksums
4d1fe0f2dfc1978d9568098a88aa6463fb69fcf029661a02c8eac0a416dcca77
BLAKE2b-256 checksum
How to use checksums
b6cf8e4bcbfa5c7084d9099977efd160be5806395c70d07b14780e6a51214d5f
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.12.7

Release files / unitport-0.0.128-py3-none-any.whl

Download URL unitport-0.0.128-py3-none-any.whl
Size 908.2 kB
Tags Python 3
SHA-256 checksum
How to use checksums
ac3fc6d1716916bafccb95be2c803df0520a128d68cb94e2a2e0e5bec3e8df2a
BLAKE2b-256 checksum
How to use checksums
287e9239684de58a8f959d66e6034c2c988c2540dd8f4d43c9eb46cae1683daf
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.12.7

Security for unitport 0.0.128

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

0.0.128 This release

2 release files No provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page