All docs

CLI

Install the CLI

The Cady CLI is one command, cady, installed by one signed script.

Not live yet. The installer ships with the first CLI release. This is the command it will use, on macOS or Linux:

curl -fsSL https://cadyworks.com/install.sh | sh

The script checks the download against its published checksum, verifies the signature on macOS and puts one file at ~/.local/bin/cady. It prints:

Installed Cady 0.4.0 at /home/you/.local/bin/cady

Check it, then run first setup with cady setup:

cady --version
cady 0.4.0

Status

  • The install script is not published yet.
  • Cady’s server already accepts cady sync, so setup and sync work as soon as you have the CLI.
  • Windows is not available yet.

What can go wrong

  • cady: command not found: the script printed “Add /home/you/.local/bin to your PATH to run cady.” Add it and open a new shell.
  • “Download checksum mismatch”: nothing was installed and an existing install is unchanged. Run the script again.
  • “Unsupported operating system or architecture”: the CLI is built for macOS and Linux, on Apple Silicon, Intel and ARM.

For agents: this page as Markdown.