y
y
yq
Search…
y
y
yq
v4.x
yq
How It Works
Upgrading from V3
Commands
Evaluate
Evaluate All
Shell Completion
Operators
Add
Alternative (Default value)
Anchor and Alias Operators
Assign (Update)
Boolean Operators
Collect into Array
Column
Comment Operators
Compare Operators
Contains
Create, Collect into Object
Date Time
Delete
Document Index
Encode / Decode
Entries
Env Variable Operators
Equals
Eval
File Operators
Flatten
Group By
Has
Keys
Length
Line
Load
Map
Multiply (Merge)
Parent
Path
Pick
Pipe
Recursive Descent (Glob)
Reduce
Reverse
Select
Sort
Sort Keys
Split into Documents
String Operators
Style
Subtract
Tag
Traverse (Read)
Union
Unique
Variable Operators
With
Usage
Output format
Working with CSV, TSV
Working with JSON
Working with Properties
Working with XML
Front Matter
Split into multiple files
GitHub Action
Tips, Tricks, Troubleshooting
Github Page
Powered By
GitBook
Style
The style operator can be used to get or set the style of nodes (e.g. string style, yaml style)
Note that versions prior to 4.18 require the 'eval/e' command to be specified.
yq e <exp> <file>
Update and set style of a particular node (simple)
Given a sample.yml file of:
1
a
:
2
b
:
thing
3
c
:
something
Copied!
then
1
yq
'.a.b = "new" | .a.b style="double"'
sample.yml
Copied!
will output
1
a
:
2
b
:
"new"
3
c
:
something
Copied!
Update and set style of a particular node using path variables
Given a sample.yml file of:
1
a
:
2
b
:
thing
3
c
:
something
Copied!
then
1
yq
'with(.a.b ; . = "new" | . style="double")'
sample.yml
Copied!
will output
1
a
:
2
b
:
"new"
3
c
:
something
Copied!
Set tagged style
Given a sample.yml file of:
1
a
:
cat
2
b
:
5
3
c
:
3.2
4
e
:
true
Copied!
then
1
yq
'.. style="tagged"'
sample.yml
Copied!
will output
1
!!map
2
a
:
!!str
cat
3
b
:
!!int
5
4
c
:
!!float
3.2
5
e
:
!!bool
true
Copied!
Set double quote style
Given a sample.yml file of:
1
a
:
cat
2
b
:
5
3
c
:
3.2
4
e
:
true
Copied!
then
1
yq
'.. style="double"'
sample.yml
Copied!
will output
1
a
:
"cat"
2
b
:
"5"
3
c
:
"3.2"
4
e
:
"true"
Copied!
Set double quote style on map keys too
Given a sample.yml file of:
1
a
:
cat
2
b
:
5
3
c
:
3.2
4
e
:
true
Copied!
then
1
yq
'... style="double"'
sample.yml
Copied!
will output
1
"a"
:
"cat"
2
"b"
:
"5"
3
"c"
:
"3.2"
4
"e"
:
"true"
Copied!
Set single quote style
Given a sample.yml file of:
1
a
:
cat
2
b
:
5
3
c
:
3.2
4
e
:
true
Copied!
then
1
yq
'.. style="single"'
sample.yml
Copied!
will output
1
a
:
'cat'
2
b
:
'5'
3
c
:
'3.2'
4
e
:
'true'
Copied!
Set literal quote style
Given a sample.yml file of:
1
a
:
cat
2
b
:
5
3
c
:
3.2
4
e
:
true
Copied!
then
1
yq
'.. style="literal"'
sample.yml
Copied!
will output
1
a
:
|-
2
cat
3
b
:
|-
4
5
5
c
:
|-
6
3.2
7
e
:
|-
8
true
Copied!
Set folded quote style
Given a sample.yml file of:
1
a
:
cat
2
b
:
5
3
c
:
3.2
4
e
:
true
Copied!
then
1
yq
'.. style="folded"'
sample.yml
Copied!
will output
1
a
:
>-
2
cat
3
b
:
>-
4
5
5
c
:
>-
6
3.2
7
e
:
>-
8
true
Copied!
Set flow quote style
Given a sample.yml file of:
1
a
:
cat
2
b
:
5
3
c
:
3.2
4
e
:
true
Copied!
then
1
yq
'.. style="flow"'
sample.yml
Copied!
will output
1
{
a
:
cat
,
b
:
5
,
c
:
3.2
,
e
:
true
}
Copied!
Reset style - or pretty print
Set empty (default) quote style, note the usage of
...
to match keys too. Note that there is a
--prettyPrint/-P
short flag for this.
Given a sample.yml file of:
1
a
:
cat
2
"b"
:
5
3
'c'
:
3.2
4
"e"
:
true
Copied!
then
1
yq
'... style=""'
sample.yml
Copied!
will output
1
a
:
cat
2
b
:
5
3
c
:
3.2
4
e
:
true
Copied!
Set style relatively with assign-update
Given a sample.yml file of:
1
a
:
single
2
b
:
double
Copied!
then
1
yq
'.[] style |= .'
sample.yml
Copied!
will output
1
a
:
'single'
2
b
:
"double"
Copied!
Read style
Given a sample.yml file of:
1
{
a
:
"cat"
,
b
:
'thing'
}
Copied!
then
1
yq
'.. | style'
sample.yml
Copied!
will output
1
flow
2
double
3
single
Copied!
Previous
String Operators
Next
Subtract
Last modified
4mo ago
Copy link
Contents
Update and set style of a particular node (simple)
Update and set style of a particular node using path variables
Set tagged style
Set double quote style
Set double quote style on map keys too
Set single quote style
Set literal quote style
Set folded quote style
Set flow quote style
Reset style - or pretty print
Set style relatively with assign-update
Read style