mirror of
https://gh-proxy.org/https://github.com/klinsmaya/multica.git
synced 2026-11-09 09:56:47 +08:00
苗大
d3a435b5dd
The HTTP API already persisted conversation_starters. agent create and agent update now send that field when --conversation-starters is set; copy still carries the source value without an override flag.
321 lines
21 KiB
Plaintext
321 lines
21 KiB
Plaintext
---
|
||
title: CLI を使う
|
||
description: Multica CLI をインストールしてサインインし、ターミナルからワークスペース、タスク、エージェント、ランタイムを管理します。
|
||
---
|
||
|
||
import { Callout } from "fumadocs-ui/components/callout";
|
||
|
||
Multica CLI は、ローカルのランタイムを接続する役割と、ターミナルからワークスペース、タスク、エージェント、オートパイロットを管理する役割の両方を担います。このページではよく使う操作の流れを紹介します。現在のバージョンがサポートするフラグは、常に各コマンド自身の `--help` が正です。
|
||
|
||
## インストール
|
||
|
||
**macOS / Linux**
|
||
|
||
```bash
|
||
curl -fsSL https://raw.githubusercontent.com/multica-ai/multica/main/scripts/install.sh | bash
|
||
```
|
||
|
||
Homebrew がインストールされていれば、次のコマンドでもインストールできます:
|
||
|
||
```bash
|
||
brew install multica-ai/tap/multica
|
||
```
|
||
|
||
**Windows PowerShell**
|
||
|
||
```powershell
|
||
irm https://raw.githubusercontent.com/multica-ai/multica/main/scripts/install.ps1 | iex
|
||
```
|
||
|
||
インストールを確認します:
|
||
|
||
```bash
|
||
multica version
|
||
```
|
||
|
||
## 初回接続
|
||
|
||
Multica Cloud に接続する:
|
||
|
||
```bash
|
||
multica setup
|
||
```
|
||
|
||
セルフホストインスタンスに接続する:
|
||
|
||
```bash
|
||
multica setup self-host \
|
||
--server-url https://api.example.com \
|
||
--app-url https://app.example.com
|
||
```
|
||
|
||
`setup` はサーバーアドレスを保存し、ブラウザを開いてサインインを完了し、デーモンを起動します。完了したら確認します:
|
||
|
||
```bash
|
||
multica auth status
|
||
multica daemon status
|
||
```
|
||
|
||
他の設定を上書きせずにサインインだけやり直したい場合は、`multica login` を実行します。ブラウザのない環境では、先に Web の設定で個人アクセストークンを作成しておき、次のコマンドで入力します:
|
||
|
||
```bash
|
||
multica login --token
|
||
```
|
||
|
||
このコマンドはターミナル上でトークンの貼り付けを促すため、完全な値が shell history に残りません。
|
||
|
||
## ワークスペースを選ぶ
|
||
|
||
ワークスペースを一覧し、デフォルトを切り替えます:
|
||
|
||
```bash
|
||
multica workspace list
|
||
multica workspace switch <slug>
|
||
```
|
||
|
||
以降のコマンドはこのワークスペースを使います。単発のコマンドでは `--workspace-id` で一時的に上書きでき、`MULTICA_WORKSPACE_ID` を設定することもできます。
|
||
|
||
メンバーを招待する:
|
||
|
||
```bash
|
||
multica workspace member invite [email protected]
|
||
multica workspace member invite [email protected] --role admin
|
||
```
|
||
|
||
## よく使うタスク操作
|
||
|
||
```bash
|
||
# 表示と検索
|
||
multica issue list
|
||
multica issue get MUL-123
|
||
multica issue search "ログイン失敗"
|
||
|
||
# 作成と更新
|
||
multica issue create --title "ログイン失敗を修正"
|
||
multica issue status MUL-123 in_progress
|
||
multica issue assign MUL-123 --to "Backend Agent"
|
||
|
||
# コメントと実行履歴
|
||
multica issue comment list MUL-123
|
||
multica issue comment add MUL-123 --content "まず回帰テストを確認してください"
|
||
multica issue runs MUL-123
|
||
```
|
||
|
||
長い説明やコメントは stdin から読み込むと、改行や引用符の扱いに悩まずに済みます:
|
||
|
||
```bash
|
||
multica issue create --title "アップグレードメモ" --description-stdin < notes.md
|
||
multica issue comment add MUL-123 --content-stdin < review.md
|
||
```
|
||
|
||
1 回の実行のメッセージを表示する、または実行を停止する:
|
||
|
||
```bash
|
||
multica issue run-messages <task-id> --issue MUL-123
|
||
multica issue cancel-task <task-id> --issue MUL-123
|
||
```
|
||
|
||
## エージェントとスキル
|
||
|
||
```bash
|
||
multica agent list
|
||
multica agent get <agent-id>
|
||
multica agent create --help
|
||
multica agent update <agent-id> --help
|
||
|
||
multica skill list
|
||
multica skill get <skill-id>
|
||
multica skill import --url <skill-url>
|
||
multica agent skills add <agent-id> --skill-ids <skill-id>
|
||
```
|
||
|
||
インポートで同名のスキルに当たった場合、デフォルトでは既存の内容を変更せずに停止します。意図に応じて選択してください:
|
||
|
||
```bash
|
||
multica skill import --url <skill-url> --on-conflict overwrite
|
||
multica skill import --url <skill-url> --on-conflict rename
|
||
multica skill import --url <skill-url> --on-conflict skip
|
||
```
|
||
|
||
`overwrite` はスキルの作成者だけが使え、元の ID とエージェントの紐付けを維持します。
|
||
|
||
## デーモンとランタイム
|
||
|
||
```bash
|
||
multica daemon start
|
||
multica daemon stop
|
||
multica daemon restart
|
||
multica daemon status --output json
|
||
multica daemon logs --follow
|
||
|
||
multica runtime list
|
||
multica runtime rename <runtime-id> "Office Mac"
|
||
multica runtime usage <runtime-id>
|
||
multica runtime activity <runtime-id>
|
||
```
|
||
|
||
アクティブなエージェントがまだ紐付いているランタイムの削除は、デフォルトで拒否されます。`multica runtime delete <id> --cascade` は、それらのエージェントをランタイムから解除して設定と履歴を保持し、アクティブな実行をキャンセルします。
|
||
|
||
仕組みとカスタムプロファイルについては[デーモンとランタイム](/daemon-runtimes)を参照してください。
|
||
|
||
## コマンド概要
|
||
|
||
| コマンド | 用途 |
|
||
| --- | --- |
|
||
| `issue` | タスクの作成、更新、割り当て、検索。コメント、購読者、ラベル、プロパティ、実行履歴の管理 |
|
||
| `project` | プロジェクトとそのリソースを管理 |
|
||
| `label`、`property` | ワークスペースのラベルとカスタムプロパティを管理 |
|
||
| `agent`、`skill`、`squad` | エージェント、スキル、スクワッドを管理 |
|
||
| `autopilot` | オートパイロット、トリガー、実行履歴を管理 |
|
||
| `workspace` | ワークスペースの作成、表示、切り替えとメンバーの招待 |
|
||
| `repo` | ワークスペースのリポジトリを管理し、ローカルにチェックアウト |
|
||
| `daemon`、`runtime` | ローカルデーモンの起動と停止。ランタイムの表示と管理 |
|
||
| `attachment` | 添付ファイルのアップロードとダウンロード |
|
||
| `user profile` | 現在のユーザーのプロフィールを表示・更新 |
|
||
| `auth`、`login`、`setup` | サインイン、認証状態の確認、接続の初期化 |
|
||
| `config` | 現在の CLI プロファイルのローカル設定を表示・編集 |
|
||
| `update`、`version` | CLI の更新とバージョンの表示 |
|
||
|
||
`multica chat` が読み取るのは、**エージェントが現在処理している外部チャットセッション**です。主にチャット統合の中のエージェントが使うもので、任意のワークスペースの会話を閲覧するための汎用コマンドではありません。
|
||
|
||
## ID と出力形式
|
||
|
||
タスクには `MUL-123` のようなキーまたは完全な UUID を使います。UUID の短いプレフィックスは受け付けません。
|
||
|
||
その他のリソースの `list` コマンドは通常、コピーできる短い ID を表示し、`--full-id` で完全な UUID を出力できます。短い ID が一意に定まらない場合、CLI は文字の追加か完全な UUID への切り替えを求めます。実行の短い ID は、所属するタスクを `--issue` で指定する必要もあります。
|
||
|
||
多くのコマンドが構造化出力をサポートします:
|
||
|
||
```bash
|
||
multica issue list --output json
|
||
multica agent list --output json
|
||
```
|
||
|
||
スクリプトでは、ターミナル向けの表を解析せず JSON 出力を使ってください。各コマンドがサポートする出力形式とページネーションのフラグは `multica <command> --help` が正です。
|
||
|
||
## プロファイルと設定
|
||
|
||
デフォルトの設定は `~/.multica/config.json` に保存されます。`--profile <name>` を使うと、サーバーアドレス、トークン、デフォルトワークスペース、デーモン状態を別のセットとして分離できます:
|
||
|
||
```bash
|
||
multica setup self-host --profile staging \
|
||
--server-url https://api.staging.example.com \
|
||
--app-url https://app.staging.example.com
|
||
|
||
multica issue list --profile staging
|
||
```
|
||
|
||
名前付きプロファイルは `~/.multica/profiles/<name>/config.json` に保存されます。現在の値を確認する:
|
||
|
||
```bash
|
||
multica config show
|
||
multica config show --profile staging
|
||
```
|
||
|
||
<Callout type="warning">
|
||
CLI の設定ファイルには、あなたとして Multica にアクセスできるトークンが含まれます。リポジトリにコミットしたり、ログにアップロードしたり、他人と共有したりしないでください。
|
||
</Callout>
|
||
|
||
## コマンドリファレンス
|
||
|
||
以下の表は、現在のすべてのトップレベルコマンドを CLI 自身のグループ分けに沿って掲載しています。すべてのコマンドがグローバルフラグ `--server-url`、`--workspace-id`、`--profile`、`--debug` を受け付けます。`--output` はコマンドごとに登録されるフラグで、デフォルトの形式はコマンドによって異なります: `list` 系は表、`get` や `create` 系は多くが JSON です。完全なフラグは `multica <command> --help` が正です。
|
||
|
||
### Core
|
||
|
||
| コマンド | サブコマンド | 用途 | 主なフラグ |
|
||
| --- | --- | --- | --- |
|
||
| `issue` | `list` | タスクを一覧 | `--status`、`--priority`、`--assignee`、`--project`、`--metadata`（繰り返し可）、`--property`（繰り返し可、`"名前=値"`；`__none__` は未設定に一致）、`--limit`、`--offset`、`--sort`（`property:<名前または id>` に対応）、`--full-id`、`--resolve-properties`（JSON のみ；保存された id に加えてプロパティ名・選択肢名・メンバー名を返します） |
|
||
| | `get <id>` | 単一のタスクを表示 | `--resolve-properties`（JSON のみ；保存された id に加えてプロパティ名・選択肢名・メンバー名を返します） |
|
||
| | `create` | タスクを作成 | `--title`（必須）、`--description` / `--description-stdin` / `--description-file`、`--status`、`--priority`、`--assignee`、`--parent`、`--stage`、`--project`、`--start-date`、`--due-date`、`--attachment`（繰り返し可） |
|
||
| | `update <id>` | タスクのフィールドを更新 | `create` と同系のフィールドに加え `--position`、`--no-start` |
|
||
| | `assign <id>` | 割り当てまたは割り当て解除 | `--to`（メンバー、エージェント、スクワッドを名前であいまいマッチ）、`--to-id`、`--unassign`、`--no-start` |
|
||
| | `status <id> <status>` | ステータスを変更 | `--no-start` |
|
||
| | `reorder <id>` | カラム内で移動 | |
|
||
| | `search <query>` | タスクを検索 | `--limit`、`--include-closed` |
|
||
| | `children <id>` | サブタスクをステージごとに一覧 | |
|
||
| | `pull-requests <id>` | 関連付けられた PR を一覧 | |
|
||
| | `comment list/add/delete/resolve/unresolve` | コメントを管理 | `add`: `--content` / `--content-stdin` / `--content-file`、`--parent`、`--attachment`；`list`: `--since`、`--thread`、`--tail` |
|
||
| | `subscriber list/add/remove <issue-id>` | 購読者を管理 | `--user`、`--user-id`（省略時は現在のユーザー） |
|
||
| | `label list/add/remove <issue-id>` | タスクのラベルを管理 | |
|
||
| | `metadata list/get/set/delete <issue-id>` | タスクレベルのキー・バリューメタデータを管理 | |
|
||
| | `property list/set/unset <issue-id>` | カスタムプロパティの値を設定 | `set`: `--name`、`--value`（`actor` / `multi_actor` はメンバーの名前・メール・id を受け付けます） |
|
||
| | `runs <issue-id>` | 実行履歴を表示 | `--full-id` |
|
||
| | `run-messages <task-id>` | 1 回の実行のメッセージを表示 | `--since`、`--issue` |
|
||
| | `usage <issue-id>` | 集計されたトークン使用量を表示 | |
|
||
| | `rerun <id>` | 現在の担当者で実行を再キューイング | |
|
||
| | `cancel-task <task-id>` | 進行中またはキュー中の実行をキャンセル | `--issue` |
|
||
| `project` | `list/get/create/update/delete` | プロジェクトを管理 | |
|
||
| | `status <id> <status>` | プロジェクトのステータスを変更 | |
|
||
| | `resource list/add/update/remove` | プロジェクトの追加リソースを管理 | `--type`、`--url`、`--local-path`、`--daemon-id`、`--execution-mode`（ローカルディレクトリの `in_place` / `worktree`） |
|
||
| `label` | `list/get/create/update/delete` | ワークスペースのラベルを管理 | |
|
||
| `property` | `list/get/create/update/archive/unarchive` | ワークスペースのカスタムプロパティを管理 | `create`: `--name`、`--type`（`text`、`number`、`select`、`multi_select`、`date`、`checkbox`、`url`、`actor`、`multi_actor`）、`--option`（繰り返し可、select 系のみ）；`list`: `--include-archived`；タイプは作成後に変更できません |
|
||
| `agent` | `list/get/create/update/archive/restore` | エージェントを管理 | `--name`、`--runtime-id`（`create` では必須）、`--instructions`、`--conversation-starters`、`--model`、`--thinking-level`、`--mcp-config`、`--permission-mode`、`--max-concurrent-tasks` |
|
||
| | `copy <agent-id>` | 新しいエージェントとして複製。元のエージェントは変更されません | `--name`（デフォルトは元の名前 + ` (copy)`）、`--runtime-id`（別のランタイムへ複製する場合は `--model` の同時指定が必須）、`--no-skills`；`custom_env`、`mcp_config`、`runtime_config` などの機密設定は複製されないため、`create` と同じフラグで再指定してください |
|
||
| | `tasks <id>` | エージェントの実行を表示 | |
|
||
| | `avatar <id>` | アバターをアップロード | |
|
||
| | `env get/set <agent-id>` | カスタム環境変数の読み書き（owner と admin のみ） | |
|
||
| | `skills list/set/add <agent-id>` | 紐付けられたスキルを管理 | `--skill-ids`（`set` は全置換、`add` は追加） |
|
||
| | `mcp list/add/enable/disable/remove <agent-id>` | ワークスペース MCP サーバーをこのエージェントに割り当て | server id は `workspace mcp list` から取得。ライブラリの項目はここで追加するまで機能しません。`disable` は割り当てを残したまま送信を停止します |
|
||
| `autopilot` | `list/get/create/update/delete` | オートパイロットを管理 | `create`: `--title`、`--agent`、`--mode`（いずれも必須）、`--project`、`--subscriber`（繰り返し可） |
|
||
| | `trigger <id>` | 手動で 1 回トリガー | |
|
||
| | `runs <id>` | 実行履歴を表示 | |
|
||
| | `trigger-add/trigger-update/trigger-delete/trigger-rotate-url` | スケジュールと webhook のトリガーを管理 | |
|
||
| `workspace` | `list/get/create/update/switch` | ワークスペースを管理。`switch` は現在のプロファイルのデフォルトワークスペースを設定 | |
|
||
| | `mcp list/add/update/remove` | ワークスペースの MCP サーバーライブラリを管理 | 書き込みは owner/admin のみ。ここに追加したサーバーはどのエージェントにも割り当てられません — `multica agent mcp add` で割り当てます。`list` は名前と transport のみを表示し、保存されたエントリは書き込み専用でどのロールにも返りません。`--server-config-file` / `--server-config-stdin` はトークンをシェル履歴から守ります |
|
||
| | `member list/invite <email>` | メンバーの表示と招待 | `invite`: `--role`（member または admin。デフォルトは member） |
|
||
| `repo` | `list/add/remove/checkout` | ワークスペースのリポジトリを管理し、ローカルにチェックアウト | `--url`（繰り返し可）；`checkout`: `--ref` |
|
||
| `skill` | `list/get/create/update/delete` | スキルを管理 | |
|
||
| | `import` | URL またはローカルファイルからスキルをインポート | `--url` / `--file`、`--on-conflict`（`fail`、`overwrite`、`rename`、`skip`。デフォルトは `fail`） |
|
||
| | `search <query>` | スキルを検索 | |
|
||
| | `files list/upsert/delete <skill-id>` | スキル内のファイルを管理 | |
|
||
| `squad` | `list/get/create/update/delete` | スクワッドを管理（`delete` はアーカイブ） | |
|
||
| | `member list/add/set-role/remove` | スクワッドのメンバーを管理 | |
|
||
| | `activity <issue-id> <outcome>` | リーダーの評価を記録 | |
|
||
| `chat` | `history`、`thread [id]` | エージェントが現在処理している外部チャットセッションを読み取り | `--limit`、`--before` |
|
||
|
||
### Runtime
|
||
|
||
| コマンド | サブコマンド | 用途 | 主なフラグ |
|
||
| --- | --- | --- | --- |
|
||
| `daemon` | `start` | ローカルデーモンを起動 | `--foreground`、`--device-name`、`--runtime-name`、`--workspaces-root`、`--poll-interval`、`--heartbeat-interval`、`--agent-timeout`（`0` は上限なし）、`--max-concurrent-tasks`、`--no-auto-update`；それぞれに対応する `MULTICA_*` 環境変数があります |
|
||
| | `stop` / `status` / `restart` | 停止、状態の確認、再起動（`restart` は `start` と同じフラグ） | |
|
||
| | `logs` | デーモンのログを表示 | `--follow`、`--lines` |
|
||
| | `disk-usage` | ローカルのディスク使用量を表示 | `--by-workspace`、`--by-task`、`--top` |
|
||
| `runtime` | `list/usage/activity/update/rename/delete` | ランタイムを表示・管理 | `delete`: `--cascade`（紐付くエージェントを解除してデータを保持し、その実行をキャンセル） |
|
||
| | `profile list/create/update/delete` | カスタムランタイムプロファイルを管理 | |
|
||
| | `profile set-path/unset-path <profile-id>` | ローカルの実行ファイルパスを固定（ローカルのみ有効。サーバーには送信されません） | |
|
||
|
||
### Additional
|
||
|
||
| コマンド | サブコマンド | 用途 | 主なフラグ |
|
||
| --- | --- | --- | --- |
|
||
| `auth` | `status` / `logout` | 認証状態を確認。`logout` はローカルに保存されたトークンを削除するだけで、サーバー側のトークンは失効させません | |
|
||
| `user` | `profile get/update` | 現在のユーザーのプロフィールを表示・更新 | |
|
||
| `login` | — | ブラウザでサインインし、すべてのワークスペースを自動設定 | `--token`（値なしで渡すとターミナルで対話的に入力） |
|
||
| `setup` | `cloud`（デフォルト）、`self-host` | サーバーアドレスを保存し、サインインを完了してデーモンを起動 | `self-host`: `--server-url`、`--app-url`、`--port`、`--frontend-port` |
|
||
| `attachment` | `download <attachment-id>`、`upload <path>` | 添付ファイルのダウンロードとアップロード | `download`: `--output-dir`；`upload`: `--task` |
|
||
| `config` | `show`、`set <key> <value>` | 現在のプロファイルのローカル設定を表示・編集 | 優先順位: コマンドラインフラグ > 環境変数 > `config.json` > 組み込みデフォルト。空文字列を設定すると値をクリア |
|
||
| `update` | — | CLI を最新バージョンに更新 | |
|
||
| `version` | — | バージョン情報を表示 | `--output`（`text` または `json`） |
|
||
|
||
## 別のコーディングエージェントから Multica を操作する
|
||
|
||
作業の多くを Codex、Claude Code、Cursor の中で進めているなら、ターミナルに切り替えず
|
||
そこから Multica を操作できます。[Multica CLI skill](https://github.com/multica-ai/multica-cli)
|
||
は、このページのコマンドを安全に扱う方法をそれらのエージェントに教えます。タスクと
|
||
コメントスレッドをトークンを浪費せずに読み、コメントはファイル経由で書き、メンション・
|
||
ステータス変更・アサインが伴う副作用を正しく扱います。
|
||
|
||
認証済みの CLI を通してのみ動作し、それ自体は何の権限も与えません。権限は引き続き
|
||
ログイン、選択中のプロファイル、ワークスペースに由来します。CLI は v0.4.26 以降が必要です。
|
||
Claude Code のプラグインマーケットプレイス、Codex の skill インストーラー、Cursor、
|
||
その他 Markdown の指示を読み込むツールへのインストール方法は、リポジトリの README を
|
||
参照してください。
|
||
|
||
## 次のステップ
|
||
|
||
- [Multica CLI skill](https://github.com/multica-ai/multica-cli) — Codex、Claude Code、Cursor から Multica を操作する。
|
||
- [認証とトークン](/auth-tokens) — PAT の作成、更新、失効。
|
||
- [トラブルシューティング](/troubleshooting) — コマンドのエラーと、いつまでも開始しない実行の診断。
|
||
- [エージェントの作成と設定](/agents-create) — `agent create` 各フィールドの完全な意味。
|