> ## Documentation Index
> Fetch the complete documentation index at: https://docs.qumo-deploy.com/llms.txt
> Use this file to discover all available pages before exploring further.

# CLI の概要

> Qumo Deploy のコマンドラインツール qumod のインストール、サインイン、最初のコマンドの実行方法です。

# `qumod` CLI

`qumod` を使うと、Qumo Deploy をターミナルから操作できます。コンソールでできることは
コマンドラインでもできます。プロジェクトの作成、署名鍵の発行と失効、メンバーの招待、
使用量・請求・監査ログの確認などです。dev プロジェクト用に、自分のマシンでリレーを
動かすこともできます。

macOS、Linux、Windows 向けの単一の自己完結型バイナリで、ほかに何もインストールする
必要はありません。また、CI、スクリプト、コーディングエージェントなど、無人での実行を
前提に作られています。

チームに共有できる簡単な紹介は
[qumo-deploy.com/cli/qumod](https://qumo-deploy.com/cli/qumod) をご覧ください。

***

## クイックスタート

**1. インストール**

```bash macOS & Linux theme={null}
curl -fsSL https://dl.qumo-deploy.com/qumod/install.sh | sh
```

```powershell Windows (PowerShell) theme={null}
irm https://dl.qumo-deploy.com/qumod/install.ps1 | iex
```

インストーラーはダウンロードしたファイルをリリースの `SHA256SUMS` と照合し、
`sudo` は不要です。続いて新しいターミナルを開き、`qumod` が PATH に入った状態にします。
macOS と Linux では、その前にインストーラーが表示する `export PATH=…` の行をシェルの
プロファイルに追加してください。インストーラーをもう一度実行すると最新リリースに
更新されます。バージョンの固定や手動ダウンロードについては
[インストール](https://docs.qumo-deploy.com/ja/cli/installation.md) を参照してください。

**2. サインイン**

```bash theme={null}
qumod login
```

ブラウザでコンソールのデバイスページが開きます。ターミナルに表示されたコードを入力し、
承認してください。CI ではこの手順を省き、代わりに `QUMO_TOKEN` を設定します
（[認証](https://docs.qumo-deploy.com/cli/authentication.md) を参照）。

**3. 最初のコマンドを実行する**

```bash theme={null}
qumod whoami
qumod project create my-app
```

組織など省略した項目は、ターミナルに表示される一覧から選べます。

***

## できること

| タスク | コマンド | コンソールでの操作 |
| :- | :- | :- |
| サインイン・サインアウト、アイデンティティの確認 | `qumod login`, `qumod logout`, `qumod whoami` | サインインページ |
| プロジェクトの一覧表示と作成 | `qumod project list`, `qumod project create` | **プロジェクト** |
| 署名鍵の作成、一覧表示、失効、エクスポート | `qumod keys create`, `list`, `revoke`, `export` | **署名鍵**（作成と失効） |
| メンバーの招待と削除 | `qumod members invite`, `list`, `invitations`, `remove`, `uninvite` | **組織設定 → メンバー** |
| 帯域幅の推移の確認 | `qumod usage` | **使用量** |
| 現在の請求額と請求書の確認 | `qumod billing summary`, `qumod billing invoices` | **使用量**, **組織設定 → プランと請求** |
| 監査ログの閲覧 | `qumod audit` | **アクティビティ**, **組織設定 → 監査ログ** |
| dev プロジェクト用に自分のマシンでリレーを動かす | `qumod network create`, `start`, `stop`, `status`, `logs`, `token` | なし |

プランや支払い方法の変更はコンソールで行います。各コマンドのフラグは
[コマンドリファレンス](https://docs.qumo-deploy.com/cli/commands.md) に記載されており、`qumod help <command>` でターミナルに
表示することもできます。

***

## 例

```bash theme={null}
# 署名鍵を作成する。秘密鍵はこのファイルに書き出され、送信されることはない
qumod keys create backend --project 7c0e2a4b-5d1f-4a8e-9b3c-2f6d8e1a0b5c --out signing-key.jwk

# チームメイトをプロジェクト編集者として招待する
qumod members invite dev@example.com --role project.editor

# 1 つのプロジェクトの 1 時間ごとの帯域幅を、スクリプト向けに JSON で取得する
qumod usage --project 7c0e2a4b-5d1f-4a8e-9b3c-2f6d8e1a0b5c --granularity hour --json

# 直近 1 日の変更内容
qumod audit --since 24h
```

Free プランでは、dev プロジェクト用のリレーを自分で動かします。1 つのコマンドで署名鍵も
含めてセットアップし、もう 1 つのコマンドで起動します（Docker は不要です）。

```bash theme={null}
qumod network create my-network
cd my-network && qumod network start
```

***

## 自動化のための設計

* **`--json`** は結果を 1 行に 1 ドキュメントの JSON として stdout に、エラーを stderr に出力します。
* **`QUMO_TOKEN`**（または `--token`）を使うと、ブラウザなしでパーソナルアクセストークンにより認証します。
* **ターミナルがなければプロンプトを出しません。** `--yes`、`--json` を指定した場合や TTY がない場合、引数が足りないとプロンプトではなく使用法エラー（終了コード 2）になります。

GitHub Actions のワークフローは [CI/CD とコーディングエージェント](https://docs.qumo-deploy.com/cli/ci-cd.md) を参照してください。

***

## ドキュメント一覧

> [card] [インストール](https://docs.qumo-deploy.com/ja/cli/installation.md)
>
> インストーラー、バージョンの固定、手動ダウンロード、更新とアンインストール。

> [card] [認証](https://docs.qumo-deploy.com/cli/authentication.md)
>
> `qumod login` によるブラウザでのサインイン、または CI やエージェント向けのトークン。

> [card] [コマンドリファレンス](https://docs.qumo-deploy.com/cli/commands.md)
>
> すべてのコマンド、フラグ、例。

> [card] [CI/CD とコーディングエージェント](https://docs.qumo-deploy.com/cli/ci-cd.md)
>
> GitHub Actions と GitLab CI のレシピ、JSON 出力、終了コード。


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.