hq-rs 0.7.0

command-line HCL processor
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
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121

# hq

[![ci](https://img.shields.io/github/actions/workflow/status/miller-time/hq/rust.yml)](https://github.com/miller-time/hq/actions/workflows/rust.yml)
[![crate](https://img.shields.io/crates/v/hq-rs)](https://crates.io/crates/hq-rs)
[![docs](https://img.shields.io/docsrs/hq-rs)](https://docs.rs/hq-rs/latest)

`hq` is a command-line HCL processor.

## install

This will install an `hq` binary on your system:

```
$ cargo install hq-rs
```

## usage

Here is an example HCL file:

```hcl
some_attr = {
    foo = [1, 2]
    bar = true
}

some_block "some_block_label" {
    attr = "value"
}

some_block "another_block_label" {
    attr = "another_value"
}
```

You can query the attribute(s) and block(s) in an HCL file like so:

```sh
$ cat example.hcl | hq '.some_attr'
```

```hcl
{
  foo = [
    1,
    2
  ]
  bar = true
}
```

```sh
$ cat example.hcl | hq '.some_attr.foo'
```

```hcl
[
  1,
  2
]
```

```sh
$ cat example.hcl | hq '.some_block'
```

```hcl
some_block "some_block_label" {
  attr = "value"
}
some_block "another_block_label" {
  attr = "another_value"
}
```

```sh
$ cat example.hcl | hq '.some_block[label="some_block_label"].attr'
```

```hcl
"value"
```

```sh
$ cat example.hcl | hq '.some_block[label="another_block_label"].attr'
```

```hcl
"another_value"
```

You can modify HCL (even HCL that is formatted and contains comments) like so:

```sh
$ cat example.hcl | hq '.fmt_block.first_formatted_field' write '"something_new"'
```

```hcl
some_attr = {
    foo = [1, 2]
    bar = true
}

some_block "some_block_label" {
    attr = "value"
}

some_block "another_block_label" {
    attr = "another_value"
}

# this is a block comment
fmt_block "fmt_label" {
    # this is a body comment
    # this is another body comment

    # this is a third body comment
    first_formatted_field  = "something_new"
    second_formatted_field = "second_value"
}
```