What it does
Local shell bridge
Connects the web IDE terminal directly to a native shell (PTY) on your machine,
with your own user permissions.
Real-time file sync
Watches your local working directory and syncs changes with the web dashboard
instantly.
Zero install
Run it on demand with
npx — no separate installation required.Security-first
Binds to
127.0.0.1 only and verifies the request origin so local
control stays safe.Quickstart
Run instantly with npx — no install needed:up starts the agent in the background and returns immediately, so your terminal
stays free.
Install globally (optional)
If you use it often, install it once:View on npm
xkat-cli on the npm registry
Requirements
- Node.js 16 or newer.
Security
The agent is designed to keep local control safe:- Localhost only — its port is reachable only from your machine.
- Origin verification — only connections from official xKat domains are accepted.
- Audit log — every connection attempt and file-change event is recorded
locally (
~/.xkat/agent.log).
How it relates to the cloud workspace
| Cloud workspace | Local machine (CLI) | |
|---|---|---|
| Setup | Zero-setup | npx xkat up |
| Runs on | xKat cloud servers | Your computer |
| Best for | Quick start, any device | Using your own tools, files, and environment |