ahk-cli 0.2.0

Run an ahk script on this machine: the script on stdin, the report on stdout
Documentation 
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

# ahk-cli

The runner of the tree: a script on standard input, a report on standard
output, in JSON.

```sh
echo 'MsgBox "hello"' | ahk
```

The exit code is 0 when the script finished, 1 when it failed, and 2 when it did
not parse; the report is on standard output in the three cases.

```json
{"ok":true,"steps":[{"line":1,"op":"MsgBox","detail":"hello","ok":true,"elapsed_ms":0}],"output":["hello"],...}
```

## The dialects

The default dialect is **AutoHotkey v2.0.19**. `--dialect=v1` asks for
**v1.1.37.02**, which the same binary speaks.

## The flags

| Flag | What it does |
| --- | --- |
| `--dialect=v1` | Speak the v1 dialect instead of the v2 |
| `--timeout=N` | Stop the script after N seconds (60 by default) |
| `--surface` | Print the names of the dialect and the state of each, and read no script |
| `--surface --json` | The same table, as JSON |
| `--surface --dialect=v1` | The table of the v1 |

## The report

`ok`, `steps`, `output`, `warnings`, `notes`, `error`, `error_line`,
`exit_code`, `elapsed_ms`, `variables`. A statement that completes produces a
step; a statement that fails stops the script and is reported once, in `error`
and `error_line`, and it is not a step.

## Documentation

[`docs/runner-and-report.md`](https://github.com/danalec/ahk/blob/master/docs/runner-and-report.md)
is the guide: the command, the flags, the report field by field, the guard rails
and the emergency stop.

## Licence

Apache-2.0.