指令參考
KamuiDash CLI 所有指令的完整參考。
全域選項
所有指令都可以使用的選項。
| 選項 | 說明 |
|---|---|
-o, --output <format> |
輸出格式：text（預設）或 json |
-h, --help |
顯示說明 |
-v, --version |
顯示版本 |
驗證
kamui login
使用你的 GitHub 帳號進行驗證。
kamui login
會開啟瀏覽器進行 GitHub OAuth 驗證。驗證成功後，權杖會儲存在本機。
kamui logout
登出並清除憑證。
kamui logout
專案
kamui projects list
列出所有專案。
kamui projects list
輸出範例：
ID NAME PLAN REGION APPS DATABASES
5f809f2f-0787-40ca-9a43-a3a59edb5400 my-project free tokyo 2 1
21065335-ade9-4e63-bfcc-284760fa3957 another-app free tokyo 3 0
JSON 輸出：
kamui projects list -o json
kamui projects get
顯示專案詳細資訊。
kamui projects get <project-id>
引數：
| 引數 | 說明 |
|---|---|
project-id |
專案 ID |
輸出範例：
Project: my-project
ID: 5f809f2f-0787-40ca-9a43-a3a59edb5400
Plan: free
Region: tokyo
Created: 2025-01-15 10:30:00
Updated: 2025-01-20 14:22:00
Apps:
ID NAME TYPE URL
a1b2c3d4-... api dynamic https://api-xxx.kamui.run
Databases:
ID NAME TYPE STATUS
i9j0k1l2-... main-db postgres running
kamui projects create
以互動方式建立專案。
kamui projects create
互動式提示：
- 專案名稱
- 說明（選填）
- 方案類型 - Free
- 區域 - Tokyo
範例：
? Project name: my-new-project
? Description (optional, max 80 chars): My awesome project
? Plan type: Free
? Region: Tokyo
Creating project...
✓ Project "my-new-project" created successfully!
Plan: free
Region: tokyo
kamui projects delete
刪除專案。
kamui projects delete <project-name-or-id>
引數：
| 引數 | 說明 |
|---|---|
project-name-or-id |
專案名稱或 ID |
選項：
| 選項 | 說明 |
|---|---|
-y, --yes |
略過確認提示 |
範例：
# 需要確認
kamui projects delete my-project
# 不需確認（適合腳本使用）
kamui projects delete my-project --yes
警告：專案中的所有資源都會被刪除。
應用程式
kamui apps list
列出專案中的應用程式。
kamui apps list --project <project-name-or-id>
kamui apps list -p <project-name-or-id>
選項：
| 選項 | 說明 | 必填 |
|---|---|---|
-p, --project |
專案名稱或 ID | ✓ |
輸出範例：
Apps in project "my-project" (5f809f2f-0787-40ca-9a43-a3a59edb5400):
• api-server
ID: a1b2c3d4-5678-90ab-cdef-123456789abc
Status: running
URL: https://api-xxx.kamui.run
• worker
ID: e5f6g7h8-9012-34cd-ef56-789012345def
Status: running
kamui apps create
以互動方式建立應用程式。
kamui apps create
kamui apps create --project my-project
選項：
| 選項 | 說明 |
|---|---|
-p, --project |
專案名稱或 ID（省略時會出現提示） |
互動式提示：
- 選擇專案
- 應用程式類型 - Web Server / Web Page
- 應用程式名稱
Web Server 的情況：
- 語言 - Node.js / Go / Python
- 部署來源 - GitHub 儲存庫
- 選擇儲存庫
- 選擇分支
- 目錄（monorepo 用）
- 啟動指令
- Setup 指令
- 啟動前指令
- 健康檢查端點
- 副本數
- 是否新增環境變數？
- 是否連接資料庫？
Web Page 的情況：
- 選擇儲存庫
- 選擇分支
- 目錄（公開目錄）
- 應用程式規格（資源大小）
- 副本數
kamui apps delete
刪除應用程式。
kamui apps delete <app-name-or-id>
引數：
| 引數 | 說明 |
|---|---|
app-name-or-id |
應用程式名稱或 ID |
選項：
| 選項 | 說明 |
|---|---|
-y, --yes |
略過確認提示 |
範例：
kamui apps delete my-api
kamui apps delete my-api --yes
輸出格式
Text（預設）
人類易讀的表格格式。
kamui projects list
JSON
適合腳本處理的 JSON 格式。
kamui projects list -o json
搭配 jq 使用：
# 取得第一個專案的 ID
PROJECT_ID=$(kamui projects list -o json | jq -r '.[0].id')
echo "Project ID: $PROJECT_ID"
# 只列出專案名稱
kamui projects list -o json | jq -r '.[].name'
設定檔
憑證會儲存在：
~/.kamui/config.json
這個檔案含有 OAuth 權杖，請妥善保管。
結束代碼
| 代碼 | 意義 |
|---|---|
| 0 | 成功 |
| 1 | 錯誤 |
在腳本中的使用範例：
if kamui projects list > /dev/null 2>&1; then
echo "Logged in"
else
echo "Not logged in"
kamui login
fi