CLI

Set up and package your Intellos plugins using the Command Line Interface (CLI). The CLI provides a streamlined way to manage your plugin development workflow, from initialization to packaging. This guide will instruct you on how to use the CLI for Intellos plugin development.

Prerequisites

Before you begin, ensure you have the following installed:

Python version 3.12
Intellos CLI
Homebrew (for Mac users)

Create a Intellos Plugin Project

Mac
Linux
Windows

brew tap langgenius/dify
brew install dify

Download the latest binary from the Intellos Plugin Daemon releases page. Pick dify-plugin-linux-amd64 for x86_64 hosts or dify-plugin-linux-arm64 for ARM hosts.

chmod +x dify-plugin-linux-amd64
sudo mv dify-plugin-linux-amd64 /usr/local/bin/dify

Download dify-plugin-windows-amd64.exe (or dify-plugin-windows-arm64.exe) from the Intellos Plugin Daemon releases page, rename it to dify.exe, and add its folder to your PATH.

Now you have successfully installed the Intellos CLI. You can verify the installation by running:

dify version

You can create a new Intellos plugin project using the following command:

dify plugin init

Fill in the required fields when prompted:

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

Choose python and hit Enter to proceed with the Python plugin template.

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 Intellos:

- 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 Intellos 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 Intellos 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

Enter the default dify version, leave it blank to use the latest version:

Edit minimal Intellos version requirement, leave it blank by default
Minimal Intellos version (press Enter to next step): 

Now you are ready to go! The CLI will create a new directory with the plugin name you provided, and set up the basic structure for your plugin.

cd hello-world

Run the Plugin

Make sure you are in the hello-world directory

cp .env.example .env

Edit the .env file to set your plugin’s environment variables, such as API keys or other configurations. You can find these variables in the Intellos dashboard. Log in to your Intellos environment, click the “Plugins” icon in the top right corner, then click the debug icon (or something that looks like a bug). In the pop-up window, copy the “API Key” and “Host Address”. (Please refer to your local corresponding screenshot, which shows the interface for obtaining the key and host address)

INSTALL_METHOD=remote
REMOTE_INSTALL_URL=debug-plugin.dify.dev:5003
REMOTE_INSTALL_KEY=********-****-****-****-************

REMOTE_INSTALL_URL combines host and port in host:port form. The host and port are shown together in the API Key card on the Plugins page.

Now you can run your plugin locally using the following command:

pip install -r requirements.txt
python -m main

Edit this page | Report an issue

Getting Started

Features & Specs

Development Guides & Walkthroughs

Prerequisites

Create a Intellos Plugin Project

Run the Plugin

​Prerequisites

​Create a Intellos Plugin Project

​Run the Plugin

Prerequisites

Create a Intellos Plugin Project

Run the Plugin