Skip to content

[Automated] Update yq CLI Options#2425

Open
thomhurst wants to merge 1 commit intomainfrom
automated/update-cli-options-yq
Open

[Automated] Update yq CLI Options#2425
thomhurst wants to merge 1 commit intomainfrom
automated/update-cli-options-yq

Conversation

@thomhurst
Copy link
Owner

Summary

This PR contains automatically generated updates to yq CLI options classes.

The generator scraped the latest CLI help output from the installed tool.

Changes

  • Updated options classes to reflect latest CLI documentation
  • Added new commands if any were detected
  • Updated option types and descriptions

Verification

  • Solution builds successfully

🤖 Generated with ModularPipelines.OptionsGenerator

@thomhurst thomhurst added automated dependencies Pull requests that update a dependency file labels Feb 22, 2026
@thomhurst thomhurst enabled auto-merge (squash) February 22, 2026 03:30
@thomhurst thomhurst force-pushed the automated/update-cli-options-yq branch from 429bd63 to 5a82eaf Compare March 1, 2026 03:13
Copy link

@claude claude bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This is an automated PR updating the Usage:
yq [flags]
yq [command]

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

update myfile.yml in place

yq -i '.stuff = "foo"' myfile.yml

print contents of sample.json as idiomatic YAML

yq -P -oy sample.json

Available Commands:
completion Generate the autocompletion script for the specified shell
eval (default) Apply the expression to each document in each yaml file in sequence
eval-all Loads all yaml documents of all yaml files and runs expression once
help Help about any command

Flags:
-C, --colors force print with colors
--csv-auto-parse parse CSV YAML/JSON values (default true)
--csv-separator char CSV Separator character (default ,)
--debug-node-info debug node info
-e, --exit-status set exit status if there are no matches or null or false is returned
--expression string forcibly set the expression argument. Useful when yq argument detection thinks your expression is a file.
--from-file string Load expression from specified file.
-f, --front-matter string (extract|process) first input as yaml front-matter. Extract will pull out the yaml content, process will run the expression against the yaml content, leaving the remaining data intact
--header-preprocess Slurp any header comments and separators before processing expression. (default true)
-h, --help help for yq
-I, --indent int sets indent level for output (default 2)
-i, --inplace update the file in place of first file given.
-p, --input-format string [auto|a|yaml|y|kyaml|ky|json|j|props|p|csv|c|tsv|t|xml|x|base64|uri|toml|hcl|h|lua|l|ini|i] parse format for input. (default "auto")
--lua-globals output keys as top-level global variables
--lua-prefix string prefix (default "return ")
--lua-suffix string suffix (default ";\n")
--lua-unquoted output unquoted string keys (e.g. {foo="bar"})
-M, --no-colors force print with no colors
-N, --no-doc Don't print document separators (---)
-0, --nul-output Use NUL char to separate values. If unwrap scalar is also set, fail if unwrapped scalar contains NUL char.
-n, --null-input Don't read input, simply evaluate the expression given. Useful for creating docs from scratch.
-o, --output-format string [auto|a|yaml|y|kyaml|ky|json|j|props|p|csv|c|tsv|t|xml|x|base64|uri|toml|hcl|h|shell|s|lua|l|ini|i] output format type. (default "auto")
-P, --prettyPrint pretty print, shorthand for '... style = ""'
--properties-array-brackets use [x] in array paths (e.g. for SpringBoot)
--properties-separator string separator to use between keys and values (default " = ")
--security-disable-env-ops Disable env related operations.
--security-disable-file-ops Disable file related operations (e.g. load)
--shell-key-separator string separator for shell variable key paths (default "")
-s, --split-exp string print each result (or doc) into a file named (exp). [exp] argument must return a string. You can use $index in the expression as the result counter. The necessary directories will be created.
--split-exp-file string Use a file to specify the split-exp expression.
--string-interpolation Toggles strings interpolation of (exp) (default true)
--tsv-auto-parse parse TSV YAML/JSON values (default true)
-r, --unwrapScalar unwrap scalar, print the value with no quotes, colours or comments. Defaults to true for yaml (default true)
-v, --verbose verbose mode
-V, --version Print version information and quit
--xml-attribute-prefix string prefix for xml attributes (default "+@")
--xml-content-name string name for xml content (if no attribute name is present). (default "+content")
--xml-directive-name string name for xml directives (e.g. ) (default "+directive")
--xml-keep-namespace enables keeping namespace after parsing attributes (default true)
--xml-proc-inst-prefix string prefix for xml processing instructions (e.g. ) (default "+p
")
--xml-raw-token enables using RawToken method instead Token. Commonly disables namespace translations. See https://pkg.go.dev/encoding/xml#Decoder.RawToken for details. (default true)
--xml-skip-directives skip over directives (e.g. )
--xml-skip-proc-inst skip over process instructions (e.g. )
--xml-strict-mode enables strict parsing of XML. See https://pkg.go.dev/encoding/xml for more details.
-c, --yaml-compact-seq-indent Use compact sequence indentation where '- ' is considered part of the indentation.
--yaml-fix-merge-anchor-to-spec Fix merge anchor to match YAML spec. Will default to true in late 2025

Use "yq [command] --help" for more information about a command. CLI options generator timestamp.

Change Summary

The only change is a timestamp update in :

  • Before: 2026-02-15T03:12:04.5805950Z
  • After: 2026-03-01T03:12:17.1379905Z

Observations

No functional changes: Despite the PR description mentioning "Updated options classes to reflect latest CLI documentation", "Added new commands if any were detected", and "Updated option types and descriptions", the actual diff contains only a timestamp update. This means the generator ran and found no changes in the yq CLI options since the last generation — the yq CLI interface has not changed between runs.

Correctness: The timestamp update is accurate and reflects the regeneration time. This is appropriate behavior — the generator correctly records when it last ran, even when no functional changes were detected.

PR description boilerplate: The PR template appears to always list all possible change categories regardless of what actually changed. It might be worth making the template more dynamic (e.g., only listing the categories where actual changes occurred) to avoid misleading descriptions for timestamp-only updates. That said, this is a minor concern for an automated workflow.

Verdict

The change is correct and safe to merge. The auto-merge enabled via squash is appropriate for this type of automated dependency/options update.

Copy link

@claude claude bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This is an automated PR updating the yq CLI options generator timestamp.

Change Summary

The only change is a timestamp update in AssemblyInfo.Generated.cs:

  • Before: 2026-02-15T03:12:04.5805950Z
  • After: 2026-03-01T03:12:17.1379905Z

Observations

No functional changes: Despite the PR description mentioning "Updated options classes to reflect latest CLI documentation", "Added new commands if any were detected", and "Updated option types and descriptions", the actual diff contains only a timestamp update. This means the generator ran and found no changes in the yq CLI options since the last generation — the yq CLI interface has not changed between runs.

Correctness: The timestamp update is accurate and reflects the regeneration time. This is appropriate behavior — the generator correctly records when it last ran, even when no functional changes were detected.

PR description boilerplate: The PR template appears to always list all possible change categories regardless of what actually changed. It might be worth making the template more dynamic (e.g., only listing the categories where actual changes occurred) to avoid misleading descriptions for timestamp-only updates. That said, this is a minor concern for an automated workflow.

Verdict

The change is correct and safe to merge. The auto-merge enabled via squash is appropriate for this type of automated dependency/options update.

Copy link

@claude claude bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This is an automated PR updating the yq CLI options generator timestamp.

Change Summary

The only change is a timestamp update in AssemblyInfo.Generated.cs:

  • Before: 2026-02-15T03:12:04.5805950Z
  • After: 2026-03-01T03:12:17.1379905Z

Observations

No functional changes: Despite the PR description mentioning Updated options classes to reflect latest CLI documentation, Added new commands if any were detected, and Updated option types and descriptions, the actual diff contains only a timestamp update. This means the generator ran and found no changes in the yq CLI options since the last generation - the yq CLI interface has not changed between runs.

Correctness: The timestamp update is accurate and reflects the regeneration time. This is appropriate behavior - the generator correctly records when it last ran, even when no functional changes were detected.

PR description boilerplate: The PR template appears to always list all possible change categories regardless of what actually changed. It might be worth making the template more dynamic (e.g., only listing the categories where actual changes occurred) to avoid misleading descriptions for timestamp-only updates. That said, this is a minor concern for an automated workflow.

Verdict

The change is correct and safe to merge. The auto-merge enabled via squash is appropriate for this type of automated dependency/options update.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

automated dependencies Pull requests that update a dependency file

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant