docs/user_guide/utils/main_commands.md


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59

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:

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

* Resume context:

```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
```

!!! note
      Use *null* value to remove an entry.