cloud-init(1)

cloud-init1

Cloud instance initialization

Usage

cloud-init [-h] [-d] [--force] [-v] [SUBCOMMAND]

Overview

Cloud-init provides a mechanism for cloud instance initialization. This is done by identifying the cloud platform that is in use, reading cloud meta-data, vendor-data and user-data, and then initializing the instance as requested.

Options

-h, --help

Show help message and exit.

-v, --version

Show program's version number and exit.

--all-stages

INTERNAL: Run cloud-init's stages under a single process using a synchronization protocol. This is not intended for CLI usage.

Subcommands

Please see the help output for each subcommand for additional details, flags, and subcommands.

analyze

Analyze cloud-init logs and data.

collect-logs

Collect and tar all cloud-init debug info.

clean

Remove logs and artifacts so cloud-init can re-run.

devel

Run development tools. See help output for subcommand details.

features

List defined features.

query

Query standardized instance metadata from the command line.

schema

Validate cloud-config files using jsonschema.

single

Manually run a single module. Useful for testing during development.

status

Report cloud-init status or wait on completion.

Deprecated

-d, --debug

Show additional pre-action logging (default: False).

--force

Force running even if no datasource is found (use at your own risk).

init

Initialize cloud-init and execute initial modules.

modules

Activate modules using a given configuration key.

Exit status

0 - Success

1 - Error - Cloud-init failed.

2 - Recoverable error - Cloud-init completed but experienced errors.

Releases

4 releases since Debian 11 (Bullseye); the text changed 2 times.

  1. 11–12
  2. 13
  3. Arch

--all-stages since Debian 13 (Trixie).

--debug until Debian 12 (Bookworm); --files until Debian 12 (Bookworm); --force until Debian 12 (Bookworm); -d until Debian 12 (Bookworm); -f until Debian 12 (Bookworm).

From cloud-init 26.2-1 in Arch Linux 2026-11-01. Parsed by carta from the page's man source.