diff --git a/.github/workflows/docker-release.yml b/.github/workflows/docker-release.yml index 9840d2bc..40a5b32b 100644 --- a/.github/workflows/docker-release.yml +++ b/.github/workflows/docker-release.yml @@ -45,7 +45,7 @@ jobs: docker buildx build \ --label "org.opencontainers.image.authors=https://github.com/mikefarah/yq/graphs/contributors" \ --label "org.opencontainers.image.created=$(date --rfc-3339=seconds)" \ - --label "org.opencontainers.image.description=yq is a portable command-line YAML processor" \ + --label "org.opencontainers.image.description=yq is a portable command-line data file processor" \ --label "org.opencontainers.image.documentation=https://mikefarah.gitbook.io/yq/" \ --label "org.opencontainers.image.licenses=MIT" \ --label "org.opencontainers.image.revision=$(git rev-parse HEAD)" \ @@ -65,7 +65,7 @@ jobs: docker buildx build \ --label "org.opencontainers.image.authors=https://github.com/mikefarah/yq/graphs/contributors" \ --label "org.opencontainers.image.created=$(date --rfc-3339=seconds)" \ - --label "org.opencontainers.image.description=yq is a portable command-line YAML processor" \ + --label "org.opencontainers.image.description=yq is a portable command-line data file processor" \ --label "org.opencontainers.image.documentation=https://mikefarah.gitbook.io/yq/" \ --label "org.opencontainers.image.licenses=MIT" \ --label "org.opencontainers.image.revision=$(git rev-parse HEAD)" \ diff --git a/cmd/evaluate_all_command.go b/cmd/evaluate_all_command.go index 782da24c..f56c1cae 100644 --- a/cmd/evaluate_all_command.go +++ b/cmd/evaluate_all_command.go @@ -26,7 +26,7 @@ yq ea '. as $item ireduce ({}; . * $item )' file1.yml file2.yml ... ## use '-' as a filename to pipe from STDIN cat file2.yml | yq ea '.a.b' file1.yml - file3.yml `, - Long: `yq is a portable command-line YAML processor (https://github.com/mikefarah/yq/) + Long: `yq is a portable command-line data file processor (https://github.com/mikefarah/yq/) See https://mikefarah.gitbook.io/yq/ for detailed documentation and examples. ## Evaluate All ## diff --git a/cmd/evaluate_sequence_command.go b/cmd/evaluate_sequence_command.go index 660d746c..119f3876 100644 --- a/cmd/evaluate_sequence_command.go +++ b/cmd/evaluate_sequence_command.go @@ -31,7 +31,7 @@ yq e -n '.a.b.c = "cat"' # Update a file in place yq e '.a.b = "cool"' -i file.yaml `, - Long: `yq is a portable command-line YAML processor (https://github.com/mikefarah/yq/) + Long: `yq is a portable command-line data file processor (https://github.com/mikefarah/yq/) See https://mikefarah.gitbook.io/yq/ for detailed documentation and examples. ## Evaluate Sequence ## diff --git a/cmd/root.go b/cmd/root.go index dcf0e4ef..897c8175 100644 --- a/cmd/root.go +++ b/cmd/root.go @@ -11,11 +11,13 @@ import ( func New() *cobra.Command { var rootCmd = &cobra.Command{ Use: "yq", - Short: "yq is a lightweight and portable command-line YAML processor.", - Long: `yq is a portable command-line YAML processor (https://github.com/mikefarah/yq/) + Short: "yq is a lightweight and portable command-line data file processor.", + Long: `yq is a portable command-line data file processor (https://github.com/mikefarah/yq/) See https://mikefarah.gitbook.io/yq/ for detailed documentation and examples.`, Example: ` -# yq defaults to 'eval' command if no command is specified. See "yq eval --help" for more examples. +# yq tries to auto-detect the file format based off the extension, and defaults to YAML if it's unknown (or piping through STDIN) +# Use the '-p/--input-format' flag to specify a format type. +cat file.xml | yq -p xml # read the "stuff" node from "myfile.yml" yq '.stuff' < myfile.yml diff --git a/debian/control b/debian/control index 625bfb3d..767afca6 100644 --- a/debian/control +++ b/debian/control @@ -16,7 +16,7 @@ XSBC-Original-Maintainer: Roberto Mier Escandón Package: yq Architecture: any Depends: ${shlibs:Depends}, ${misc:Depends} -Description: lightweight and portable command-line YAML processor +Description: lightweight and portable command-line data file processor . The aim of the project is to be the [jq](https://github.com/stedolan/jq) or sed of yaml files. diff --git a/pkg/yqlib/doc/operators/headers/Main.md b/pkg/yqlib/doc/operators/headers/Main.md index d6c4c1c7..548a0f29 100644 --- a/pkg/yqlib/doc/operators/headers/Main.md +++ b/pkg/yqlib/doc/operators/headers/Main.md @@ -1,5 +1,5 @@ # NAME - *yq* is a portable command-line YAML processor + *yq* is a portable command-line data file processor # SYNOPSIS @@ -11,7 +11,7 @@ eval-all/ea - Loads all yaml documents of all yaml files and runs expression onc # 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. +a lightweight and portable command-line data file processor. `yq` uses [jq](https://github.com/stedolan/jq) like syntax but works with yaml, json, xml, csv, properties and TOML files. 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/ # QUICK GUIDE diff --git a/snap/snapcraft.yaml b/snap/snapcraft.yaml index e211b4e7..1a7c3b20 100644 --- a/snap/snapcraft.yaml +++ b/snap/snapcraft.yaml @@ -1,8 +1,8 @@ name: yq version: 'v4.40.3' -summary: A lightweight and portable command-line YAML processor +summary: A lightweight and portable command-line data file processor description: | - The aim of the project is to be the jq or sed of yaml files. + `yq` uses [jq](https://github.com/stedolan/jq) like syntax but works with yaml, json, xml, csv, properties and TOML files. base: core18 grade: stable # devel|stable. must be 'stable' to release into candidate/stable channels confinement: strict