このドキュメントは AI によって自動翻訳されています。不正確な部分がある場合は、英語版 を参照してください。コマンドのフラグを確認するには、
difyctl help <command> を実行します。
コマンド内の <mode> は、workflow や advanced_chat などのアプリの種類です。各コマンドが受け付ける種類は help で一覧表示できます。それぞれの種類がどのアプリタイプに当たるかは、アプリの検索 を参照してください。
サインインとアカウント
| コマンド | 機能 | 必要な条件 |
|---|---|---|
login | ブラウザでサインインする。 | |
logout | サインアウトし、サーバー上にあるこのマシンのセッションを終了する。 | |
describe account | サインイン中のアカウントを表示する。 | |
get account session | 自分のサインインセッションを一覧表示する。 | |
delete account session | 自分のセッションを 1 つ終了する。 | |
delete account current_session | このコマンドの実行に使っているセッションを終了する。 |
ワークスペースとメンバー
| コマンド | 機能 | 必要な条件 |
|---|---|---|
get workspace | 所属するワークスペースとその ID を一覧表示する。 | |
describe workspace | difyctl が使用中のワークスペースの詳細を表示する。 | |
use workspace Cloud | difyctl を、所属する別のワークスペースに切り替える。 | |
get workspace member | ワークスペースのメンバーを一覧表示する。 | |
invite workspace member | メールアドレスを指定してメンバーを招待する。 | 管理者以上 |
set workspace member_role | メンバーのロールを変更する。 | 管理者以上 |
delete workspace member | メンバーを削除する。 | 管理者以上 |
アプリの検索と確認
| コマンド | 機能 | 必要な条件 |
|---|---|---|
get console_app | サービス API アクセスがオンのアプリを一覧表示する。名前や種類で絞り込むこともできる。 | |
describe console_app | アプリの詳細と、アプリが受け付ける入力を表示する。 | サービス API アクセスがオン |
describe app_info <mode> | アプリの名前、説明、アイコンを表示する。 |
アプリの実行
| コマンド | 機能 | 必要な条件 |
|---|---|---|
run console_app <mode> | アプリを実行し、結果を取得する。 | サービス API アクセスがオン |
upload console_app file | 後の実行で渡すファイルをアップロードする。 | サービス API アクセスがオン |
stop run | 進行中の実行、または人間の入力フォームで一時停止している実行を停止する。 | サービス API アクセスがオン、Workflow アプリと Chatflow アプリのみ |
stop task | ストリーミング中の応答を停止する。 | サービス API アクセスがオン、対象はチャットボット、レガシー Agent アプリ、テキストジェネレーターのみ |
get run event | ワークフロー実行のイベントを追跡する。 | サービス API アクセスがオン |
describe run form | 実行が一時停止した人間の入力フォームを表示する。 | サービス API アクセスがオン |
submit run form | 人間の入力フォームに回答する。 | サービス API アクセスがオン |
get run | アプリの実行を新しい順に一覧表示する。 | サービス API アクセスがオン、Workflow アプリと Chatflow アプリのみ |
describe run | 指定した実行の入力、出力、エラー、所要時間を表示する。 | サービス API アクセスがオン、Workflow アプリと Chatflow アプリのみ |
get run node | 実行の各ノードの処理を表示する。失敗したノードを探すときに使う。 | サービス API アクセスがオン、Workflow アプリと Chatflow アプリのみ |
アプリの構築と変更
| コマンド | 機能 | 必要な条件 |
|---|---|---|
create console_app <mode> | 空の Workflow アプリ、または初期ドラフト付きの Chatflow アプリを作成する。 | エディター以上 |
set app_info <mode> | アプリの名前、説明、アイコンを変更する。 | エディター以上 |
import console_app dsl | DSL ファイルからアプリを作成または更新する。 | エディター以上 |
check console_app dsl | DSL ファイルをインポートせずに、問題がないか検証する。 | エディター以上 |
confirm console_app dsl_import | より新しい Dify バージョンのファイルなど、確認待ちのインポートを完了する。 | エディター以上 |
export console_app dsl | アプリの DSL をエクスポートする。 | サービス API アクセスがオン、エディター以上 |
check console_app dependency | アプリに必要な統合のうち、ワークスペースにないものを一覧表示する。 | サービス API アクセスがオン、エディター以上 |
get console_app env | ドラフトの環境変数を一覧表示する。シークレットの値はマスクされる。 | サービス API アクセスがオン、エディター以上、Workflow アプリと Chatflow アプリのみ |
set console_app env | 環境変数を追加または変更する。 | サービス API アクセスがオン、エディター以上、Workflow アプリと Chatflow アプリのみ |
delete console_app env | 環境変数を削除する。 | サービス API アクセスがオン、エディター以上、Workflow アプリと Chatflow アプリのみ |
test console_app <mode> | ドラフトをテスト実行する。人間の入力フォームで一時停止した実行は、difyctl から続行できない。 | サービス API アクセスがオン、エディター以上 |
test node <mode> | ドラフトのノードを 1 つテストする。 | サービス API アクセスがオン、エディター以上 |
get node_type | サーバーで実行できるノードタイプを一覧表示する。 | |
describe node_type | ノードタイプの設定と既定値を表示する。 | |
get knowledge_base | ワークフローで使えるナレッジベースを一覧表示する。 |
公開とロールバック
| コマンド | 機能 | 必要な条件 |
|---|---|---|
check console_app release | ドラフトを公開できる状態か確認し、変更内容を表示する。 | サービス API アクセスがオン、エディター以上、Workflow アプリと Chatflow アプリのみ |
publish console_app | ドラフトを公開する。 | サービス API アクセスがオン、エディター以上、Workflow アプリと Chatflow アプリのみ |
get console_app version | 公開済みのバージョンを新しい順に一覧表示する。 | サービス API アクセスがオン、エディター以上、Workflow アプリと Chatflow アプリのみ |
restore console_app version | 公開済みのバージョンをドラフトにコピーする。反映するには公開する。 | サービス API アクセスがオン、エディター以上、Workflow アプリと Chatflow アプリのみ |
Web アプリとサービス API
| コマンド | 機能 | 必要な条件 |
|---|---|---|
describe webapp <mode> | Web アプリのオン・オフ、URL、ページ設定を表示する。 | |
set webapp <mode> | Web アプリの設定を変更する。 | エディター以上 |
reset webapp | Web アプリに新しい URL を割り当てる。古い URL は使えなくなる。 | 管理者以上 |
describe service_api | アプリのサービス API アクセスがオンかどうかと、ベース URL を表示する。 | エディター以上 |
set service_api | アプリのサービス API アクセスをオンまたはオフにする。 | 管理者以上 |
統合
| コマンド | 機能 | 必要な条件 |
|---|---|---|
get marketplace plugin | マーケットプレイスで統合を検索する。 | |
get plugin | ワークスペースにインストールされている統合を一覧表示する。 | |
install plugin | マーケットプレイスから統合をインストールする。インストールはバックグラウンドで完了する。 | ワークスペースで統合をインストールする権限 |
describe plugin task | インストールの進行状況を確認する。 | ワークスペースで統合をインストールする権限 |
delete plugin | 統合をアンインストールする。 | ワークスペースで統合をインストールする権限 |
get tool | ワークフローで使えるツールを一覧表示する。 | |
describe tool_provider | ツールプロバイダーの認証情報フォームと、保存済みの認証情報を表示する。 | |
create tool_provider credential | ツールプロバイダーの API キーを保存する。 | 管理者以上 |
set tool_provider credential | 保存済みのツールプロバイダーの認証情報を置き換える。 | 管理者以上 |
get model | モデルを一覧表示し、各モデルが現在使えるかどうかを示す。 | |
describe model_provider | モデルプロバイダーの認証情報フォームと、保存済みの認証情報を表示する。 | |
create model_provider credential | モデルプロバイダーの認証情報を保存する。 | 管理者以上 |
set model_provider credential | 保存済みのモデルプロバイダーの認証情報を置き換える。 | 管理者以上 |
create model credential | Ollama で提供されるモデルなど、個別のモデルの認証情報を保存する。 | 管理者以上 |
set model credential | 個別のモデルについて、保存済みの認証情報を置き換える。 | 管理者以上 |
ワークスペースのスキル セルフホスト
これらのコマンドは、ワークスペースのスキルを管理します。difyctl スキルをコーディングエージェントにインストールする場合は、代わりに install skills を実行してください。
| コマンド | 機能 | 必要な条件 |
|---|---|---|
get skill | ワークスペースのスキルを一覧表示する。キーワードやタグ、またはその両方で絞り込める。 | |
describe skill | 最新バージョンや draft_hash を含む、スキルの詳細を表示する。 | |
get skill version | スキルの公開済みバージョンを一覧表示する。 | |
export skill | スキルのドラフトを zip ファイルとしてダウンロードする。公開済みバージョンをダウンロードするには、get skill version で確認したバージョン ID を --version-id に指定する。 | |
import skill | フォルダからスキルを作成する。--skill-id を指定すると、既存スキルのドラフトをフォルダの内容で置き換える。フォルダにないドラフトのファイルは削除される。--draft-hash に describe skill で確認した draft_hash を指定すると、読み取った後にスキルに加えられた変更をインポートで上書きするのを防げる。 | エディター以上 |
publish skill | スキルのドラフトを新しいバージョンとして公開する。 | エディター以上 |
Agent ナレッジベース Cloud
knowledge_fs コマンドは、Dify で閲覧できる Agent ナレッジベースを読み取ります。コーディングエージェントにナレッジベースを読ませる方法は、コーディングエージェントからナレッジベースを読む を参照してください。
| コマンド | 機能 | 必要な条件 |
|---|---|---|
knowledge_fs ls | ナレッジベース内のドキュメント、または 1 つのドキュメントのセクションを一覧表示する。 | |
knowledge_fs tree | ドキュメントとそのセクションを入れ子のリストで表示する。 | |
knowledge_fs find | 名前またはメタデータでドキュメントを検索する。 | |
knowledge_fs grep | ドキュメント内の語句を完全一致で検索する。 | |
knowledge_fs cat | ドキュメント、またはその中の特定のセクションの内容を出力する。 | |
knowledge_fs stat | 処理が完了したかどうかなど、ドキュメントの詳細を表示する。 | |
knowledge_fs diff | 2 つのドキュメントを比較する。 |
ローカル設定とヘルプ
| コマンド | 機能 | 必要な条件 |
|---|---|---|
help | コマンドを検索し、そのフラグを確認する。 | |
version | difyctl とサーバーのバージョンを表示する。 | |
get config、set config、unset config | difyctl がサーバーの応答を待つ時間を表示、変更、またはリセットする。 | |
refresh cache | サーバーのアップグレード後などに、サーバーのコマンド一覧を再取得する。 | |
delete cache | キャッシュされたコマンド一覧を削除する。 | |
install skills | difyctl スキルをコーディングエージェントのスキルフォルダにインストールする。 |