Skip to main content
The Kaneo CLI is a single kaneo binary. Install it with one command. On macOS and Linux:
On Windows, in PowerShell:
The script downloads the build for your system from the GitHub release, checks it against the release’s SHA-256 checksums, and only then replaces any existing kaneo. Nothing else is needed, not even Node.js.
  • On macOS and Linux it installs to ~/.local/bin/kaneo. If that directory is not on your PATH, the script prints the command that adds it for your shell (bash, zsh, fish or another).
  • On Windows it installs to %LOCALAPPDATA%\Programs\kaneo\kaneo.exe and adds that directory to your user PATH. Open a new terminal afterwards.
Then sign in and run kaneo on its own to see your account, your open tasks and the main commands.
Both scripts are plain text. Read them before running them: install.sh and install.ps1, or print one with curl -fsSL https://kaneo.app/cli/install.sh | less.

​
Install options

Set these environment variables to change what the script does: Pin a version, or install into another directory:
Without KANEO_VERSION, the script asks the GitHub API for the newest CLI release (tags that start with cli-v). GitHub allows 60 of these lookups per hour from one IP address without a token, so set KANEO_VERSION in CI.

​
Mirrors and offline machines

KANEO_DOWNLOAD_URL replaces https://github.com/usekaneo/kaneo/releases/download. The script then downloads <url>/cli-v<version>/SHA256SUMS and <url>/cli-v<version>/<file>, so a mirror keeps the same layout as the GitHub release. It makes no call to the GitHub API, which is why KANEO_VERSION is required.
For a machine without internet access, copy install.sh (or install.ps1), SHA256SUMS and the file for that machine from the release into a cli-v<version> folder, then point KANEO_DOWNLOAD_URL at the folder that contains it. install.sh accepts a file:// URL when it downloads with curl, and install.ps1 accepts a local or network path:

​
Supported systems

The x64 builds are baseline builds, so they also run on older processors without AVX2. On Alpine and other musl distributions, the CLI needs the C++ runtime library. The script warns when it is missing:
Prefer the install script to downloading a binary from the release page with a browser. The macOS builds are signed ad hoc but not notarized, so Gatekeeper can block a copy that a browser downloaded. Files downloaded with curl, as the script does, are not affected.

​
Update

Run the install command again. It replaces kaneo with the latest release, or with the version in KANEO_VERSION, and keeps your logins and settings. Check the result with kaneo --version. If the script warns that another kaneo comes first on your PATH, for example an older community CLI, it shows both paths. Remove the other one, or move the install directory earlier in your PATH.

​
Uninstall

Delete the binary. To also remove your stored logins and settings, delete the config directory:
On Windows, also remove %LOCALAPPDATA%\Programs\kaneo from your user PATH (search the Start menu for “Edit environment variables for your account”). If you set KANEO_INSTALL_DIR, XDG_CONFIG_HOME or KANEO_CONFIG, delete those locations instead.