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

# Scribe CLI:ターミナルとローカルエージェントで署名を管理

> Scribe CLI をインストールし、一度サインインするだけで、ターミナルから署名を管理できます。MCP 経由でローカルの AI エージェントに Scribe のすべてのツールを提供することも可能です。

Scribe CLI(`@scribemail/cli`)は、Scribeのツール群をまるごと手元のマシンで利用できるようにします。次の2つの側面があります:

* **ローカル MCP サーバー**:`scribe mcp` は、ホスト型 MCP サーバーとまったく同じツールを、コマンドを起動できる任意のエージェント(Claude Code、Claude Desktop、Cursor、その他 stdio 対応の MCP クライアント)に提供します。ブラウザーで一度サインインすれば、以降はサインインしたユーザーとして動作します。
* **通常のコマンドライン**:各ツールはサブコマンド(`scribe signatures list`、`scribe campaigns schedule`)としても利用でき、スクリプトやシェル向けに設計された JSON 出力に対応します。

どちらも`mcp.scribe-mail.com`のホスト型サーバーと同じコードから生成されるため、ツール・名称・挙動にずれが生じることはありません。

## インストールとサインイン

<Steps>
  <Step title="npmからインストール">
    Node.js 20以降が必要です。

    ```bash theme={null}
    npm install -g @scribemail/cli
    ```
  </Step>

  <Step title="ブラウザーでサインイン">
    ```bash theme={null}
    scribe login
    ```

    ブラウザーが開き、Scribe アカウントでサインインします。API キーの作成や貼り付けは不要です。認証情報は所有者のみアクセス可能な権限で `~/.config/scribe/credentials.json` に保存され、自動的に更新されます。
  </Step>

  <Step title="Check the session">
    ```bash theme={null}
    scribe whoami
    ```

    サインイン中のユーザー、ワークスペース、トークンの状態を表示します。
  </Step>
</Steps>

<Note>
  サインインするメンバーはワークスペースの**オーナーまたは管理者**である必要があり、ワークスペースのプランに API アクセスが含まれている必要があります。1回のログインは1つのワークスペースに紐づきます。切り替えるには `scribe login` を再度実行してください。
</Note>

## MCP経由でローカルエージェントに提供

```bash theme={null}
claude mcp add --scope user scribe -- scribe mcp
```

JSON で構成されたクライアント(Claude Desktop、Cursor など)の場合:

```json theme={null}
{
  "mcpServers": {
    "scribe": {
      "command": "scribe",
      "args": ["mcp"]
    }
  }
}
```

エージェントをローカルで実行し、すでにサインイン済みのターミナルセッションとしてツール呼び出しを実行したい場合、またはクライアントが stdio のみに対応している場合は、ホスト型エンドポイントよりも CLI を選んでください。ホスト型エンドポイント([アシスタントを接続](/ja/ai-agents/connect) を参照)は、Web 版 Claude や ChatGPT などのチャットアシスタントに適しています。

## シェルから使う

結果は stdout に JSON で出力され、エラーは stderr に読みやすいテキストで出力されます。

```bash theme={null}
scribe signatures list --limit 10
scribe signatures create --name "Sales" --draft-content @tree.json
scribe signatures publish --id 0c9f…
scribe teammates list --auto-paginate
scribe analytics views --start-date 2026-07-01 --end-date 2026-08-01 --group-by signature_template
scribe docs search "dns setup"
```

便利な規約:

* `scribe tools` はすべての MCP ツールとその CLI コマンドを一覧表示します。`scribe call <tool_name> --json '{...}'` は正確な MCP 名で任意のツールを呼び出します。
* 署名コンテンツツリーなどの複雑なフィールドは、インライン JSON、`@file`、または stdin 用の `-` を受け付けます。`--json` で引数オブジェクト全体を指定でき、明示的なフラグはそれを上書きします。
* ブール値は `--flag` / `--no-flag` です。両方を省略するとフィールド自体が省略されるため、部分更新で値が誤って上書きされることはありません。
* 終了コード:`0` 成功、`1` API またはツールのエラー、`2` 使用方法のエラー、`3` 未サインイン。

## 分野別コマンド

| グループ | コマンド |
| - | - |
| `signatures` | `list` `create` `update` `delete` `publish` `install` `preview` `html` `installations` |
| `signatures variants` | `list` `update` `publish` `delete` |
| `signatures recipients` | `list` `add` `remove` `set-rules` `add-entities` `remove-entities` |
| `teammates`、`emails`、`smart-fields`、`folders`、`assets` | `list` `create` `update` `delete` |
| `campaigns` | `list` `create` `update` `delete` `preview` `schedule` `pause` `resume` |
| `analytics` | `views` `clicks` `events` `events-summary` |
| `visitors` | `list` `get` `breakdown` |
| `integrations` | `list` `entities` |
| トップレベル | `workspace` · `billing documents` · `content-schema` · `docs search` · `docs read` · `feedback` |
| セッション | `login` · `logout` · `whoami` · `mcp` · `tools` · `call` |

ツールごとの動作は MCP ツールと同一です。[ツールリファレンス](/ja/ai-agents/tools)を参照してください。

## SSH 経由での利用

サインインには、CLI を実行しているマシン上で `127.0.0.1` にアクセスできるブラウザーが必要です。リモートマシンでは、コールバックポートを転送し、ブラウザーを開く代わりに URL を出力してください:

```bash theme={null}
ssh -L 8976:127.0.0.1:8976 yourserver
scribe login --no-browser
```

出力された URL をローカルのブラウザーで開いてください。

## 次のステップ

<CardGroup cols={2}>
  <Card title="ツールリファレンス" icon="wrench" href="/ja/ai-agents/tools">
    Scribeの全ツールを領域別に整理
  </Card>

  <Card title="スキル" icon="book" href="/ja/ai-agents/skills">
    アシスタントにScribeのワークフロー全体を習得させる
  </Card>

  <Card title="トラブルシューティング" icon="bug" href="/ja/ai-agents/troubleshooting">
    接続やツールの問題を解決
  </Card>

  <Card title="APIリファレンス" icon="code" href="/api-reference/introduction">
    CLI と MCP サーバーの基盤となる REST API
  </Card>
</CardGroup>


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