Get started / Install

Get started

Install

Install the wiele CLI on macOS or Linux with npm, check the setup, update and uninstall.

The wiele CLI runs on macOS and Linux, including Linux containers and cloud sandboxes. There is no Windows client yet.

Requirements

  • Node.js 24.20 or newer, with npm.
  • A local file system for checkouts, such as APFS on macOS or ext4 on Linux. Network drives and folders with symlinks inside don't work as checkouts.
  • On Linux desktops, a Secret Service keyring such as GNOME Keyring for the saved session. Headless machines use a session file instead; see Authentication.

Check your Node version:

node --version

If it's missing or older, install Node 24 with your usual tool:

brew install node          # macOS with Homebrew
nvm install 24             # nvm, on macOS or Linux

Or download it from nodejs.org.

Install the CLI

npm install -g wiele
wiele version

wiele version prints the CLI version and the protocol versions it speaks. Then run the built-in checks:

wiele doctor

doctor reports on the saved session, the API, the background process, free disk space and, inside a checkout, the checkout itself. Before you sign in, it reports attention for the session; that's expected.

Update

npm install -g wiele@latest

If you use background sync, restart the background process after an update:

wiele daemon stop
wiele daemon start

Uninstall

wiele daemon uninstall     # only if you ran wiele daemon install
wiele auth logout
npm uninstall -g wiele

Your checkouts stay on disk as ordinary folders. Each keeps a hidden .wiele folder you can delete once you no longer need it. wiele checkout forget stops tracking one checkout and keeps its files.

Shell completion

wiele --completions SHELL prints a completion script for bash, zsh, fish or sh. Save it where your shell loads completions, for example:

wiele --completions bash > ~/.local/share/bash-completion/completions/wiele