suyiiyii/yq
1
0
Fork 0
mirror of https://github.com/mikefarah/yq.git synced 2026-09-06 18:24:57 +08:00
Code Issues Packages Projects Releases Wiki Activity

Updating references to yq being a YAML processor

Browse Source
This commit is contained in:
Mike Farah
2023-11-30 15:32:21 +11:00
parent 638deed03e
commit 779b26310e
7 changed files with 14 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files
cmd/root.go
+5 -3
View File
@@ -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