Skip to main content
The Tokios Connector is a small console app you run on the machine next to your model. It dials out to Tokios over a single WebSocket and forwards requests to your local model — no inbound ports, no public IP, no firewall changes. You install and pair it from the console’s Setup wizard with a one-time claim code. For the basic path you don’t hand-edit a config file — the connector receives its token securely over the tunnel after you approve the device.

​
1. Get a claim code

In the console’s Setup tab, click Start pairing (step 1). Tokios shows a claim code like TKS-XXXX-XXXX, valid for about 15 minutes. Keep the tab open.

​
2. Install and run the connector

On the machine next to your model, run the one-liner the console shows for your OS.
Windows 10 & 11 (x64). In PowerShell:
Already have tokios-connector installed? Skip the installer and pass the claim code directly:

​
3. Approve the device

The connector dials out and appears in the console. In the Setup tab (or the Connectors tab), approve the device. Tokios then delivers the connector’s token over the tunnel — it is never shown on screen or pasted into a file.
The connector only dials out; it never listens on a port, so your firewall needs no inbound rules.
Once it’s connected, register your model and create an API key.

​
Advanced: expose multiple models with a config file

To serve several models through one connector, run the connector with a JSON config that defines each upstream instead of pairing a single model. See Connector Config.

​
What the installer changes on your machine

  • Install directory. The connector binary and its tokios-connector.json live together in ~/.tokios/connector (macOS and Linux) or %LOCALAPPDATA%\Tokios\connector (Windows). Pass --dir / -InstallDir to choose another folder.
  • PATH. On macOS and Linux the installer symlinks the binary into ~/.local/bin and, if that folder is not on your PATH, appends 1 line marked # tokios-connector PATH to your shell profile (.zshrc, .bashrc, or .profile). It never adds the line twice, prints what it did, and the line stays on uninstall because other tools may use the same folder. To undo, delete that line. On Windows it adds the default install folder to your user Path; tokios-install -Uninstall removes it. Pass --no-path / -NoPath to skip all of this.
  • Nothing else. No system services, no sudo, no firewall rules.

​
Run the connector at boot

The installer starts the connector in the foreground, or in the background with --detach / -Detach. Neither survives a reboot. To keep your model reachable after a restart, run the connector under your platform’s service manager. The connector allows 1 running instance per install directory, so stop a detached process first:
~/.config/systemd/user/tokios-connector.service
The connector keeps its pairing in tokios-connector.json, so a service start after a reboot reconnects without a new claim code.