Skip to content

InstallInfo

View as Markdown

Defined in: client/src/client.ts:40

GET <base>/machines/install (hub only): the commands that connect a computer.

Property Type Description Defined in
connectUrl? string uncage://connect?url=<setup url>: connects a computer that already runs Uncage in one click (the OS hands it to the installed agent). Absent on hubs that do not offer it. client/src/client.ts:51
install string Installs the Uncage CLI (macOS / Linux). client/src/client.ts:42
setup string uncage setup <url>: pairs the computer with this website and starts the agent. client/src/client.ts:44
windows string | null Windows install command; null when the hub serves no Windows installer (custom clients). client/src/client.ts:46