Skip to content

Commit 24f7706

Browse files
committed
document symlink better
Signed-off-by: clux <sszynrae@gmail.com>
1 parent 33eb219 commit 24f7706

1 file changed

Lines changed: 11 additions & 1 deletion

File tree

README.md

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -73,7 +73,17 @@ $ lq -y '.[3].metadata' test/deploy.yaml
7373

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

76-
If you want to use it as the top level `yq` executable you can `alias yq=lq`. This should be compatible with `python-yq`, but it has some differences with the go yq.
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.
7787

7888
### TOML Input
7989

0 commit comments

Comments
 (0)