The CloudCannon Command Line Interface (CLI) lets you work with CloudCannon from the command line. It generates and validates CloudCannon configuration files, runs a local dev server that loads the CloudCannon app against your local files, and manages your Organizations A workspace in CloudCannon that groups together Sites, team members, and shared resources. It is also the unit CloudCannon bills for. You can define permissions for your Organization, controlling the access each team member has to resources on CloudCannon. You can create and be a part of multiple Organizations. A website in CloudCannon that includes all the files, content, configuration, and settings needed to edit, build, and host a complete website. The process of converting all your Site files into a single, functional website using the method specified by your SSG. Building on CloudCannon is optional, but is required for specific features, such as the Visual Editor, preview screenshots for output files in your Collection Browser, and the Testing Domain and Custom Domain. An API (Application Programming Interface) is a set of methods and rules that allow one piece of software to interact with another using code to call specific functions for reading data, triggering actions, or responding to events, rather than a graphical interface.Organization
Site
Build
API
Installation#
Install the CLI globally with npm:
npm install --global @cloudcannon/cli
The CLI requires Node.js 24 or later.
Authentication#
The configure and dev commands work on your local project files and don't require authentication. The sites, orgs, builds, and inboxes commands operate on CloudCannon through the API, so they require authentication.
For interactive use, log in with your CloudCannon account:
cloudcannon login
For automation and continuous integration, provide a credential through environment variables instead:
CLOUDCANNON_API_KEY— an organization-scoped API KeyGlossary termAPI Key
A credential that lets programs act on behalf of your Organization through the CloudCannon API, such as a program built with the CloudCannon SDK. An API Key is scoped to the permissions you choose when you create it and belongs to a single Organization. CloudCannon shows the key only once, and you manage your keys on the API Keys page in your Organization Settings.
CC_ACCESS_KEY_IDandCC_ACCESS_KEY_SECRET— a personal Access KeyGlossary termAccess Key
A personal credential that lets programs act in CloudCannon on your behalf, such as the CloudCannon CLI or a program built with the CloudCannon SDK. An Access Key is tied to your user account and inherits your full account access across every Organization and Site you belong to. CloudCannon shows the secret only once, when you create the key, and you manage your keys on the Access Keys page in your Account Settings.
To create these credentials, please read our documentation on creating an API key or creating an Access Key. Store them as secret environment variables, and never commit them to source control.