このドキュメントは AI によって自動翻訳されています。不正確な部分がある場合は、英語版 を参照してください。
Dify コマンドラインインターフェース(CLI)は、プロジェクトの初期化からパッケージ化まで、プラグイン開発ワークフローを管理します。このガイドでは、CLI のインストール、プラグインプロジェクトの作成、および Dify インスタンスに接続した実行について説明します。
前提条件
始める前に、以下を準備してください。
- Python 3.12
- Homebrew(macOS のみ。CLI のインストールに使用します)
CLI のインストール
brew tap langgenius/dify
brew install dify
Dify Plugin Daemon リリースページ から最新のバイナリをダウンロードします。x86_64 ホストの場合は dify-plugin-linux-amd64、ARM ホストの場合は dify-plugin-linux-arm64 を選択してください。chmod +x dify-plugin-linux-amd64
sudo mv dify-plugin-linux-amd64 /usr/local/bin/dify
Dify Plugin Daemon リリースページ から dify-plugin-windows-amd64.exe(または dify-plugin-windows-arm64.exe)をダウンロードし、dify.exe にリネームして、そのフォルダを PATH に追加します。
インストールを確認します。
プラグインプロジェクトの作成
以下のコマンドで新しいプラグインプロジェクトを作成します。
プロンプトが表示されたら、必須フィールドを入力します。
Edit profile of the plugin
Plugin name (press Enter to next step): hello-world
Author (press Enter to next step): langgenius
Description (press Enter to next step): hello world example
Repository URL (Optional) (press Enter to next step): Repository URL (Optional)
Enable multilingual README: [✔] English is required by default
Languages to generate:
English: [✔] (required)
→ 简体中文 (Simplified Chinese): [✔]
日本語 (Japanese): [✘]
Português (Portuguese - Brazil): [✘]
Controls:
↑/↓ Navigate • Space/Tab Toggle selection • Enter Next step
python を選択して Enter キーを押すと Python プラグインテンプレートが使用されます。続いて、構築するプラグインの種類を選択します。
Select the type of plugin you want to create, and press `Enter` to continue
Before starting, here's some basic knowledge about Plugin types in Dify:
- Tool: Tool Providers like Google Search, Stable Diffusion, etc. Used to perform specific tasks.
- Model: Model Providers like OpenAI, Anthropic, etc. Use their models to enhance AI capabilities.
- Endpoint: Similar to Service API in Dify and Ingress in Kubernetes. Extend HTTP services as endpoints with custom logic.
- Trigger: Webhook-based providers that turn third-party platform events into workflow start signals.
- Agent Strategy: Implement your own agent strategies like Function Calling, ReAct, ToT, CoT, etc.
Based on the ability you want to extend, Plugins are divided into six types: Tool, Model, Extension, Agent Strategy, Datasource, and Trigger.
- Tool: A tool provider that can also implement endpoints. For example, building a Discord Bot requires both sending and receiving messages.
- Model: Strictly for model providers, no other extensions allowed.
- Extension: For simple HTTP services that extend functionality.
- Agent Strategy: Implement custom agent logic with a focused approach.
- Datasource: Provide datasource for Dify Knowledge Pipeline.
- Trigger: Build webhook integrations that emit events to kick off workflows.
We've provided templates to help you get started. Choose one of the options below:
-> tool
agent-strategy
llm
text-embedding
rerank
tts
speech2text
moderation
extension
datasource
trigger
最低 Dify バージョンの入力を求められたら、空白のままにすると最新バージョンが使用されます。
Edit minimal Dify version requirement, leave it blank by default
Minimal Dify version (press Enter to next step):
CLI はプラグイン名を付けた新しいディレクトリを作成し、基本的なプロジェクト構造をセットアップします。そのディレクトリに移動します。
プラグインの実行
hello-world ディレクトリで、サンプル環境ファイルをコピーします。
.env ファイルを編集して、API キーやその他の設定など、プラグインの環境変数を設定します。デバッグ用の認証情報を取得するには、Dify 環境にログインし、右上の プラグイン をクリックしてから、デバッグアイコンをクリックします。ポップアップウィンドウで API Key と Host Address をコピーします。
INSTALL_METHOD=remote
REMOTE_INSTALL_URL=debug-plugin.dify.dev:5003
REMOTE_INSTALL_KEY=********-****-****-****-************
REMOTE_INSTALL_URL は host:port 形式でホストとポートを結合します。ホストとポートは、プラグインページの API Key カードにまとめて表示されます。
依存関係をインストールして、プラグインを実行します。
pip install -r requirements.txt
python -m main