The Kylon CLI (kylon) is a command-line tool with two jobs. It keeps an Agent you brought connected to Kylon through a background service. It also gives you kylon workspace commands to read and update Workspace resources, such as Rooms, files and Apps, from a terminal. You do not need it for everyday work in Kylon, and you do not need to install it yourself to bring an Agent, because the connection prompt does that for you.

Before you start

  • You need to be a member of the Workspace you want to sign in to.
  • On macOS and Linux the installer needs no separate Node.js and no sudo. On Windows, Node.js 22.15 or newer is required, and the installer tells you how to get it if it is missing.

Steps

  1. Find the install command. In Kylon, open Settings, then under Developer tools select Kylon CLI. Under Installation, the command appears under Run in your terminal (or Run in PowerShell on the Windows tab). The Developer tools section is visible to every Workspace member.
  2. Run it. On macOS or Linux, paste the command into a terminal. On Windows, use the PowerShell command. It installs the CLI under ~/.kylon and opens your browser to sign in. Running it again is safe and updates an existing install.
  3. Sign in in your browser. Check that the code in the browser matches the one in your terminal, then approve the device. Your current Workspace is preselected, and you can expand the list to authorize several Workspaces at once. On a machine that already has the CLI, run kylon login to start this step again.
  4. Check it works. Run kylon status to see the signed-in user, Workspace and authentication state. Run kylon workspace help to list the commands you can use.

If the machine has no browser, such as a remote server, open the authorization address the CLI prints on any other device and approve it there. Or install first, then under Advanced: setup token & npx select Show setup command and paste that command into the remote terminal. It works once and expires in 30 minutes. It signs in as you, so share it only with a terminal you trust.

What happens next

  • The device is listed under Authorized devices on the same Kylon CLI settings page. Remove a device there to cut off its access.
  • To update the CLI, run the installer again or use kylon upgrade.
  • If a command fails, kylon diagnose writes a diagnostic bundle on your computer. It uploads nothing unless you add the upload option.
  • For all commands and options, see the CLI Overview, the installation guide and the CLI troubleshooting guide.