> ## 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 可集中管理應用、環境、資料庫、快取、bucket、網域、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

# 第 2 次以後：部署到既有應用
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

- [Laravel Prompts](/zh-TW/prompts.md)
- [Cloud Sessions](/zh-TW/packages/laravel-copilot-sdk/cloud-sessions.md)
- [日誌](/zh-TW/logging.md)
- [laravel/agent-skills — Laravel 官方 AI Agent 技能集](/zh-TW/blog/agent-skills-introduction.md)
- [Laravel Cloud — Laravel 專用 PaaS 全貌](/zh-TW/blog/laravel-cloud.md)