Skip to content

Commit cac63c2

Browse files
committed
move symlink doc to installation anchor
Signed-off-by: clux <[email protected]>
1 parent 24f7706 commit cac63c2

File tree

1 file changed

+14
-11
lines changed

1 file changed

+14
-11
lines changed

README.md

Lines changed: 14 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,20 @@ cargo binstall lq
2121

2222
**Note**: Depends on `jq` being installed.
2323

24+
### lq as yq
25+
26+
Because yaml is the default input language, you can use it as your top level `yq` executable with a symlink or alias:
27+
28+
```sh
29+
# globally make yq be lq
30+
ln -s $(which lq) /usr/local/bin/yq
31+
32+
# alias yq to lq in shell environment only
33+
alias yq=lq
34+
```
35+
36+
This should be compatible with `python-yq`, but it has some differences with the go yq.
37+
2438
## Why / Why Not
2539

2640
### jq compatibility
@@ -73,17 +87,6 @@ $ lq -y '.[3].metadata' test/deploy.yaml
7387

7488
The default input format is YAML and is what the binary is named for (and the most common primary usage case).
7589

76-
If you want to use it as the top level `yq` executable you can either symlink or alias:
77-
78-
```sh
79-
# globally make yq be lq
80-
ln -s $(which lq) /usr/local/bin/yq
81-
82-
# alias yq to lq in shell environment only
83-
alias yq=lq
84-
```
85-
86-
This should be compatible with `python-yq`, but it has some differences with the go yq.
8790

8891
### TOML Input
8992

0 commit comments

Comments
 (0)