コマンドリファレンス
Kamui 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 pro 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
対話内容:
- Project name - プロジェクト名
- Description - 説明（省略可）
- Plan type - Free または Pro
- Region - 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（省略時は対話で選択） |
対話内容:
- Select project - プロジェクト選択
- App type - Dynamic app / Static app (GitHub) / Static app (ZIP upload)
- App name - アプリ名
Dynamic app の場合:
- Language - Node.js / Go / Python
- Deploy from - GitHub repository / Docker Hub
- Select repository - リポジトリ選択
- Select branch - ブランチ選択
- Directory - サブディレクトリ（モノレポ用）
- Start command - 起動コマンド
- Setup command - セットアップコマンド
- Pre-deploy command - プリデプロイコマンド
- Health check endpoint - ヘルスチェックパス
- Replicas - レプリカ数
- Add environment variables? - 環境変数
- Connect to database? - データベース接続
Static app (GitHub) の場合:
- Select repository - リポジトリ選択
- Select branch - ブランチ選択
- Directory - 公開ディレクトリ
- App spec - リソースサイズ
- Replicas - レプリカ数
Static app (ZIP upload) の場合:
- Path to directory or ZIP file - ローカルパス
- App spec - リソースサイズ
- Replicas - レプリカ数
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
出力形式
テキスト（デフォルト）
人間が読みやすい表形式で出力します。
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"
# Free プランのプロジェクトのみ表示
kamui projects list -o json | jq '.[] | select(.plan_type == "free")'
設定ファイル
認証情報は以下の場所に保存されます：
~/.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