# Command-line usage

Ewoks exposes the packaged workflows through the `ewoks` command line.
This section summarises the most common commands when working with
`ewokstomo`.

## Show workflow tasks and inputs

``` bash
ewoks show path/to/workflow.json
```

The command shows the content of the workflow as well as the pre-filled inputs. More infos are available [here](https://ewoks.readthedocs.io/en/stable/reference/cli.html#ewoks-show).

## Execute a workflow

``` bash
ewoks execute path/to/workflow.json
```

The command executes the workflow. This assumes that the workflow has already all the 
input it needs (after an `ewoks convert` or a first execution using `-o convert_destination=<new_workflow_name>`). 
In practice, the inputs can be given by command line, still we recommend to use the Python API (see: How-to). More infos are available [here](https://ewoks.readthedocs.io/en/stable/reference/cli.html#ewoks-execute).

## Submit a workflow to a worker

``` bash
ewoks submit path/to/workflow.json
```

The command allow to submit the workflow to a worker. An example on how to setup is available [here](https://ewoksjob.readthedocs.io/en/stable/tutorials/jobs.html).

```{note}
At ESRF you need to specify the queue and have the `BEACON_HOST` variable set.
```

## Install the requirements of the workflow

```bash
ewoks install path/to/workflow.json
```

The command will install the packages required by the workflow to run in the current environment.his assumes that the workflow has already all the 
input it needs (after an `ewoks convert` or a first execution using `-o convert_destination=<new_workflow_name>`). More infos are available [here](https://ewoks.readthedocs.io/en/stable/reference/cli.html#ewoks-install).