> ## Documentation Index
> Fetch the complete documentation index at: https://kawax.biz/llms.txt
> Use this file to discover all available pages before exploring further.

# Laravel Cloud CLI —— 在终端里操作 Laravel Cloud

> 介绍如何使用 laravel/cloud-cli 在终端中管理 Laravel Cloud 上的应用、环境、数据库、域名等资源。

## 什么是 Laravel Cloud CLI

`laravel/cloud-cli` 是用于在终端里操作 [Laravel Cloud](https://cloud.laravel.com) 的 CLI。
它由 Laravel Zero 构建,你在面板里执行的操作都能通过 `cloud` 命令完成。

你可以用这个 CLI 集中管理应用、环境、数据库、缓存、存储桶、域名、WebSocket 等资源。

## 需求

在开始之前,请满足以下要求。

* `PHP 8.2+`
* `Composer`
* `GitHub CLI (gh)`(已安装并完成认证)
* `Git`

## 安装

首先在本地安装 CLI。

<Steps>
  <Step title="拉取仓库并安装依赖">
    ```bash theme={null}
    gh repo clone laravel/cloud-cli
    cd cloud-cli
    composer install
    ```
  </Step>

  <Step title="设置 `cloud` 别名">
    zsh:

    ```bash theme={null}
    echo 'alias cloud="php '$(pwd)'/cloud"' >> ~/.zshrc
    source ~/.zshrc
    ```

    bash:

    ```bash theme={null}
    echo 'alias cloud="php '$(pwd)'/cloud"' >> ~/.bashrc
    source ~/.bashrc
    ```
  </Step>

  <Step title="用任意路径手动设置">
    ```bash theme={null}
    alias cloud="php /path/to/cloud-cli/cloud"
    ```
  </Step>
</Steps>

## 认证

在使用大多数命令之前,请先完成认证。

```bash theme={null}
cloud auth
```

`cloud auth` 会打开浏览器,通过 OAuth 完成认证。
如果需要在 CI 等场景管理 token,可以使用 `cloud auth:token`。

```bash theme={null}
cloud auth:token
```

## 仓库配置

如果你不想每次都在项目里选择 `application` 或 `environment`,请执行 `cloud repo:config`。

```bash theme={null}
cloud repo:config
```

这会在 Git 仓库中保存默认值,让 `cloud deploy` 等命令可以用更短的方式运行。

## 部署

把首次部署和后续部署分开使用会更有效率。

```bash theme={null}
# 首次:带引导的应用创建与部署
cloud ship

# 后续:向已有应用部署
cloud deploy

# 打开面板
cloud dashboard
```

## 主要命令分类

从 README 的命令参考中,整理日常常用的分类。

| 分类            | 主要命令示例                                                                    | 用途            |
| ------------- | ------------------------------------------------------------------------- | ------------- |
| Auth / Config | `cloud auth`、`cloud auth:token`、`cloud repo:config`                       | 认证与默认设置       |
| Application   | `cloud application:list`、`cloud application:create`                       | 应用管理          |
| Environment   | `cloud environment:list`、`cloud environment:get`、`cloud environment:logs` | 环境信息与日志查看     |
| Deploy        | `cloud ship`、`cloud deploy`、`cloud deploy:monitor`                        | 部署管理          |
| Database      | `cloud database-cluster:*`、`cloud database:*`、`cloud database-snapshot:*` | DB 集群、DB、快照管理 |
| Cache         | `cloud cache:list`、`cloud cache:create`、`cloud cache:types`               | 缓存管理          |
| Bucket        | `cloud bucket:*`、`cloud bucket-key:*`                                     | 对象存储管理        |
| Domain        | `cloud domain:list`、`cloud domain:create`、`cloud domain:verify`           | 域名配置与验证       |
| WebSocket     | `cloud websocket-cluster:*`、`cloud websocket-application:*`               | Reverb 相关资源管理 |

## 环境变量管理

通过 `cloud environment:variables` 管理环境变量。
该命令统一涵盖 append / set / replace 等操作。

```bash theme={null}
cloud environment:variables
```

在 CI 和团队协作中,通过该命令统一环境变量的变更流程。

## 用量查看

计费和资源用量可以用 `cloud usage` 查看。

```bash theme={null}
# 当月用量
cloud usage

# 详细展示
cloud usage --detailed

# 上一周期的用量
cloud usage --period=previous
```

想按环境筛选时使用 `cloud usage --environment=<id>`。


## Related topics

- [Cloud Sessions](/zh/packages/laravel-copilot-sdk/cloud-sessions.md)
- [用 Homebrew 安装 PHP、Composer 和 Node.js(macOS)](/zh/blog/mac-setup.md)
- [Laravel PAO — 面向 AI 智能体的输出优化工具](/zh/blog/pao-introduction.md)
- [laravel/agent-skills — Laravel 官方 AI 智能体技能集](/zh/blog/agent-skills-introduction.md)
- [Laravel Cloud — Laravel 专用 PaaS 全貌](/zh/blog/laravel-cloud.md)