Skip to main content

UnitPort local helper 鈥?headless daemon bridging local Isaac Lab / MuJoCo / resources to the UnitPort cloud canvas.

Project description

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

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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

unitport-0.0.17.tar.gz (88.1 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

unitport-0.0.17-py3-none-any.whl (80.3 kB view details)

Uploaded Python 3

File details

Details for the file unitport-0.0.17.tar.gz.

File metadata

  • Download URL: unitport-0.0.17.tar.gz
  • Upload date:
  • Size: 88.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.7

File hashes

Hashes for unitport-0.0.17.tar.gz
Algorithm Hash digest
SHA256 b3a50bf67e87b3ac9fe4b65ff6625b8c833a57645864f06acb992993c5bad79f
MD5 6280f45a2239e6ee2dcb7f342c52e1c4
BLAKE2b-256 f4e108bfc7624592160f4b7557f029be9f980f2c6c6aec07e502960096ca2f24

See more details on using hashes here.

File details

Details for the file unitport-0.0.17-py3-none-any.whl.

File metadata

  • Download URL: unitport-0.0.17-py3-none-any.whl
  • Upload date:
  • Size: 80.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.7

File hashes

Hashes for unitport-0.0.17-py3-none-any.whl
Algorithm Hash digest
SHA256 c1b7eb96872355d6acc43125f6eafbf66d2a1784e520630f8251c2ea3fa1c582
MD5 9f0d83c719c89b61e9cc5ecca4ea4965
BLAKE2b-256 0f861441d78c679b116a3f43f63ce199eda54c15a7c041a522d648eb84fc0ccb

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page