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
Comment Operators
Contains
Create, Collect into Object
Delete
Document Index
Encode / Decode
Entries
Env Variable Operators
Equals
File Operators
Flatten
Group By
Has
Keys
Length
Load
Map
Multiply (Merge)
Parent
Path
Pipe
Recursive Descent (Glob)
Reduce
Select
Sort
Sort Keys
Split into Documents
String Operators
Style
Subtract
Tag
Traverse (Read)
Union
Unique
Variable Operators
With
Usage
Output format
Working with Properties
Working with CSV, TSV
Working with JSON
Working with XML
Front Matter
Split into multiple files
GitHub Action
Tips, Tricks, Troubleshooting
Github Page
Powered By GitBook
Keys
Use the keys operator to return map keys or array indices.

Map keys

Given a sample.yml file of:
1
dog: woof
2
cat: meow
Copied!
then
1
yq eval 'keys' sample.yml
Copied!
will output
1
- dog
2
- cat
Copied!

Array keys

Given a sample.yml file of:
1
- apple
2
- banana
Copied!
then
1
yq eval 'keys' sample.yml
Copied!
will output
1
- 0
2
- 1
Copied!

Retrieve array key

Given a sample.yml file of:
1
- 1
2
- 2
3
- 3
Copied!
then
1
yq eval '.[1] | key' sample.yml
Copied!
will output
1
1
Copied!

Retrieve map key

Given a sample.yml file of:
1
a: thing
Copied!
then
1
yq eval '.a | key' sample.yml
Copied!
will output
1
a
Copied!

No key

Given a sample.yml file of:
1
{}
Copied!
then
1
yq eval 'key' sample.yml
Copied!
will output
1
​
Copied!

Update map key

Given a sample.yml file of:
1
a:
2
x: 3
3
y: 4
Copied!
then
1
yq eval '(.a.x | key) = "meow"' sample.yml
Copied!
will output
1
a:
2
meow: 3
3
y: 4
Copied!

Get comment from map key

Given a sample.yml file of:
1
a:
2
# comment on key
3
x: 3
4
y: 4
Copied!
then
1
yq eval '.a.x | key | headComment' sample.yml
Copied!
will output
1
comment on key
Copied!
Previous
Has
Next
Length
Last modified 1mo ago
Copy link
Contents
Map keys
Array keys
Retrieve array key
Retrieve map key
No key
Update map key
Get comment from map key