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

# クイックスタート

> difyctl をインストールしてサインインし、difyctl スキルでコーディングエージェントをセットアップする。自分で実行するコマンドの探し方も紹介する

> このドキュメントは AI によって自動翻訳されています。不正確な部分がある場合は、[英語版](https://docs.dify.ai/en/cli/get-started.md) を参照してください。

> [!NOTE]
>
> Dify 1.18.0 より前から `difyctl` を使っていた場合、サーバーが 1.18.0 以降になると、古いビルドは動作しなくなります。コマンドとサインイン方法が変わっているため、[Dify 1.18.0 へのアップグレード](https://docs.dify.ai/ja/cli/upgrade-across-1-18.md) から始めてください。

> [!TIP]
>
> このセットアップをコーディングエージェントに任せるには、このページをエージェントに渡してください。その場合も、サインインはブラウザから自分で承認します。

## 前提条件

Dify Cloud の場合は、そのままインストールに進めます。

セルフホストのサーバーの場合は、次の点を確認してください：

* Dify のバージョンが 1.18.0 以降であること。1.17.x 以前の場合は、[その Dify バージョンのドキュメント](https://github.com/langgenius/dify-docs/branches/all?query=release%2F) を参照してください。
* [`OPENAPI_ENABLED` と `ENABLE_OAUTH_BEARER`](https://docs.dify.ai/ja/self-host/deploy/configuration/environments#dify-cli-とプログラマティック-api) が `true` に設定されていること。

## インストール

> [!NOTE]
>
> `brew install dify` でインストールされるのは、`difyctl` ではなく [Dify のプラグイン開発用 CLI](https://docs.dify.ai/ja/develop-plugin/getting-started/cli.md) です。

**1. インストーラーの実行**

> [tab] macOS / Linux
>
> x64 と arm64 をサポートしています。
>
> ```bash theme={null}
> curl -fsSL https://raw.githubusercontent.com/langgenius/dify/main/cli/scripts/install-cli.sh | sh
> ```
>
> このコマンドは、Dify の最新リリースのビルドをインストールします。セルフホストのサーバーが最新リリースでない場合は、`DIFY_VERSION` にサーバーのバージョンを指定します：
>
> ```bash theme={null}
> curl -fsSL https://raw.githubusercontent.com/langgenius/dify/main/cli/scripts/install-cli.sh | DIFY_VERSION=1.18.0 sh
> ```
>
> スクリプトはダウンロードしたファイルのチェックサムを検証し、`~/.local/bin/difyctl` にインストールします。

> [tab] Windows
>
> 対応プラットフォーム：x64。
>
> ```powershell theme={null}
> irm https://raw.githubusercontent.com/langgenius/dify/main/cli/scripts/install.ps1 | iex
> ```
>
> このコマンドは、Dify の最新リリースのビルドをインストールします。セルフホストのサーバーが最新リリースでない場合は、先に `DIFY_VERSION` にサーバーのバージョンを設定します：
>
> ```powershell theme={null}
> # この PowerShell セッションの間は有効
> $env:DIFY_VERSION = "1.18.0"
> irm https://raw.githubusercontent.com/langgenius/dify/main/cli/scripts/install.ps1 | iex
> ```
>
> スクリプトはダウンロードしたファイルのチェックサムを検証し、`%LOCALAPPDATA%\difyctl\bin\difyctl.exe` にインストールします。

> [tab] 手動ダウンロード
>
> 1. [Dify の GitHub Releases](https://github.com/langgenius/dify/releases) から、サーバーの Dify バージョンに合うリリースを選び、2 つのアセットをダウンロードします：
>
>    * お使いのプラットフォーム向けのバイナリ（`difyctl-v<version>-<os>-<arch>`）
>    * チェックサムマニフェスト（`difyctl-v<version>-checksums.txt`）
>
> 2. バイナリの SHA-256 ハッシュを計算し、チェックサムファイル内の対応するエントリと比較します。
>
>    値が一致しない場合、ダウンロードしたファイルは破損しているか改ざんされています。削除して再度ダウンロードしてください。
>
>    ```bash macOS theme={null}
>    shasum -a 256 difyctl-v<version>-darwin-<arch>
>    ```
>
>    ```bash Linux theme={null}
>    sha256sum difyctl-v<version>-linux-<arch>
>    ```
>
>    ```powershell Windows theme={null}
>    Get-FileHash difyctl-v<version>-windows-x64.exe
>    ```
>
> 3. バイナリを `PATH` の通ったディレクトリに配置します：
>
>    ```bash macOS / Linux theme={null}
>    chmod +x difyctl-v<version>-<os>-<arch>
>    mkdir -p ~/.local/bin
>    mv difyctl-v<version>-<os>-<arch> ~/.local/bin/difyctl
>    ```
>
>    ```powershell Windows theme={null}
>    New-Item -ItemType Directory -Force "$env:LOCALAPPDATA\difyctl\bin" | Out-Null
>    Move-Item difyctl-v<version>-windows-x64.exe "$env:LOCALAPPDATA\difyctl\bin\difyctl.exe"
>    ```

> [!TIP]
>
> 別のフォルダにインストールする場合や、その他のインストール設定を変更する場合は、[設定](https://docs.dify.ai/ja/cli/reference/configuration.md) を参照してください。

**2. インストールの確認**

```bash theme={null}
difyctl version
```

`command not found` が表示される場合は、インストールディレクトリが `PATH` に含まれていません。次のように追加します：

```bash macOS / Linux theme={null}
# ~/.zshrc または ~/.bashrc に追加する。その場で実行しただけでは、セッションが終わるまでしか有効にならない
export PATH="$HOME/.local/bin:$PATH"
```

```powershell Windows theme={null}
[Environment]::SetEnvironmentVariable('PATH', "$env:LOCALAPPDATA\difyctl\bin;" + [Environment]::GetEnvironmentVariable('PATH', 'User'), 'User')
# その後、新しいターミナルを開く
```

## サインイン

**1. サインインの開始**

ブラウザで Dify を開く際のアドレスを指定します（Dify Cloud の場合は `https://cloud.dify.ai`）：

```bash theme={null}
difyctl login --server https://dify.example.com
```

SSH 経由での実行時などブラウザが開かない場合は、`difyctl` が表示した URL を任意のデバイスで開いてください。

ローカルサーバーが `http://` や自己署名証明書を使っている場合は、`--insecure` を追加します。この設定は、`--insecure` なしでサインインし直すまで、以降のすべてのコマンドに適用されます。ローカル開発以外では使わないでください。

**2. ブラウザでの承認**

**difyctl を認証** ページで `difyctl` が表示したコードを入力し、**続ける** をクリックします。コードの有効期限は 15 分です。

ページにアカウントとワークスペースが表示されたら、どちらも正しいことを確認してから **認証する** をクリックします。`difyctl` とコーディングエージェントは、このアカウントとして動作します。このアカウントでできることは、すべて実行できます。意図しないアカウントの場合は、**キャンセル** をクリックし、正しいアカウントで Dify にサインインしてから、もう一度サインインを開始します。

`difyctl` は、ページに表示されたワークスペースで動作します。別のワークスペースを使う場合は、サインイン後に [`difyctl` のワークスペースを切り替えます](https://docs.dify.ai/ja/cli/manage-sign-in#switch-your-workspace)。

後でサインインし直す場合やサインアウトする場合は、[サインインの管理](https://docs.dify.ai/ja/cli/manage-sign-in.md) を参照してください。サインインに失敗した場合は、[トラブルシューティング](#トラブルシューティング) を参照してください。

## アプリの一覧表示

サインインしたワークスペース内のアプリを一覧表示して、`difyctl` が動作することを確認します：

```bash theme={null}
difyctl get console_app
```

一覧に表示されるのは、サービス API アクセスがオンになっているアプリだけです。

## コーディングエージェントのセットアップ

`difyctl` スキルは、コーディングエージェントに `difyctl` の使い方を教えます。使用するコーディングエージェントごとに、そのエージェントのスキルフォルダにスキルをインストールします：

```bash theme={null}
# Claude Code
difyctl install skills ~/.claude/skills

# Codex、Cursor、Gemini CLI、GitHub Copilot、OpenCode など、ほとんどのエージェント
difyctl install skills ~/.agents/skills
```

その他のエージェントの場合は、スキルフォルダの場所をそのエージェントのドキュメントで確認してください。エージェントがスキルを認識しない場合は、再起動してください。

### コマンドと API キーの管理

シェルコマンドの実行前に承認を求めるエージェント側の設定は、オンのままにしておいてください。`difyctl` 自体は、コマンドを実行する前に確認を求めません。スキルは、統合のインストールやアプリの公開を行う前に、あなたに確認するようエージェントに指示しています。`help` で [`destructive` と表示される](https://docs.dify.ai/ja/cli/find-and-run-commands#コマンドの実行) コマンドや、ラベルのないコマンドを実行する前も同様です。ただし、実際に確認するかどうかは、エージェントが使う AI モデル次第です。

> [!TIP]
>
> エージェントに確認なしで情報を調べさせるには、`difyctl get`、`difyctl describe`、`difyctl knowledge_fs` Cloud を許可します。いずれもサーバーからの読み取りしか行いません。

モデルプロバイダーの API キーなど、チャットに入力した内容はすべてエージェントのモデルを経由します。キーをモデルに渡したくない場合は、事前に自分で Dify にキーを追加しておくか、求められた時点で自分で追加するとエージェントに伝えてください。

## 自分でコマンドを探す方法

作業内容を短い言葉で `help` に伝えると、一致するコマンドが一覧表示されます。たとえば、アプリを公開するコマンドを探すには、次のように実行します：

```bash theme={null}
difyctl help publish app
```

一覧から探す場合は、`difyctl help` を実行します。コマンドへの値の渡し方や、結果に含まれるヒントに従う方法については、[コマンドの検索と実行](https://docs.dify.ai/ja/cli/find-and-run-commands.md) を参照してください。

## 次のステップ

次の作業は、エージェントに依頼することも、自分で行うこともできます：

* [Workflow アプリと Chatflow アプリの構築、変更、公開](https://docs.dify.ai/ja/cli/build-apps.md)
* [アプリの実行](https://docs.dify.ai/ja/cli/run-apps.md)
* [DSL ファイルからのアプリの作成と更新](https://docs.dify.ai/ja/cli/create-and-update-apps-from-dsl-files.md)
* [CI と自動化での `difyctl` の使用](https://docs.dify.ai/ja/cli/scripts-and-ci)

## トラブルシューティング

| メッセージ | 対処方法 |
| :- | :- |
| `only https:// hosts are accepted` | `https://` のアドレスを使う。ローカルの `http://` サーバーでは、`--insecure` を追加する。 |
| `network error calling POST <server>/openapi/v1/oauth/device/code` | サーバーのアドレスとネットワークを確認する。 サーバーの証明書を `difyctl` が検証できない場合も、同じエラーで失敗する。自己署名証明書を使うローカルサーバーでは、`--insecure` を追加する。 |
| `this Dify host does not implement the OAuth device flow` | サーバーのアドレスを確認する。Dify Cloud では `https://cloud.dify.ai` を使う。 セルフホストのサーバーでアドレスが正しい場合は、`OPENAPI_ENABLED` が `true` に設定されていることを確認する。 |
| ブラウザ：`こちら側で問題が発生しました。しばらくしてからもう一度お試しください。` | セルフホストのサーバーでは、`ENABLE_OAUTH_BEARER` が `true` に設定されていることを確認する。 |
| `authorization denied` | ブラウザで **キャンセル** がクリックされた。もう一度 `login` を実行する。 |
| `code expired before authorization` | 15 分以内にコードが承認されなかった。もう一度 `login` を実行する。 |
| `OS keychain is unreachable` | `--no-keyring` を付けてサインインし直し、トークンをファイルに保存する。 |


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