docs/advanced-development/pipeline-yaml.mdx

---
sidebar_position: 4
---

# Pipeline YAML

**Pipeline YAML** provides a comprehensive overview of your entire pipeline configuration in YAML format. This includes all nodes with their positioning, executable code, relationships, and various technical information that defines how the pipeline operates.

## Accessing Pipeline YAML

To access the pipeline YAML configuration:

1. Click the **More** button in the pipeline interface
2. Select **YAML** from the dropdown menu

![Pipeline YAML Access](../img/pipeline-yaml-1.jpg)

This opens the YAML editor where you can view and modify it.

## YAML Structure

The pipeline YAML follows a specific hierarchical structure:

### 1. Pipeline Metadata
```yaml
name: Pipeline Name
version: 1
description: Pipeline description
readme: {}
category:
  _id: category_id
  title: Category
```

This section contains basic information about the pipeline, including name, description, and categorization.

### 2. Start Configuration
```yaml
start:
  nodes:
    - first_node_id
```

Defines which node serves as the starting point for pipeline execution.

### 3. Inputs and Outputs
```yaml
inputs:
  string1:
    title: String 1
    type: string
    # Input parameters

outputs:
  json_output:
    title: JSON
    type: json
    # Output parameters
```

Here all inputs and outputs for all nodes placed in the pipeline workspace are defined.

### 4. Flows (Node Connections)
```yaml
flows:
  connection_name:
    from: source_node
    output: output_parameter
    to: target_node
    input: input_parameter
```

This section describes how data flows between nodes, connecting outputs of one node to inputs of another.

### 5. Node Configuration
```yaml
nodes:
  node_id:
    version: 1
    title: Node Title
    source: node|catalog
    execution: rapid|regular|deferred|protracted
    script: |
      // JavaScript code
    inputs:
      # Node input definitions
    outputs:
      # Node output definitions
    arrange:
      # Node positioning
```

Each node in the pipeline is fully described with all its parameters and code.

## Editing and Saving

When making changes to the pipeline YAML:

1. **Make your changes** in the YAML editor
2. **Click Save** at the bottom of the interface
3. **Check the status indicator** - a green "Saved" indicator will appear on the right if there are no errors

![YAML Editor Interface](../img/pipeline-yaml-2.jpg)

Any syntax errors or configuration issues will be highlighted, preventing the save operation until they are resolved.

## Returning to Pipeline Workspace

To return to the visual pipeline workspace:

- Click the blue **Pipeline** button on the left in the interface

This will switch you back to the graphical pipeline editor.