The Sort Keys operator sorts maps by their keys (based on their string value). This operator does not do anything to arrays or scalars (so you can easily recursively apply it to all maps).
Sort is particularly useful for diffing two different yaml documents:
1
yq -i -P 'sort_keys(..)' file1.yml
2
yq -i -P 'sort_keys(..)' file2.yml
3
diff file1.yml file2.yml
Copied!
Note that yq does not yet consider anchors when sorting by keys - this may result in invalid yaml documents if your are using merge anchors.
Note that versions prior to 4.18 require the 'eval/e' command to be specified.
yq e <exp> <file>
Sort keys of map
Given a sample.yml file of:
1
c: frog
2
a: blah
3
b: bing
Copied!
then
1
yq 'sort_keys(.)' sample.yml
Copied!
will output
1
a: blah
2
b: bing
3
c: frog
Copied!
Sort keys recursively
Note the array elements are left unsorted, but maps inside arrays are sorted