duckflux

https://duckflux.openvibes.tech/docs
Admin
duckflux is a declarative YAML-based workflow DSL for orchestrating deterministic AI agent pipelines...
Tokens:2,177
Snippets:41
Trust Score:2.3
Update:6 months ago
Show doc for...
Tokens:
Raw
### Install Duckflux CLI

Source: https://duckflux.openvibes.tech

Command to install the Duckflux CLI via the apt-repo script.

```bash
curl -fsSL https://duckflux.github.io/apt-repo/install.sh | bash
```

--------------------------------

### Start Duckflux Dev Server

Source: https://duckflux.openvibes.tech

Launch the Duckflux development server for observing and executing workflows locally. This server provides a GitHub Actions-style web UI with real-time updates and step-by-step inspection. Specify trace and workflow directories.

```bash
# Start the dev server
quack server --trace-dir ./traces --workflow-dir ./workflows

# Open http://localhost:3000
```

--------------------------------

### Install Duckflux CLI Globally

Source: https://duckflux.openvibes.tech

Install the Duckflux CLI globally using Bun. This command is used to manage and run workflows from the terminal.

```bash
# Install globally
bun add -g duckflux
```

--------------------------------

### Make HTTP Requests with 'http' Participant

Source: https://duckflux.openvibes.tech

The 'http' participant allows making HTTP requests to any REST API. Supports various methods (GET, POST, PUT, DELETE) and includes options for headers, authentication, and body templating. Ensure API endpoints and authentication are correctly configured.

```yaml
participants:
  deploy_api:
    type: http
    method: POST
    url: "https://api.deploy.io/deploys"
    headers:
      Authorization: "Bearer {{ secrets.API_TOKEN }}"
    body:
      repo: "{{ inputs.repo }}"
      branch: "{{ inputs.branch }}"
```

--------------------------------

### Dynamic input and command interpolation

Source: https://duckflux.openvibes.tech

Demonstrates using CEL ternary operators for dynamic input values and template interpolation for command arguments.

```yaml
participants:
  deploy:
    type: exec
    command: >
      deploy.sh
      --env {{ inputs.environment }}
      --tag {{ inputs.tag }}

steps:
  - run: deploy
    input:
      target: >
        inputs.environment == "prod"
          ? inputs.prod_cluster
          : inputs.staging_cluster
      replicas: "inputs.replicas * (inputs.environment == 'prod' ? 2 : 1)"
```

--------------------------------

### Define a basic workflow in YAML

Source: https://duckflux.openvibes.tech

A simple workflow definition using the exec participant type to run a shell command.

```yaml
# hello-world.duck.yaml
name: hello-world

participants:
  greet:
    type: exec
    command: echo "Hello from duckflux! 🦆"

steps:
  - run: greet
```

--------------------------------

### Execute Shell Commands with 'exec' Participant

Source: https://duckflux.openvibes.tech

Use the 'exec' participant to run any shell command, script, or binary. Ideal for AI agent CLIs, build tools, or custom runners. Ensure the command is executable in the environment.

```yaml
participants:
  coder:
    type: exec
    command: >
      claude --model claude-opus-4-5
      --prompt "{{ inputs.task }}"
      --output-format json
```

--------------------------------

### Call MCP Tools with 'mcp' Participant

Source: https://duckflux.openvibes.tech

Integrate with the MCP ecosystem by calling any Model Context Protocol server tool. This participant bridges workflows with external MCP services. Specify the server and the tool to be used.

```yaml
participants:
  github_tool:
    type: mcp
    server: "@modelcontextprotocol/server-github"
    tool: create_pull_request
    args:
      repo: "{{ inputs.repo }}"
      title: "{{ inputs.title }}"
      branch: "{{ inputs.branch }}"
```

--------------------------------

### Conditional step execution with CEL

Source: https://duckflux.openvibes.tech

Uses CEL expressions to determine which step to run based on the output of a previous step.

```yaml
steps:
  - run: analyze
    output: result

  - run: approve
    when: "result.score >= 0.9 && result.issues.size() == 0"

  - run: review
    when: "result.score >= 0.6 && result.score < 0.9"

  - run: reject
    when: "result.score < 0.6"
```

--------------------------------

### Lint a Workflow from CLI

Source: https://duckflux.openvibes.tech

Check a Duckflux workflow for schema and semantic errors using the 'quack lint' command before execution. This helps ensure the workflow is valid.

```bash
# Lint before running
quack lint ./pipeline.duck.yaml
```

--------------------------------

### Run a Workflow from CLI

Source: https://duckflux.openvibes.tech

Execute a Duckflux workflow from the terminal using the 'quack run' command. Specify the workflow file and any required inputs. Supports NATS and Redis event backends for cross-process coordination.

```bash
# Run a workflow
quack run ./pipeline.duck.yaml --input repo=org/app
```

--------------------------------

### Configure retry logic with CEL

Source: https://duckflux.openvibes.tech

Defines retry behavior for a step using CEL expressions to evaluate when a retry should occur.

```yaml
steps:
  - run: llm_reviewer
    output: review
    retry:
      max: 5
      delay: 1s
      backoff: exponential
      when: >
        review.status == "incomplete" ||
        review.confidence < 0.7 ||
        "RETRY" in review.flags
```

--------------------------------

### Emit Events with 'emit' Participant

Source: https://duckflux.openvibes.tech

Enable event-driven architectures and cross-workflow communication by emitting named events to channels using the 'emit' participant. Data can be passed along with the event, including contextual information.

```yaml
steps:
  - run: analyze
    output: result

  - emit:
      channel: "analysis.complete"
      data:
        result: "{{ result }}"
        workflow_id: "{{ context.id }}"
        timestamp: "{{ context.now }}"
```

--------------------------------

### Nest Workflows with 'workflow' Participant

Source: https://duckflux.openvibes.tech

Compose complex workflows by nesting reusable sub-workflows using the 'workflow' participant. This promotes modularity and sharing of common patterns across teams. Specify the path to the sub-workflow and any necessary inputs.

```yaml
participants:
  test_suite:
    type: workflow
    path: ./shared/test-suite.duck.yaml

  security_scan:
    type: workflow
    path: ./shared/security.duck.yaml
    inputs:
      strict: true
```

--------------------------------

### Wait for Events or Conditions with 'wait' Participant

Source: https://duckflux.openvibes.tech

Suspend workflow execution until a specific event arrives or a condition is met using the 'wait' participant. Supports timeouts and fallback handlers for scenarios where the event or condition is not met within a specified duration.

```yaml
steps:
  - emit:
      channel: "approvals.pending"
      data: { pr_url: "{{ outputs.pr_url }}" }

  - wait:
      event: "approval.decision"
      timeout: 48h
      output: decision
      on_timeout: handle_expired

  - run: merge_pr
    when: "decision.approved"
```
Tokens:
Raw