README

A framework-agnostic PHP library for parsing and generating Dify DSL (Domain-Specific Language) workflows.

Features

Workflow Builder - Fluent API for building complex workflows with ease
DSL Parser - Parse existing Dify DSL YAML files into PHP objects
Code Generation - Generate valid Dify DSL YAML from PHP objects
Node Types - Support for all major Dify node types
Type Safety - Full PHP 8.2+ type declarations
Validation - Built-in validation for workflow structure
Extensible - Easy to extend with custom node types

Installation

composer require tourze/dify-dsl

Usage

1. Building Workflows with Fluent API

<?php

use Tourze\DifyDsl\Builder\WorkflowBuilder;
use Tourze\DifyDsl\Generator\DifyGenerator;

// Create an AI assistant workflow
$app = WorkflowBuilder::create()
    ->setName("AI Assistant")
    ->setDescription("A helpful AI assistant")
    ->setMode("workflow")
    ->setIcon("🤖")

    // Add start node
    ->addStartNode(function($node) {
        $node->addVariableFromArray("query", "text-input", true, "User query");
        $node->addVariableFromArray("context", "paragraph", false, "Context information");
    })

    // Add LLM node
    ->addLLMNode(null, function($node) {
        $node->setTitle("Intelligent Response")
             ->setModel("gpt-4", "openai", "chat")
             ->setSystemPrompt("You are a helpful AI assistant")
             ->setUserPrompt("User query: {{#start.query#}}\n\nContext: {{#start.context#}}");
    })

    // Add end node
    ->addEndNode(function($node) {
        $node->addOutput("result", ["llm", "text"]);
    })

    ->build();

// Generate YAML
$generator = new DifyGenerator();
$yaml = $generator->generatePretty($app);
echo $yaml;

2. Parsing Existing YAML Files

<?php

use Tourze\DifyDsl\Parser\DifyParser;

$parser = new DifyParser();
$app = $parser->parseFile('workflow.yml');

echo "App name: " . $app->getName() . "\n";
echo "Nodes: " . count($app->getWorkflow()->getGraph()->getNodes()) . "\n";

// Traverse nodes
$nodes = $app->getWorkflow()->getGraph()->getNodes();
foreach ($nodes as $node) {
    echo "Node: " . $node->getId() . " (" . $node->getNodeType() . ")\n";
}

Supported Node Types

The library supports all major Dify workflow node types:

StartNode - Entry point variables for workflows
EndNode - End points for Workflow mode
AnswerNode - End points for Chatflow mode
LLMNode - Language model nodes
ToolNode - Tool/function calling nodes
CodeNode - Custom code execution nodes

API Reference

WorkflowBuilder

Method	Description
`setName(string $name)`	Set workflow name
`setDescription(string $desc)`	Set workflow description
`setMode(string $mode)`	Set workflow mode
`addStartNode(?callable $config)`	Add start node
`addLLMNode(?string $id, ?callable $config)`	Add LLM node
`addEndNode(?callable $config)`	Add end node
`build()`	Build the workflow app

DifyParser

Method	Description
`parse(string $yaml)`	Parse YAML string
`parseFile(string $path)`	Parse YAML file
`parseFromArray(array $data)`	Parse from array

DifyGenerator

Method	Description
`generate(App $app)`	Generate YAML string
`generateToFile(App $app, string $path)`	Generate to file
`generatePretty(App $app)`	Generate formatted YAML

Examples

Check the examples/ directory for complete usage examples:

simple_workflow.php - Basic workflow creation and parsing

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

License

This project is licensed under the MIT License - see the LICENSE file for details.

tourze / dify-dsl

Maintainers

Details