mirror of
https://github.com/mikefarah/yq.git
synced 2024-11-12 05:38:04 +00:00
Man page wip
This commit is contained in:
parent
948399f163
commit
e741e6d52f
@ -1,11 +1,19 @@
|
||||
# NAME
|
||||
*yq* is a portable command-line YAML processor (https://github.com/mikefarah/yq/)
|
||||
*yq* is a portable command-line YAML processor
|
||||
|
||||
# SYNOPSIS
|
||||
|
||||
yq [eval/eval-all] [expression] files..
|
||||
|
||||
eval/e - Apply the expression to each document in each yaml file in sequence
|
||||
|
||||
eval-all/ea - Loads all yaml documents of all yaml files and runs expression once
|
||||
|
||||
# DESCRIPTION
|
||||
|
||||
a lightweight and portable command-line YAML processor. `yq` uses [jq](https://github.com/stedolan/jq) like syntax but works with yaml files as well as json. It doesn't yet support everything `jq` does - but it does support the most common operations and functions, and more is being added continuously.
|
||||
|
||||
This documentation is also available at https://mikefarah.gitbook.io/yq/.
|
||||
|
||||
This documentation is also available at https://mikefarah.gitbook.io/yq/
|
||||
# QUICK GUIDE
|
||||
|
||||
## Read a value:
|
||||
@ -48,3 +56,6 @@ See the [documentation](https://mikefarah.gitbook.io/yq/) for more.
|
||||
- `yq` attempts to preserve comment positions and whitespace as much as possible, but it does not handle all scenarios (see https://github.com/go-yaml/yaml/tree/v3 for details)
|
||||
- Powershell has its own...opinions: https://mikefarah.gitbook.io/yq/usage/tips-and-tricks#quotes-in-windows-powershell
|
||||
|
||||
# BUGS / ISSUES / FEATURE REQUESTS
|
||||
|
||||
Please visit the GitHub page https://github.com/mikefarah/yq/.
|
@ -18,4 +18,11 @@ for f in ./pkg/yqlib/doc/*.md; do
|
||||
|
||||
done
|
||||
|
||||
pandoc --variable=title:"yq" --variable=section:"1" --variable=author:"Mike Farah" --standalone --to man man.md -o yq.1
|
||||
header=$(./yq --version)
|
||||
|
||||
pandoc \
|
||||
--variable=title:"YQ" \
|
||||
--variable=section:"1" \
|
||||
--variable=author:"Mike Farah" \
|
||||
--variable=header:"${header}" \
|
||||
--standalone --to man man.md -o yq.1
|
Loading…
Reference in New Issue
Block a user