# start

## Usage

```bash
bdy pipeline run start <identifier> [options]
```

## Arguments

| **Argument** | **Description** |
| :--- | :--- |
| `identifier` | Human-readable ID of the pipeline (required) |

## Options

| **Option** | **Description** |
| :--- | :--- |
| `-w, --workspace <domain>` | Workspace URL handle. Can be set via variable: BUDDY_WORKSPACE |
| `-p, --project <name>` | Project name. Can be set via variable: BUDDY_PROJECT |
| `-b, --branch <branch>` | Repository branch name |
| `-t, --tag <tag>` | Repository tag name |
| `-pr, --pull-request <pull request>` | Repository pull request id |
| `-r, --revision <revision>` | Repository revision |
| `--comment <comment>` | Run comment |
| `-f, --refresh` | Deploy from scratch |
| `-c, --clear-cache` | Clear cache before running the pipeline |
| `--priority <priority>` | Run priority. Can be one of "LOW", "NORMAL" or "HIGH". Default is "NORMAL" |
| `-v, --variable <variables...>` | Variable key=value or key:value. Can be passed multiple times to pass multiple variables |
| `-vf, --variables-from-file <filepath>` | File with variables, key=value. Each variable in new line |
| `-vff, --variable-from-file <variables...>` | Variable from file, key=path/to/file or key:path/to/file. Can be passed multiple times to pass multiple variables |
| `-vm, --variable-masked <variables...>` | Variable key=value or key:value. Can be passed multiple times to pass multiple variables |
| `-vmf, --variables-masked-from-file <filepath>` | File with variables, key=value. Each variable in new line |
| `-vmff, --variable-masked-from-file <variables...>` | Variable from file, key=path/to/file or key:path/to/file. Can be passed multiple times to pass multiple variables |
| `--schedule <date>` | The date when the execution should be run. Should be set in the format: 2016-11-18T12:38:16.000Z or 30s, 10m, 3h10m30s |
| `--action <actions...>` | Action ID to be run in this execution. If not sent, it will be run in accordance with the pipeline's definition. Can be passed multiple times to select multiple actions |
| `-n, --no-wait` | Do not wait for run to finish |
| `--no-follow` | Do not follow changes, only print final state |
| `--format <text|jsonl>` | Output format: jsonl, text. Default: text |
| `-h, --help` | display help for command |

## Examples

### ## run pipeline with high priority and upload everything from scratch

```bash
bdy pip run start pipeline-identifier --priority HIGH -f
```

### ## run pipeline without cache and wait for execution to complete

```bash
bdy pip run start pipeline-identifier --wait -c
```

### ## run pipeline and pass custom variables to execution

```bash
bdy pip run start pipeline-identifier -v key:val -v a:b
```

### ## run pipeline and pass custom variables from file

```bash
bdy pip run start pipeline-identifier -vf path/to/env/file
```

### ## run pipeline and output only final jsonl

```bash
bdy pip run start pipeline-identifier --no-follow --format jsonl
```


---
Original source: https://buddy.works/docs/cli/pipeline/run/start