CLI 工具

Piora CLI 是官方的命令列工具，讓你可以在終端機中直接管理伺服器、應用與部署。

安裝

透過 npm 安裝

npm install -g @piora/cli

透過 Homebrew 安裝（macOS）

brew install piora-dev/tap/piora

驗證安裝

piora --version
# piora/1.0.0 darwin-arm64

初始設定

使用 API Token 登入

如果你在 CI/CD 環境中使用，可以直接設定 Token：

piora login --token piora_token_xxxxxxxxxxxx

# 或使用環境變數
export PIORA_API_TOKEN=piora_token_xxxxxxxxxxxx

常用指令

伺服器管理

# 列出所有伺服器
piora servers list

# 檢視伺服器詳情
piora servers info <server-id>

# 檢視伺服器狀態
piora servers stats <server-id>

應用管理

# 列出所有應用
piora apps list

# 檢視應用詳情
piora apps info <app-id>

# 建立新應用
piora apps create --name my-app --server <server-id>

# 刪除應用
piora apps delete <app-id>

部署

# 觸發部署
piora deploy <app-id>

# 觸發部署（指定分支）
piora deploy <app-id> --branch main

# 檢視部署狀態
piora deploy status <app-id>

# 檢視部署日誌
piora deploy logs <app-id>

# 回滾到上一版
piora deploy rollback <app-id>

日誌

# 即時檢視應用日誌
piora logs <app-id>

# 即時串流日誌
piora logs <app-id> --follow

# 檢視最近 100 行
piora logs <app-id> --lines 100

環境變數

# 列出環境變數
piora env list <app-id>

# 設定環境變數
piora env set <app-id> KEY=value

# 設定多個環境變數
piora env set <app-id> KEY1=value1 KEY2=value2

# 移除環境變數
piora env unset <app-id> KEY

# 從 .env 檔案匯入
piora env import <app-id> .env

CI/CD 整合

GitHub Actions

name: Deploy to Piora
on:
  push:
    branches: [main]

jobs:
  deploy:
    runs-on: ubuntu-latest
    steps:
      - name: Install Piora CLI
        run: npm install -g @piora/cli

      - name: Deploy
        run: piora deploy ${{ secrets.PIORA_APP_ID }}
        env:
          PIORA_API_TOKEN: ${{ secrets.PIORA_API_TOKEN }}

GitLab CI

deploy:
  stage: deploy
  image: node:20
  script:
    - npm install -g @piora/cli
    - piora deploy $PIORA_APP_ID
  variables:
    PIORA_API_TOKEN: $PIORA_API_TOKEN
  only:
    - main

設定檔

CLI 的設定儲存在 ~/.piora/config.json：

{
  "token": "piora_token_xxxxxxxxxxxx",
  "default_server": "server-id",
  "output": "table"
}

輸出格式

# 表格格式（預設）
piora servers list --output table

# JSON 格式
piora servers list --output json

# 簡潔格式
piora servers list --output compact

全部指令

# 查看所有可用指令
piora help

# 查看特定指令的說明
piora help deploy
piora deploy --help