Skip to main content

​
What is Laravel Cloud CLI

laravel/cloud-cli is the official CLI for working with Laravel Cloud from your terminal.
It is built with Laravel Zero and exposes dashboard workflows through the cloud command. You can manage applications, environments, databases, caches, buckets, domains, and WebSocket resources without leaving the terminal.

​
Requirements

Make sure your environment includes:
  • PHP 8.2+
  • Composer
  • GitHub CLI (gh) (installed and authenticated)
  • Git

​
Installation

Set up the CLI locally first.
1

Clone the repository and install dependencies

gh repo clone laravel/cloud-cli
cd cloud-cli
composer install
2

Set up a `cloud` alias

zsh:
echo 'alias cloud="php '$(pwd)'/cloud"' >> ~/.zshrc
source ~/.zshrc
bash:
echo 'alias cloud="php '$(pwd)'/cloud"' >> ~/.bashrc
source ~/.bashrc
3

Optionally configure a manual path alias

alias cloud="php /path/to/cloud-cli/cloud"

​
Authentication

Authenticate before running most commands: 
cloud auth
cloud auth opens your browser for OAuth login.
For token management in CI or automation, use cloud auth:token. 
cloud auth:token

​
Repository defaults

If you want to avoid selecting application and environment every time, run cloud repo:config in your project root. 
cloud repo:config
This stores repository defaults and makes commands like cloud deploy faster to run.

​
Deploy workflow

Use guided shipping once, then switch to regular deploys. 
# First deployment with guided flow
cloud ship

# Ongoing deployments to an existing app
cloud deploy

# Open the Cloud dashboard
cloud dashboard

​
Main command categories

The README command reference is broad. This table highlights the most common categories.
CategoryExample commandsPurpose
Auth / configcloud auth, cloud auth:token, cloud repo:configAuthentication and defaults
Applicationcloud application:list, cloud application:createApplication lifecycle
Environmentcloud environment:list, cloud environment:get, cloud environment:logsEnvironment info and logs
Deploycloud ship, cloud deploy, cloud deploy:monitorDeploy and monitor
Databasecloud database-cluster:*, cloud database:*, cloud database-snapshot:*Database and snapshot operations
Cachecloud cache:list, cloud cache:create, cloud cache:typesCache management
Bucketcloud bucket:*, cloud bucket-key:*Object storage and keys
Domaincloud domain:list, cloud domain:create, cloud domain:verifyDomain setup and verification
WebSocketcloud websocket-cluster:*, cloud websocket-application:*WebSocket resources

​
Environment variable management

Use cloud environment:variables to manage environment variables.
This command supports append, set, and replace workflows. 
cloud environment:variables
In team and CI workflows, keep your variable updates consistent through this command.

​
Usage and billing checks

Use cloud usage to review resource usage and billing summaries. 
# Current billing period
cloud usage

# Detailed usage tables
cloud usage --detailed

# Previous billing period
cloud usage --period=previous
To scope usage to one environment, run cloud usage --environment=<id>.
Last modified on May 18, 2026