https://github.com/kurokobo/psdify
PSDify: A PowerShell module for workspace management for Dify, featuring various cmdlets for managing Apps, Knowledges, Models, and Members, etc.
https://github.com/kurokobo/psdify
dify
Last synced: 7 months ago
JSON representation
PSDify: A PowerShell module for workspace management for Dify, featuring various cmdlets for managing Apps, Knowledges, Models, and Members, etc.
- Host: GitHub
- URL: https://github.com/kurokobo/psdify
- Owner: kurokobo
- License: apache-2.0
- Created: 2024-11-25T16:13:03.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-07-27T14:47:31.000Z (8 months ago)
- Last Synced: 2025-08-11T12:54:55.493Z (7 months ago)
- Topics: dify
- Language: PowerShell
- Homepage: https://www.powershellgallery.com/packages/PSDify
- Size: 906 KB
- Stars: 19
- Watchers: 1
- Forks: 0
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome - kurokobo/psdify - PSDify: A PowerShell module for workspace management for Dify, featuring various cmdlets for managing Apps, Knowledges, Models, and Members, etc. (PowerShell)
README
# PSDify: A PowerShell Module for Workspace Management for Dify
**PSDify** is a PowerShell module designed to enable workspace management for [Dify](https://github.com/langgenius/dify) from the command line.
Here are some examples of what you can do with PSDify:
- ✨ **Export and import apps**
- ✨ **Create knowledge and upload files**
- ✨ **Manage members: retrieve, invite, remove, and change roles**
- ✨ **Add models and update system models**
- ✨ **Search and install plugins**
- ✨ **Initialize instances for the Community Edition**
For a full list of available cmdlets, refer to the [📚Documentation](https://kurokobo.github.io/psdify/).
> [!WARNING]
>
> - 🚨 This is an **unofficial** project. LangGenius does not provide any support for this module.
> - 🚨 It uses **undocumented APIs** of Dify, which means it **may break with future updates** to Dify.
> - 🚨 The **Enterprise Edition** of Dify (multi-workspace environments) is **not supported**.
> - 🚨 Currently, the focus is on "**making it work**." This means **error handling and documentation are incomplete**, and it does not strictly follow PowerShell best practices.
> [!NOTE]
>
> - This module has been tested mainly against the latest version of Dify of the Community Edition and the Cloud Edition, with Windows PowerShell (PowerShell 5.1) and PowerShell 7.4.
> - The Enterprise Edition of Dify (multi-workspace environments) is not supported.
## Quick Start
For a full list of available cmdlets, refer to the [📚Documentation](https://kurokobo.github.io/psdify/).
### Installation
```powershell
Install-Module -Name PSDify
```
### Connecting to Dify
```powershell
# Authenticate with a password (for Community Edition)
Connect-Dify -AuthMethod "Password" -Server "https://dify.example.com" -Email "dify@example.com"
# Authenticate with a code (for Cloud Edition)
Connect-Dify -AuthMethod "Code" -Server "https://dify.example.com" -Email "dify@example.com"
```
### Managing Apps
```powershell
# Retrieve apps
Get-DifyApp
# Export apps (as .\DSLs\*.yml)
Get-DifyApp | Export-DifyApp
# Import apps
Get-Item -Path "DSLs/*.yml" | Import-DifyApp
```
### Managing Knowledge
```powershell
# Retrieve knowledge
Get-DifyKnowledge
# Create knowledge
New-DifyKnowledge -Name "My New Knowledge"
# Upload files to knowledge and wait for indexing to complete
$Knowledge = Get-DifyKnowledge -Name "My New Knowledge"
Get-Item -Path "Docs/*.md" | Add-DifyDocument -Knowledge $Knowledge -Wait
```
### Managing Members
```powershell
# Retrieve members
Get-DifyMember
# Invite a new member
New-DifyMember -Email "user@example.com" -Role "normal"
# Change a member's role
Get-DifyMember -Email "user@example.com" | Set-DifyMemberRole -Role "editor"
```
### Managing Models
```powershell
# Retrieve models
Get-DifyModel
# Add a predefined model
New-DifyModel -Provider "openai" -From "predefined" `
-Credential @{
"openai_api_key" = "sk-proj-****************"
}
# Add a customizable model
New-DifyModel -Provider "openai" -From "customizable" `
-Type "llm" -Name "gpt-4o-mini" `
-Credential @{
"openai_api_key" = "sk-proj-****************"
}
# Update the system model
Set-DifySystemModel -Type "llm" -Provider "openai" -Name "gpt-4o-mini"
```
### Managing Plugins
```powershell
# Search plugins
Find-DifyPlugin -Id "langgenius/openai"
# Install a plugin and wait for it to be installed
Find-DifyPlugin -Id "langgenius/openai" | Install-DifyPlugin -Wait
# Get installed plugins
Get-DifyPlugin
```
### Initializing a Community Edition Instance
```powershell
# Start a Dify instance with Docker Compose
docker compose up -d
# Wait for the instance to be ready
Wait-Dify -Server "https://dify.example.com"
# Initialize the instance
Initialize-Dify -Server "https://dify.example.com" -Email "dify@example.com" -Name "Dify"
```