Skip to content

Commit 3e65a35

Browse files
bowenliang123bowenliang123
committed
update plugin cli guide
1 parent 9ef04ec commit 3e65a35

16 files changed

+137
-94
lines changed

‎en/SUMMARY.md

Whitespace-only changes.

‎en/link-check-report.md

Whitespace-only changes.

‎en/plugins/publish-plugins/package-plugin-file-and-publish.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ After completing plugin development, you can package your plugin project as a lo
88

99
You'll need the Dify plugin development scaffolding tool for packaging plugins. Download the tool from the [official GitHub releases page](https://github.com/langgenius/dify-plugin-daemon/releases).
1010

11-
See the [Initialize Development Tools](../quick-start/develop-plugins/initialize-development-tools.mdx) tutorial for dependency installation and configuration steps.
11+
See the [Install Development Tools](../quick-start/develop-plugins/initialize-development-tools.mdx) tutorial for dependency installation and configuration steps.
1212

1313
Select and download the version appropriate for your operating system from the release assets.
1414

‎en/plugins/quick-start/develop-plugins/README.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ title: Develop Plugins
77

88
You can quickly understand how to develop different types of plugins and master the functional components involved in plugin development through these development examples:
99

10-
<Card title="Initialize Development Tools" icon="link" href="/en/plugins/quick-start/develop-plugins/initialize-development-tools">
10+
<Card title="Install Development Tools" icon="link" href="/en/plugins/quick-start/develop-plugins/initialize-development-tools">
1111
</Card>
1212

1313
Using the **Google Search** tool as an example to demonstrate how to develop tool-type plugins. For more details, please take refer to the following:

‎en/plugins/quick-start/develop-plugins/initialize-development-tools.mdx

+40-25
Original file line numberDiff line numberDiff line change
@@ -1,52 +1,67 @@
11
---
2-
title: Initialize Development Tools
2+
title: Install Development Tools
33
---
44

5+
Before start to develop Dify plugins, please prepare the following prerequisites:
6+
* [Dify Plugin CLI tool](https://github.com/langgenius/dify-plugin-daemon?tab=readme-ov-file#cli)
7+
* Python 3.12+
58

6-
Before start to develop Dify plugins please prepare the following prerequisites:
9+
### **1. Install Dify Plugin CLI Tool**
710

8-
* Dify plugin scaffolding tool
9-
* Python environment, version ≥ 3.12
11+
The Dify Plugin CLI Tool can be installed either with from Homebrew (on Linux and MacOS) or with the standalone binary executable file (on Windows, Linux and MacOS).
1012

11-
> The Dify plugin development scaffolding tool, also known as `dify-plugin-daemon`, can be regarded as a plugin development SDK.
13+
#### Install with Homebrew
1214

13-
### **1. Installing the Dify Plugin Development Scaffolding Tool**
15+
For the macOS and Linux users, installing Dify Plugin CLI with [Homebrew](https://brew.sh/) is recommended.
1416

15-
Visit the [Dify plugin GitHub page](https://github.com/langgenius/dify-plugin-daemon/releases) and select and download the version suitable for your operating system.
17+
Tap the [Homebrew formula for Dify Plugin CLI tool](https://github.com/langgenius/homebrew-dify), and then install it with `brew install`.
1618

17-
Using **macOS with M-series chips** as an example: Download the `dify-plugin-darwin-arm64` file from the project address mentioned above. Then, in the terminal, navigate to the file's location and grant it execution permissions:
19+
```bash
20+
brew tap langgenius/dify
21+
brew install dify
22+
```
1823

24+
To check the installation, run `dify version` and a version code should be displayed.
25+
```bash
26+
dify version
1927
```
20-
chmod +x dify-plugin-darwin-arm64
28+
29+
To upgrade the Dify Plugin CLI tool, run the following command:
30+
31+
```bash
32+
brew upgrade dify
2133
```
2234

23-
Run the following command to verify successful installation.
35+
#### Install with binary executable
36+
37+
1. Download the binary executable
38+
39+
On the asset list of the release page of [Dify Plugin CLI Tool](https://github.com/langgenius/dify-plugin-daemon/releases), choose and download the binary executable for the OS system (Linux / macOS / Windows) and the chip architecture (`amd64` for x86 chips / `arm64` for ARM or Apple's M chips).
2440

41+
Using **MacOS with M chips** as an example. Download the `dify-plugin-darwin-arm64` file and grant it execution permissions by running the command:
42+
```bash
43+
chmod +x ./dify-plugin-darwin-arm64
44+
mv ./dify-plugin-darwin-arm64 ./dify
2545
```
26-
./dify-plugin-darwin-arm64 version
46+
47+
To check the installation, run `./dify version` and a version code should be displayed.
48+
```bash
49+
./dify version
2750
```
2851

2952
> If the system shows an "Apple cannot verify" error, go to **Settings → Privacy & Security → Security**, and click the "Open Anyway" button.
3053
31-
After running the command, the installation is successful, if the terminal returns version information like `v0.0.1-beta.15`.
3254

3355
<Info>
34-
**Tips:**
35-
36-
If you want to use the `dify` command globally in your system to run the scaffolding tool, it's recommended to rename the binary file to `dify` and copy it to the `/usr/local/bin` system path.
37-
38-
After configuration, entering the `dify version` command in the terminal will output the version number.
39-
40-
<img
41-
src="https://assets-docs.dify.ai/2025/01/74e57a57c1ae1cc70f4a45084cbbb37e.png"
42-
className="mx-auto"
43-
alt=""
44-
/>
56+
**Tips:**
57+
To use `dify` command globally system-wide, it's recommended to rename the binary file to `dify` and copy it to the
58+
`/usr/local/bin` system path.
4559
</Info>
4660

47-
### **2. Initialize Python Environment**
61+
### **2. Install Python**
62+
63+
Python version 3.12 or higher is required. Python installer is available on [python.org](https://www.python.org/downloads/).
4864

49-
For detailed instructions, please refer to the [Python installation](https://pythontest.com/python/installing-python-3-11/) tutorial. Python version 3.12 or higher is required.
5065

5166
### 3. **Develop plugins**
5267

‎invalid_links_report.md

+10-10
Original file line numberDiff line numberDiff line change
@@ -373,11 +373,11 @@
373373
| 163 | extension-plugin.md | extension-plugin |
374374
| 163 | 扩展 Agent 策略 | ../../schema-definition/agent |
375375
| 163 | 扩展 Agent 策略 | ../../schema-definition/agent |
376-
| 164 | 初始化开发工具 | plugins/quick-start/develop-plugins/initialize-development-tools |
376+
| 164 | 安装插件开发工具 | plugins/quick-start/develop-plugins/initialize-development-tools |
377377
| 164 | agent-strategy-plugin.md | agent-strategy-plugin |
378378
| 164 | bundle.md | bundle |
379379
| 165 | Tool 插件 | plugins/quick-start/develop-plugins/tool-plugin |
380-
| 165 | 初始化开发工具 | initialize-development-tools |
380+
| 165 | 安装插件开发工具 | initialize-development-tools |
381381
| 165 | 接口文档 | ../../schema-definition/ |
382382
| 165 | ProviderConfig | ../../schema-definition/general-specifications.md#providerconfig |
383383
| 165 | 工具接口文档 | ../../schema-definition/tool |
@@ -390,28 +390,28 @@
390390
| 165 | 反向调用 Dify 能力 | ../../schema-definition/reverse-invocation-of-the-dify-service/ |
391391
| 165 | 工具 | ../../schema-definition/tool |
392392
| 165 | 模型 | ../../schema-definition/model/ |
393-
| 165 | 初始化开发工具 | initialize-development-tools |
394-
| 165 | 初始化开发工具 | initialize-development-tools |
393+
| 165 | 安装插件开发工具 | initialize-development-tools |
394+
| 165 | 安装插件开发工具 | initialize-development-tools |
395395
| 165 | 接口文档 | ../../schema-definition/ |
396396
| 165 | Bundle 插件：将多个插件打包 | bundle |
397397
| 165 | Manifest | ../../schema-definition/manifest |
398398
| 165 | Endpoint | ../../schema-definition/endpoint |
399399
| 165 | 反向调用 Dify 能力 | ../../schema-definition/reverse-invocation-of-the-dify-service/ |
400400
| 165 | 工具 | ../../schema-definition/tool |
401401
| 165 | 模型 | ../../schema-definition/model/ |
402-
| 165 | 初始化开发工具 | initialize-development-tools |
402+
| 165 | 安装插件开发工具 | initialize-development-tools |
403403
| 165 | Manifest | ../../schema-definition/manifest |
404404
| 166 | Model 插件 | plugins/quick-start/develop-plugins/model-plugin/README |
405405
| 166 | 创建模型供应商 | create-model-providers |
406406
| 166 | 预定义 | ../../../../guides/model-configuration/predefined-model |
407407
| 166 | 自定义 | customizable-model |
408408
| 166 | 调试插件 | ../../debug-plugins |
409409
| 167 | 创建模型供应商 | plugins/quick-start/develop-plugins/model-plugin/create-model-providers |
410-
| 167 | 初始化开发工具 | ../initialize-development-tools |
410+
| 167 | 安装插件开发工具 | ../initialize-development-tools |
411411
| 167 | 模型接口文档 | ../../../schema-definition/model/model-schema |
412412
| 167 | 接入预定义模型 | ../../../../guides/model-configuration/predefined-model |
413413
| 167 | 接入自定义模型 | ../../../../guides/model-configuration/customizable-model |
414-
| 167 | 初始化开发工具 | ../initialize-development-tools |
414+
| 167 | 安装插件开发工具 | ../initialize-development-tools |
415415
| 168 | 接入预定义模型 | plugins/quick-start/develop-plugins/model-plugin/integrate-the-predefined-model |
416416
| 168 | 模型供应商 | create-model-providers |
417417
| 168 | AIModelEntity | ../../../schema-definition/model/model-designing-rules.md#aimodelentity |
@@ -546,7 +546,7 @@
546546
| 196 | 发布至个人 GitHub 仓库 | plugins/publish-plugins/publish-plugin-on-personal-github-repo |
547547
| 196 | 打包插件 | broken-reference |
548548
| 197 | 本地发布与分享 | plugins/publish-plugins/package-plugin-file-and-publish |
549-
| 197 | 初始化开发工具 | ../quick-start/develop-plugins/initialize-development-tools |
549+
| 197 | 安装插件开发工具 | ../quick-start/develop-plugins/initialize-development-tools |
550550
| 197 | 远程连接测试 | ../quick-start/develop-plugins/extension-plugin.md#tiao-shi-cha-jian |
551551
| 198 | 常见问题 | plugins/faq |
552552
| 202 | 后端 | development/backend/README |
@@ -700,7 +700,7 @@
700700
| 122 | 使用全套开源工具构建 LLM 应用实战：在 Dify 调用 Baichuan 开源模型能力 | learn-more/use-cases/practical-implementation-of-building-llm-applications-using-a-full-set-of-open-source-tools |
701701
| 126 | 开发 Slack Bot 插件 | plugins/best-practice/develop-a-slack-bot-plugin |
702702
| 126 | 开发 Slack Bot 插件 | plugins/best-practice/develop-a-slack-bot-plugin |
703-
| 128 | 初始化开发工具 | ../initialize-development-tools |
703+
| 128 | 安装插件开发工具 | ../initialize-development-tools |
704704
| 128 | 快速开始：开发 Extension 插件 | ../extension-plugin |
705705
| 128 | 反向调用：App | ../../../schema-definition/reverse-invocation-of-the-dify-service/app |
706706
| 128 | 开发 Extension 插件 | ../extension-plugin |
@@ -747,7 +747,7 @@
747747

748748
| 行号 | 链接文本 | 链接 URL |
749749
|------|----------|----------|
750-
| 42 | 初始化开发工具 | ../initialize-development-tools |
750+
| 42 | 安装插件开发工具 | ../initialize-development-tools |
751751
| 64 | 快速开始：开发 Extension 插件 | ../extension-plugin |
752752
| 76 | 反向调用：App | ../../../schema-definition/reverse-invocation-of-the-dify-service/app |
753753
| 316 | 开发 Extension 插件 | ../extension-plugin |

‎ja-jp/plugins/quick-start/develop-plugins/initialize-development-tools.mdx

+39-28
Original file line numberDiff line numberDiff line change
@@ -2,56 +2,67 @@
22
title: 開発環境のセットアップ
33
---
44

5+
Difyプラグインの開発を始める前に、以下の前提条件を準備してください：
6+
* [DifyプラグインCLIツール](https://github.com/langgenius/dify-plugin-daemon?tab=readme-ov-file#cli)
7+
* Python 3.12+
58

6-
Difyプラグインを開発する前に、次の準備を整えましょう。
9+
### **1. DifyプラグインCLIツールのインストール**
710

8-
* Difyプラグイン用のスキャフォールディングツール
9-
* バージョン3.12以上のPython環境
11+
DifyプラグインCLIツールは、Homebrew（LinuxおよびMacOS）またはスタンドアロンのバイナリ実行ファイル（Windows、Linux、MacOS用）を使用してインストールできます。
1012

11-
### **1. Difyプラグインスキャフォールディングツールのインストール方法**
13+
#### Homebrewでインストール
1214

13-
> Dify プラグイン開発スキャフォールディングツール、別名 `dify-plugin-daemon` は、プラグイン開発 SDK として見なすことができます。
15+
MacOSおよびLinuxユーザーには、[Homebrew](https://brew.sh/)を使用したDifyプラグインCLIのインストールを推奨します。
1416

15-
[DifyプラグインのGitHubページ](https://github.com/langgenius/dify-plugin-daemon/releases) へアクセスし、ご利用のオペレーティングシステムに適したバージョンをダウンロードしてください。
16-
17-
**Mシリーズチップ搭載のmacOS**向けのダウンロード例：プロジェクトページから`dify-plugin-darwin-arm64`をダウンロードし、ターミナルを開いてファイルのあるディレクトリに移動した後、以下のコマンドで実行権限を付与します：
17+
[DifyプラグインCLIツールのHomebrewフォーミュラ](https://github.com/langgenius/homebrew-dify)をタップし、`brew install`でインストールします。
1818

19+
```bash
20+
brew tap langgenius/dify
21+
brew install dify
1922
```
20-
chmod +x dify-plugin-darwin-arm64
23+
24+
インストールを確認するために、`dify version`を実行すると、バージョンコードが表示されます。
25+
```bash
26+
dify version
2127
```
2228

23-
インストールが成功したかどうかを確認するには、次のコマンドを実行します。
29+
DifyプラグインCLIツールをアップグレードするには、次のコマンドを実行します：
2430

25-
```
26-
./dify-plugin-darwin-arm64 version
31+
```bash
32+
brew upgrade dify
2733
```
2834

29-
> システムが「Appleによって検証されていません」と警告を出す場合は、**設定 → セキュリティとプライバシー → セキュリティ**ボタンを開き、「とにかく開く」を選択してください。
35+
#### バイナリ実行ファイルでインストール
3036

31-
コマンドを実行し、`v0.0.1-beta.15`などのバージョン情報が表示されれば、インストール完了です。
37+
1. バイナリ実行ファイルをダウンロードします。
3238

33-
<Info>
34-
**Tips:**
39+
[DifyプラグインCLIツールのリリースページ](https://github.com/langgenius/dify-plugin-daemon/releases)のアセットリストから、OSシステム（Linux / MacOS / Windows）とチップアーキテクチャ（`amd64`はx86チップ、`arm64`はARMまたはAppleのMチップ用）のバイナリ実行ファイルを選択してダウンロードします。
3540

36-
`dify`コマンドをシステム全体で利用したい場合は、ダウンロードしたバイナリファイルの名前を`dify`に変更し、`/usr/local/bin`にコピーすることをお勧めします。
41+
**MチップのMacOS**を例にとると、`dify-plugin-darwin-arm64`ファイルをダウンロードし、次のコマンドを実行して実行権限を付与します：
42+
```bash
43+
chmod +x ./dify-plugin-darwin-arm64
44+
mv ./dify-plugin-darwin-arm64 ./dify
45+
```
3746

38-
この設定を行うと、ターミナルから`dify version`と入力するだけで、インストールされたバージョンを確認できます。
47+
インストールを確認するために、`./dify version`を実行すると、バージョンコードが表示されます。
48+
```bash
49+
./dify version
50+
```
3951

40-
<img
41-
src="https://assets-docs.dify.ai/2025/01/74e57a57c1ae1cc70f4a45084cbbb37e.png"
42-
alt=""
43-
/>
44-
</Info>
52+
> システムに「Appleは確認できません」というエラーが表示された場合は、**設定 → プライバシーとセキュリティ → セキュリティ**に移動し、「今すぐ開く」ボタンをクリックします。
4553
46-
### **2. Initialize Python Environment**
54+
<Info>
55+
**ヒント:**
56+
`dify`コマンドをグローバルにシステム全体で使用するには、バイナリファイルの名前を`dify`に変更し、`/usr/local/bin`システムパスにコピーすることを推奨します。
57+
</Info>
4758

48-
For detailed instructions, please refer to the [Python installation](https://pythontest.com/python/installing-python-3-11/) tutorial, or ask the LLM for complete installation instructions.
59+
### **2. Pythonのインストール**
4960

50-
### **2. Python環境の設定**
61+
Pythonのバージョンは3.12以上が必要です。Pythonのインストーラは[python.org](https://www.python.org/downloads/)で入手できます。
5162

52-
Pythonのインストール方法については、[Pythonインストール](https://pythontest.com/python/installing-python-3-11/)チュートリアルを参照するか、LLMに詳細な手順を尋ねてみてください。
63+
### **3. プラグインの開発**
5364

54-
### **3. プラグインの開発について**
65+
さまざまなタイプのプラグイン開発の例については、以下の内容を参照してください。
5566

5667
さまざまなタイプのプラグイン開発の具体例については、以下のリンクをご参照ください。
5768

‎zh-hans/plugins/best-practice/develop-a-slack-bot-plugin.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ Slack 是一个自由开放的实时办公通信平台，拥有丰富的 API。
3838

3939
### 前置准备
4040

41-
* Dify 插件脚手架工具，详细说明请参考[初始化开发工具](../initialize-development-tools)。
41+
* Dify 插件脚手架工具，详细说明请参考[安装插件开发工具](../initialize-development-tools)。
4242
* Python 环境，版本号 ≥ 3.12，详细说明请参考 [Python 安装教程](https://pythontest.com/python/installing-python-3-11/)，或询问 LLM 获取完整的安装教程。
4343
* 创建 Slack App 并获取 OAuth Token
4444

‎zh-hans/plugins/publish-plugins/package-plugin-file-and-publish.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ title: 打包为本地文件与分享
1515

1616
### 前置准备
1717

18-
* **Dify 插件开发工具**，详细说明请参考[初始化开发工具](../quick-start/develop-plugins/initialize-development-tools)。
18+
* **Dify 插件开发工具**，详细说明请参考[安装插件开发工具](../quick-start/develop-plugins/initialize-development-tools)。
1919

2020
配置完成后，在终端输入 `dify version` 命令，检查是否输出版本号信息以确认已安装必要的开发工具。
2121

‎zh-hans/plugins/quick-start/develop-plugins/README.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ description: 'Author: Yeuoly, Allen'
88

99
你可以通过以下**插件开发示例**，了解如何开发不同类型的插件，快速上手并掌握插件开发过程中可能涉及的功能组件。正式开始插件开发前，需要在本地环境中安装并初始化开发脚手架。请参考以下内容：
1010

11-
<Card title="初始化开发工具" icon="link" href="./initialize-development-tools">
11+
<Card title="安装插件开发工具" icon="link" href="./initialize-development-tools">
1212
initialize-development-tools.md
1313
</Card>
1414

‎zh-hans/plugins/quick-start/develop-plugins/agent-strategy-plugin.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ Agent 策略插件能够帮助 LLM 执行推理或决策逻辑，包括工具选
1111
* Dify 插件脚手架工具
1212
* Python 环境，版本号 ≥ 3.12
1313

14-
关于如何准备插件开发的脚手架工具，详细说明请参考[初始化开发工具](initialize-development-tools)。
14+
关于如何准备插件开发的脚手架工具，详细说明请参考[安装插件开发工具](initialize-development-tools)。
1515

1616
<Info>**Tips**：在终端运行 `dify version` 命令，检查是否出现版本号以确认成功安装脚手架工具。</Info>
1717

‎zh-hans/plugins/quick-start/develop-plugins/bundle.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ Bundle 插件包是多个插件的集合。它可以将多个插件打包在一
1616
* Dify 插件脚手架工具
1717
* Python 环境，版本号 ≥ 3.10
1818

19-
关于如何准备插件开发的脚手架工具，详细说明请参考[初始化开发工具](initialize-development-tools)。
19+
关于如何准备插件开发的脚手架工具，详细说明请参考[安装插件开发工具](initialize-development-tools)。
2020

2121
### 创建 Bundle 项目
2222

‎zh-hans/plugins/quick-start/develop-plugins/extension-plugin.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ title: Extension 插件
1010
* Dify 插件脚手架工具
1111
* Python 环境，版本号 ≥ 3.12
1212

13-
关于如何准备插件开发的脚手架工具，详细说明请参考[初始化开发工具](initialize-development-tools)。
13+
关于如何准备插件开发的脚手架工具，详细说明请参考[安装插件开发工具](initialize-development-tools)。
1414

1515
### 创建新项目 <a href="#chuang-jian-xin-xiang-mu" id="chuang-jian-xin-xiang-mu"></a>
1616

0 commit comments

Comments
 (0)