# {py:mod}`ovo.cli.scheduler_cli`

```{py:module} ovo.cli.scheduler_cli
```

```{autodoc2-docstring} ovo.cli.scheduler_cli
:allowtitles:
```

## Module Contents

### Functions

````{list-table}
:class: autosummary longtable
:align: left

* - {py:obj}`run <ovo.cli.scheduler_cli.run>`
  - ```{autodoc2-docstring} ovo.cli.scheduler_cli.run
    :summary:
    ```
* - {py:obj}`submit <ovo.cli.scheduler_cli.submit>`
  - ```{autodoc2-docstring} ovo.cli.scheduler_cli.submit
    :summary:
    ```
* - {py:obj}`jupyter <ovo.cli.scheduler_cli.jupyter>`
  - ```{autodoc2-docstring} ovo.cli.scheduler_cli.jupyter
    :summary:
    ```
* - {py:obj}`format_help <ovo.cli.scheduler_cli.format_help>`
  - ```{autodoc2-docstring} ovo.cli.scheduler_cli.format_help
    :summary:
    ```
* - {py:obj}`status <ovo.cli.scheduler_cli.status>`
  - ```{autodoc2-docstring} ovo.cli.scheduler_cli.status
    :summary:
    ```
* - {py:obj}`cancel <ovo.cli.scheduler_cli.cancel>`
  - ```{autodoc2-docstring} ovo.cli.scheduler_cli.cancel
    :summary:
    ```
* - {py:obj}`download <ovo.cli.scheduler_cli.download>`
  - ```{autodoc2-docstring} ovo.cli.scheduler_cli.download
    :summary:
    ```
* - {py:obj}`worker <ovo.cli.scheduler_cli.worker>`
  - ```{autodoc2-docstring} ovo.cli.scheduler_cli.worker
    :summary:
    ```
````

### Data

````{list-table}
:class: autosummary longtable
:align: left

* - {py:obj}`app <ovo.cli.scheduler_cli.app>`
  - ```{autodoc2-docstring} ovo.cli.scheduler_cli.app
    :summary:
    ```
````

### API

````{py:data} app
:canonical: ovo.cli.scheduler_cli.app
:value: >
   'Typer(...)'

```{autodoc2-docstring} ovo.cli.scheduler_cli.app
```

````

````{py:function} run(pipeline_name: str = typer.Argument(default=None, help='Pipeline to submit'), output: str = typer.Argument(default=None, help='Output directory'), scheduler_key: str = typer.Option(None, '--scheduler', help='Scheduler key'), link: bool = typer.Option(default=None, help='Do not copy output files, create a symlink instead'), ctx: typer.Context = typer.Option(None), help: bool | None = typer.Option(None, '--help', '-h', help='Show pipeline-specific help'))
:canonical: ovo.cli.scheduler_cli.run

```{autodoc2-docstring} ovo.cli.scheduler_cli.run
```
````

````{py:function} submit(pipeline_name: str = typer.Argument(default=None, help='Pipeline to submit'), output: str = typer.Option(None, '--output', help='Custom output directory (requires --sync)'), scheduler_key: str = typer.Option(None, '--scheduler', help='Scheduler key'), sync: bool = typer.Option(default=None, help='Run nextflow process synchronously, waiting for completion'), link: bool = typer.Option(default=None, help='Do not copy output files, create a symlink instead (when --output is used)'), ctx: typer.Context = typer.Option(None), help: bool | None = typer.Option(None, '--help', '-h', help='Show pipeline-specific help'))
:canonical: ovo.cli.scheduler_cli.submit

```{autodoc2-docstring} ovo.cli.scheduler_cli.submit
```
````

````{py:function} jupyter(dirs: list[str] = typer.Argument(help='Directory to run from. Will be mounted inside the container.'), env: str = typer.Option(default=None, help='Name of conda environment or container to run in, for example rfdiffusion. Runs in current environment if not specified.'), scheduler_key: str = typer.Option(None, '--scheduler', help='Scheduler key'), ip: str = typer.Option(default='0.0.0.0', help='Host to bind Jupyter server to'), port: int = typer.Option(default=8888, help='Port to bind Jupyter server to'), run_parameters: str = typer.Option(default='', help='Additional commandline parameters to pass to Jupyter server'), timeout: int = typer.Option(default=3600, help='Timeout in seconds to wait for Jupyter server to start'))
:canonical: ovo.cli.scheduler_cli.jupyter

```{autodoc2-docstring} ovo.cli.scheduler_cli.jupyter
```
````

````{py:function} format_help(schema)
:canonical: ovo.cli.scheduler_cli.format_help

```{autodoc2-docstring} ovo.cli.scheduler_cli.format_help
```
````

````{py:function} status(job_id: str = typer.Argument(help='Job ID'), scheduler_key: str = typer.Option(None, '--scheduler', help='Scheduler key'))
:canonical: ovo.cli.scheduler_cli.status

```{autodoc2-docstring} ovo.cli.scheduler_cli.status
```
````

````{py:function} cancel(job_id: str = typer.Argument(help='Job ID'), scheduler_key: str = typer.Option(None, '--scheduler', help='Scheduler key'))
:canonical: ovo.cli.scheduler_cli.cancel

```{autodoc2-docstring} ovo.cli.scheduler_cli.cancel
```
````

````{py:function} download(job_id: str = typer.Argument(help='Job ID'), output: str = typer.Argument(help='Output directory'), scheduler_key: str = typer.Option(None, '--scheduler', help='Scheduler key'))
:canonical: ovo.cli.scheduler_cli.download

```{autodoc2-docstring} ovo.cli.scheduler_cli.download
```
````

````{py:function} worker(num_workers: int = typer.Option(1, '-n', '--workers', help='Number of worker threads'), connect: bool = typer.Option(False, '--connect', help='Connect to existing queue server instead of starting a new one. Enables running workers with different ENV vars such as CUDA_VISIBLE_DEVICES.'), scheduler_key: str = typer.Option(None, '--scheduler', help='Scheduler key to use'), host: str = typer.Option(None, '--host', help='Run server on custom host (override config)'), port: int = typer.Option(None, '--port', help='Run server on custom port (override config)'))
:canonical: ovo.cli.scheduler_cli.worker

```{autodoc2-docstring} ovo.cli.scheduler_cli.worker
```
````