> ## Documentation Index
> Fetch the complete documentation index at: https://docs.vessl.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# vessl run

### Overview

Run `vessl run --help` to view list of commands, or `vessl run [COMMAND] --help` for detailed instructions on individual command.
By default the run command uses default project configured by `vessl configure`.

* To see the current default project, run `vessl whoami`.
* To reset the default project, run `vessl configure --reset`.
* To change your current project, run `vessl run ssh {RUN_ID} --project {PROJECT_NAME}`.

### Create a new run in project

```
vessl run create [OPTIONS]
```

| Option                  | Description                                                           |
| ----------------------- | --------------------------------------------------------------------- |
| `-f`, `--file` TEXT     | YAML file for run definition.                                         |
| `-w`, `--watch` BOOLEAN | Wait for the Run to be scheduled and then stream logs to the console. |

### List all runs in project

```
vessl run list
```

### Read the run

```
vessl run read RUN_ID
```

### Display the logs of run

```
vessl run logs [OPTIONS] RUN_ID
```

| Option           | Description                                |
| ---------------- | ------------------------------------------ |
| `--tail` INTEGER | Number of lines to display (from the end). |
| `-f`, `--follow` | Continue listing the log.                  |

### Terminate the run

```
vessl run terminate RUN_ID
```

### Delete the run

```
vessl run delete RUN_ID
```

### Update the run description

```
vessl run update RUN_ID DESCRIPTION
```

### SSH into the run

```
vessl run ssh [OPTIONS] RUN_ID
```

| Option             | Description           |
| ------------------ | --------------------- |
| `-p`, `--key-path` | SSH private key path. |