icloudiCloud from the command line

Documentation

Use icloud safely from a terminal, script, or agent.

Begin with installation and the quickstart, then use the credential, output, and command guides to choose the safest input and smallest representation that fit the task.

Start

Quickstart

Install icloud, verify the binary, create an isolated state root, and add an offline iCloud Mail account without exposing its app-specific password.

Open guide

Installation

Install icloud through npm or build it from source, then verify the native binary and version.

Open guide

Guides

Account setup and credentials

Add multiple iCloud Mail profiles safely, choose keyring, environment, or file credentials, select a default account, and rotate or remove credentials.

Open guide

Local state and account inspection

Choose an isolated data directory, inspect bounded account inventories, understand selection rules, and handle concurrent access safely.

Open guide

Output and automation

Understand compact defaults, JSON envelopes, stdin credential safety, stderr, request IDs, timeouts, and stable exit classes.

Open guide

Troubleshooting

Resolve installation, account setup, credential, state, output, completion, and man-generation problems.

Open guide

Reference

Command reference

A complete reference for account and credential lifecycle commands, global controls, output modes, completion, and man generation.

Open guide

Changelog

Release notes and unreleased user-visible changes for icloud.

Open guide