Documentation

Welcome to RunDone documentation. Learn how to automate your workflows and boost your productivity.

New to RunDone?

Start with our Quick Start guide to create your first automation in under 5 minutes.

Quick Start

Get up and running with RunDone in just a few steps:

1

Create an Account

Sign up for free and verify your email address.

2

Create Your First Workflow

Click "New Workflow" and choose a template or start from scratch.

3

Add Trigger & Actions

Define when your workflow runs and what it should do.

4

Activate & Monitor

Turn on your workflow and watch it automate your tasks.

Installation

RunDone can be used as a cloud service or self-hosted.

CLI Installation

Terminal 
$ curl -fsSL https://run-done.com/install.sh | sh

# Or with npm
$ npm install -g @rundone/cli

# Verify installation
$ rundone --version
RunDone CLI v2.1.0

Docker

Terminal 
$ docker pull rundone/server:latest
$ docker run -p 8090:8090 rundone/server

Workflows

A workflow is a series of automated steps that execute in sequence or parallel. Each workflow consists of a trigger and one or more actions.

Workflow Structure

workflow.yaml 
name: Daily Report
trigger:
  schedule: "0 9 * * *"  # Every day at 9 AM

actions:
  - name: Fetch Data
    type: http_request
    config:
      url: https://api.example.com/stats
      method: GET

  - name: Generate Report
    type: template
    config:
      template: report.html
      data: "{% raw %}{{ steps.fetch_data.response }}{% endraw %}"

  - name: Send Email
    type: email
    config:
      to: [email protected]
      subject: "Daily Report - {% raw %}{{ date }}{% endraw %}"
      body: "{% raw %}{{ steps.generate_report.output }}{% endraw %}"

REST API

RunDone provides a comprehensive REST API for programmatic access to all features.

Authentication

All API requests require an API key in the header:

HTTP Header 
Authorization: Bearer YOUR_API_KEY

Endpoints

Method Endpoint Description
GET /api/workflows List all workflows
POST /api/workflows Create new workflow
GET /api/workflows/:id Get workflow details
PUT /api/workflows/:id Update workflow
DELETE /api/workflows/:id Delete workflow
POST /api/workflows/:id/run Trigger workflow manually