Install & Set Up the OpenCloud CLI – Open Cloud

The OpenCloud CLI is the command-line tool you use to create Cloud Engines, deploy apps, and manage your infrastructure from your terminal. This guide covers installing it, signing in, and verifying everything works — so you're ready to create your first Engine.

Prerequisites: an OpenCloud account with Passkey Sign-In set up, and a supported operating system ([FILL IN: macOS / Linux / Windows versions supported]).

Step 1 — Install the CLI

Choose the method for your platform.

macOS / Linux [FILL IN: confirm install method]

[FILL IN: e.g. curl -fsSL https://opencloud.org/install.sh | sh]

Homebrew (macOS) [FILL IN]

brew install [FILL IN: tap/formula]

Windows [FILL IN: e.g. installer download link or winget/scoop command]

Via npm (if applicable) [FILL IN]

npm install -g [FILL IN: package name]

Step 2 — Verify the installation

Confirm the CLI is installed and on your PATH:

[FILL IN: cli-name] --version

You should see the installed version printed. If the command isn't found, [FILL IN: PATH troubleshooting note — restart shell / add install dir to PATH].

Step 3 — Sign in

Authenticate the CLI with your OpenCloud account:

[FILL IN: cli-name] login

This opens your browser to complete sign-in with your passkey. Once authorized, the CLI stores your session locally and you can return to the terminal.

Tip: To confirm you're signed in, run [FILL IN: cli-name] whoami — it should print your account.

Step 4 — Configure your environment (optional)

[FILL IN: any default settings worth configuring up front — default node provider/region, default project directory, profile/context switching for multiple accounts or teams]

Common commands

Once set up, these are the commands you'll use most:

Command	What it does
`[FILL IN] create`	Create a new Cloud Engine
`[FILL IN] deploy`	Deploy a signed `.icp` app file
`[FILL IN] status`	Check Engine health and cycle burn
`[FILL IN] logs`	View Engine logs
`[FILL IN] login` / `whoami`	Sign in / check current account

See the full CLI Reference for every command and flag.

Troubleshooting

command not found — [FILL IN: PATH fix / reinstall]
Sign-in won't complete — [FILL IN: browser/passkey troubleshooting]
Permission errors during install — [FILL IN: sudo / install-location guidance]

Next steps

Create a New Cloud Engine in OpenCloud — Spin up your first Engine.
Deploy a Signed .icp App File to Your Engine — Ship your first app.