Installation

Install with npm

The easiest installation is:

npm install --global @amxv/icloud-cli@latest

Then verify the command is available:

icloud version
icloud --help

The package installs the icloud command. You do not run icloud-cli.

Update

Use the same install command whenever you want the latest published release:

npm install --global @amxv/icloud-cli@latest
icloud version

Build from source

If you are working from a repository checkout:

make build
./dist/icloud version

For a full development verification:

make check
make docs-check

Shell completion

The CLI can generate completion for Bash, Zsh, Fish, and PowerShell.

For example:

icloud completion zsh > /tmp/_icloud
icloud completion bash > /tmp/icloud.bash

Where you install that file depends on your shell configuration. You can always regenerate it from the installed version.

Man pages

Generate the main man page to stdout:

icloud man > icloud.1
man ./icloud.1

Or generate the complete tree:

icloud man --output-dir ./man
man ./man/icloud-mail-search.1

Verify the installed feature set

capabilities is useful when a script or agent needs to know what this build supports:

icloud capabilities
icloud capabilities --json

The output is tied to the installed binary, so it is a better source than assuming a particular release has a feature.

Uninstall

If you installed with npm:

npm uninstall --global @amxv/icloud-cli

Uninstalling the package does not automatically remove the CLI’s local account and mail data. See Local data and backups before deleting that state.

Next: Quickstart.