jarq 0.2.1

An interactive jq-like JSON query tool with a TUI
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
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88

# jarq

An interactive jq-like JSON query tool with a TUI.

Should you use this instead of `jq`? Definitely not, this was just an experiment using a TUI and live filtering.

## Usage

```bash
# Interactive TUI mode
echo '{"name": "Alice", "age": 30}' | jarq
cat data.json | jarq
jarq data.json

# Non-interactive mode (like jq)
echo '{"name": "Alice"}' | jarq '.name'
jarq '.items[]' data.json
```

In interactive mode, type filter expressions and see results in real-time.

## Keyboard Controls

### Navigation Mode

| Key | Action |
|-----|--------|
| `i`, `/` | Enter filter edit mode |
| `j`, `↓` | Scroll down |
| `k`, `↑` | Scroll up |
| `g` | Go to top |
| `G` | Go to bottom |
| `Ctrl-D` | Page down |
| `Ctrl-U` | Page up |
| `s` | Toggle slurp mode (treat input as single array) |
| `q`, `Esc` | Quit |
| `Ctrl-H` | Show help |

### Filter Edit Mode

| Key | Action |
|-----|--------|
| `Esc` | Exit filter edit mode |
| `Ctrl-P` | Toggle pause/resume background evaluation |
| `Ctrl-C` | Cancel running evaluation (enters pause mode) |
| `Enter` | Evaluate filter on demand (when paused) |
| `Ctrl-H` | Show help (with builtin reference) |

### Background Evaluation

jarq evaluates filters in the background as you type. For large files, you can:

- **Pause evaluation** (`Ctrl-P`): Stop auto-evaluation while you compose a complex filter
- **Cancel evaluation** (`Ctrl-C`): Stop a long-running evaluation and enter pause mode
- **Evaluate on demand** (`Enter`): When paused, manually trigger evaluation

When paused, the filter is still validated for syntax errors in real-time.

## Filter Syntax

```
.               # identity
.foo            # field access
.[0]            # array index
.[-1]           # negative index (from end)
.[]             # iterate all elements
.foo.bar        # chaining
.foo | length   # pipes

# Construction
[.a, .b]        # array
{name: .foo}    # object
{(.key): .val}  # dynamic key
```

## Builtins

`length`, `keys`, `values`, `type`, `first`, `last`, `reverse`, `sort`, `min`, `max`, `unique`, `flatten`, `add`, `empty`, `not`

## Building

```bash
cargo build --release
```

## License

MIT