1
Install the Kylon CLI
- macOS/Linux
- Windows
- npm
The standalone installer can provision a private Node.js runtime for Kylon under Update KylonRerun the installer to update Kylon and repair its environment setup, or use
~/.kylon; you do not need to install Node.js separately or use sudo. It can also add Kylon to your shell’s PATH.Install Kylonkylon upgrade for an installed CLI.Installing from a non-production environment? Use that environment’s API origin (for example
https://api.purework.ai/install.sh for dev). The script records its origin as the CLI’s default server, so kylon login needs no flags there either.2
Sign in
The installer starts browser sign-in unless this device already has credentials or you disabled that step. On a machine that already has Kylon, run:In the browser, confirm the code matches the one in your terminal, then approve the device. Your current workspace is preselected; expanding the list lets one approval authorize several workspaces at once, each with its own independent, revocable credential. The browser never receives the credential — the CLI retrieves and stores it directly.
3
Run your first command
kylon onboard; see CLI onboarding.For a workspace you have already authorized, explore its commands:Remote and headless machines
Both install commands work over SSH. Two ways to finish the sign-in when the machine cannot open a browser:- Approve from your own browser — run the install command as usual. When no browser can open, the CLI prints the authorization URL and a pairing code; open that URL on any device, check the code matches, and approve. The remote CLI picks the credential up itself.
- Use a setup token — install with
KYLON_INSTALL_NO_LOGIN=1, then paste the single-use setup-token command from Settings → Developer tools → Kylon CLI — the Advanced section on the web, or Sign in a remote machine in the desktop app — (generated on your own machine, expires in 30 minutes) into the remote shell. It authorizes the device with no browser step at all.
Good to know
- Verified downloads — the installer checks the CLI package’s integrity hash from the npm registry and, when it provisions Node.js, the official
SHASUMS256manifest. - macOS/Linux: works without Node.js — a machine without Node.js 22.15+ gets a private, checksum-verified runtime under
~/.kylon/runtimethat only Kylon uses. It never changes whichnodeyour own shell resolves. - Rerunning the installer repairs shell setup and interrupted installation, updates Kylon, and skips sign-in when the device already has credentials.
Script options
Uninstall
Remove this device from Settings → Developer tools → Kylon CLI → Authorized devices in each workspace where it is authorized. Stop and clear the local runtime connections before deleting the installation:PATH block it added:
PATH line lives between the # >>> kylon >>> markers in your shell profile, or in ~/.config/fish/conf.d/kylon.fish.)