Skip to content
Adagio

Quick Start

This guide walks through the shortest end-to-end Adagio workflow:

  • add actions to the canvas
  • connect them into a valid graph
  • expose the right run-time inputs and parameters
  • run the pipeline
  • export the pipeline for CLI use

1. Open the pipeline editor

Sign in to your Adagio instance and create a new pipeline.

2. Create a new pipeline

The editor has three main areas:

  • the action tray on the left
  • the canvas in the middle
  • the inspector on the right

3. Add actions

Each action is one plugin method or pipeline. To add one:

  1. Browse or search in the action tray.
  2. Add an action such as demux, dada2, or another plugin action relevant to your workflow.
  3. Repeat until the core steps of your analysis are on the canvas.

4. Connect nodes

Connect an output port to a downstream input port.

Adagio only accepts type-compatible connections. If a port does not highlight as a valid target, the semantic types do not match. See Connections and Semantic Types.

5. Set values and choose the run-time interface

Set values directly on the nodes while you build:

  1. Select a node and fill in its parameters.
  2. For an input that is not connected to another node, select the input port and type a file path or URL into its Path field.

Then decide what a runner should be able to change. Only parameters that read a variable are exposed at run time; everything else stays fixed as configured on the node. For each such parameter:

  1. Open the Variables tab and click + Create Variable.
  2. Name the variable and optionally give it a value, which becomes its run-time default.
  3. Select the node, click the variable button at the right of the parameter field, and choose the variable.

A variable is also the way to give several parameters, or several inputs, one shared value. See Inputs, Parameters, and Defaults.

6. Save and verify

Use the To Do tab to clear validation issues.

Adagio blocks pipeline download until the graph has no remaining required-input, required-parameter, or naming problems.

7. Run from the UI

Select a connected Runtime Server from the title bar, then click Run in the toolbar. Adagio will prompt you for required inputs and for variables that have no value.

The run form has three parts:

  • Parameters for the parameters that read variables
  • Files for paths interpreted by the selected Runtime Server
  • Environment for the run details, task environments, concurrency, and cache reuse

Choose Start run after the checklist is clear. You can watch each step complete in the run view.

Adagio Desktop is available as a Runtime Server when it is connected. To run on a self-hosted Linux machine, follow Runtime Server setup.

8. Export the pipeline

From the editor you can export:

  • the pipeline itself as a .adg file
  • an arguments JSON template for CLI runs

The arguments export captures the current parameter values and input file names. Before using it with the CLI, replace those file names with real local paths.

9. Run the same pipeline with the CLI

Typical flow:

Terminal window
adagio pipeline show my-pipeline.adg


adagio run \
  --pipeline my-pipeline.adg \
  --arguments my-arguments.json \
  --cache-dir ./adagio-cache

Next: