Skip to main content
xkat-cli is the command-line package for xkat. One command (xkat) provides two tools — do not mix them up:

Download page

Desktop apps and xkat-cli install on xkat.space/download

View on npm

xkat-cli on the npm registry

​
Install

Requirements: Node.js 18+ (global install). For OS-specific host setup, see Local Environment Setup. The xkat Desktop app can also run the same commands from the Tools menu (uses a local or monorepo agent binary). You still need Lab tools prepared once via xkat lab install (or Tools → Lab: Install).

​
1) Agent — local bridge

By default, the Dynamic Workspace can run on xkat cloud. With the Agent, the browser connects to your machine instead — local shell, your tools, real-time file sync.

​
What it does

Local shell bridge

Web IDE terminal ↔ native shell (PTY) on this PC, with your user permissions.

Real-time file sync

Watches your working directory and syncs changes to the web dashboard.

Localhost only

Listens on 127.0.0.1:10022 and checks request origin.

Background process

xkat up starts the agent and returns immediately.

​
Commands

Or without a global install:

​
Quickstart

1

Start the agent

2

Open the workspace

In the browser, use lessons that run on My computer / local bridge.
3

Stop when done

​
Security

  • Localhost only — the port is not exposed to the network.
  • Origin verification — only official xkat domains can connect.
  • Audit log — ~/.xkat/agent.log
Best for: CLI tools on your host (e.g. bash, vercel-cli), using your own files and environment.

​
2) Lab — Ubuntu practice environment

Some courses (Linux, networking, agents such as Hermes) should not run directly on your host. Lab gives every learner the same Ubuntu 24.04 environment. You do not need to configure VirtualBox, Hyper-V, or similar yourself — use only xkat lab commands.

​
What it does

Isolated Ubuntu

Fixed Ubuntu 24.04 LTS cloud image — consistent across Windows, macOS, and Linux.

One-time prepare

xkat lab install sets up Lab tools (may ask for admin permission).

Simple lifecycle

up · shell · stop · delete — no hypervisor UI to learn.

Clean finish

xkat lab delete removes the practice environment and frees disk.

​
Commands

​
Typical lecture flow

1

Prepare once

Accept admin prompts if asked. You are not configuring a VM by hand.
2

Start Lab

First run may download Ubuntu (progress is shown in the terminal).
3

Follow the lecture

4

When finished

​
Agent vs Lab (do not mix)

​
Desktop app

Install the desktop app from Download. Installers are versioned (…/desktop/v{version}/…) so the file matches the version on the page. In the desktop title bar, Tools can run the same Agent / Lab commands against a local xkat-cli binary (monorepo build or future bundled binary). Interactive Lab: Open Shell opens a system terminal. Desktop login uses the system browser → auth-bridge → xkat:// deep link, then the app opens https://xkat.space/api/auth/desktop/complete (not localhost).

​
How this relates to the cloud workspace

The browser Dynamic Workspace is the same; only where code runs changes.

​
More