Help How can I start the dify plugin in my pc with debug model?

[simonjhy]

Self Checks

• I have searched for existing issues search for existing issues, including closed ones.
• I confirm that I am using English to submit this report (我已阅读并同意 Language Policy).
• [FOR CHINESE USERS] 请务必使用英文提交 Issue，否则会被关闭。谢谢！:)
• Please do not modify this template :) and fill in all the required fields.

1. Is this request related to a challenge you're experiencing? Tell me about your story.

I use pycharm to develop my pluign, I want to I can start with IDE tool debug mode to run the "python -m main" to install debugging plugin to dify server. What the detail steps to configure it in pycharm IDE tool?

2. Additional context or comments

No response

[dosubot[bot]]

To debug your Dify plugin with PyCharm, follow these steps:

1. Copy .env.example in your plugin project to .env and fill in the remote server address and debugging key from the Dify Plugin Management page. For recent SDKs, use:

   INSTALL_METHOD=remote
   REMOTE_INSTALL_HOST=debug.dify.ai
   REMOTE_INSTALL_PORT=5003
   REMOTE_INSTALL_KEY=your-debug-key
   

   For older SDKs, use REMOTE_INSTALL_URL=debug.dify.ai:5003 instead of HOST/PORT. Using the wrong variable may cause the plugin to default to localhost and not connect properly [docs].

2. In PyCharm, go to Run > Edit Configurations. Add a new "Python" configuration:

   • Set "Module name" to main
   • Set "Working directory" to your plugin project root (where main.py is located)
   • Set the Python interpreter to match your plugin's environment
   • In "Environment variables", make sure PYTHONPATH includes your project root if needed, and that your .env file is loaded (PyCharm does this automatically if you use the EnvFile plugin or set variables manually)

3. Start the configuration in Debug mode (the bug icon). This will run python -m main and attach the debugger.

4. After starting, your plugin should register with the Dify server and be available in the Workspace plugins page [remote debug guide].

If you run into issues, double-check your .env variable names and values, and ensure your PyCharm interpreter matches your plugin's dependencies.

To reply, just mention @dosu.

---

^{How did I do? Good | Irrelevant | Incorrect | Verbose | Hallucination | Report 🐛 | Other}

   

[WilliamChen-luckbob]

@dosu
It is ok to run, but unable to debug in pycharm