Main commands
=============

The **ArGaze** package comes with top-level commands.

!!! note
      *Use -h option to get command arguments documentation.*

## Load

Load and execute any [ArContext](../../argaze.md/#argaze.ArFeatures.ArContext) from a JSON CONFIGURATION file

```shell
python -m argaze load CONFIGURATION
```

This command should open a GUI window to display the image of the context's pipeline.

![ArGaze load GUI](../../img/argaze_load_gui.png)

### Send command

Use -p option to enable pipe communication at given address:

```shell
python -m argaze load CONFIGURATION -p /tmp/argaze
```

Open another tab in the **same** Terminal window then, you can send any Python command into the pipe.

For example:

* Print context:
```shell
echo "print(context)" > /tmp/argaze
```

* Pause context processing:

```shell
echo "context.pause()" > /tmp/argaze
```

* Resume context processing:

```shell
echo "context.resume()" > /tmp/argaze
```

## Edit

Modify the content of JSON CONFIGURATION file with another JSON CHANGES file then, save the result into an OUTPUT file

```shell
python -m argaze edit CONFIGURATION CHANGES OUTPUT
```