@dagucloud/dagu

A powerful Workflow Orchestration Engine with simple declarative YAML API

Installation

npm install -g --ignore-scripts=false @dagucloud/dagu

--ignore-scripts=false ensures npm runs the postinstall script that downloads the Dagu binary.

Or add to your project:

npm install --ignore-scripts=false @dagucloud/dagu

Usage

Command Line

After installation, the dagu command will be available:

# Start the web UI and scheduler
dagu start-all

# Run a workflow
dagu start my-workflow.yaml

# Check workflow status
dagu status my-workflow.yaml

Programmatic Usage

const { execute, getDaguPath } = require('@dagucloud/dagu');

// Get path to the binary
const daguPath = getDaguPath();

// Execute dagu commands
const child = execute(['start', 'workflow.yaml']);

// Or use async/await
const { executeAsync } = require('@dagucloud/dagu');

async function runWorkflow() {
  const result = await executeAsync(['start', 'workflow.yaml']);
  console.log('Exit code:', result.code);
  console.log('Output:', result.stdout);
}

Supported Platforms

This package provides pre-built binaries for:

• Linux: x64, arm64, arm (v6/v7), ia32, ppc64le, s390x
• macOS: x64 (Intel), arm64 (Apple Silicon)
• Windows: x64, ia32, arm64
• FreeBSD: x64, arm64
• OpenBSD: x64, arm64

If your platform is not supported, please build from source: https://github.com/dagucloud/dagu#building-from-source

Features

• Zero Dependencies - Single binary, no runtime requirements
• Declarative YAML - Define workflows in simple YAML format
• Web UI - Beautiful dashboard for monitoring and management
• Powerful Scheduling - Cron expressions, dependencies, and complex workflows
• Language Agnostic - Run any command, script, or executable

Documentation

For detailed documentation, visit: https://github.com/dagucloud/dagu

License

GNU General Public License v3.0