Skip to content
On this page

Conversion and Extraction

Taplo makes it easy to convert TOML files to JSON and also extract specific values via the get command.

Examples

The following examples use the TOML file below:

# foo.toml
[foo]
bar = true

[[baz]]
baz_field = "baz 1"

[[baz]]
baz_field = "baz 2"

Converting to JSON

taplo get -f foo.toml -o json

This will yield the following output:

{
  "foo": {
    "bar": true
  },
  "baz": [
    {
      "baz_field": "baz 1"
    },
    {
      "baz_field": "baz 2"
    }
  ]
}

Extracting Specific Values

It is possible to extract specific values via a simple query expressions.

taplo get -f foo.toml 'baz[1].baz_field'

This will yield:

baz 2

WARNING

Expressions with array patterns [] might need to be put between quotation marks for some shells.

INFO

List indexing is 0-based.

By default the value will be "parsed", so that no strings will contain escape sequences or quotation marks.

However it is also possible to change the output format to JSON:

taplo get -f foo.toml -o json baz

will yield:

[
  {
    "baz_field": "baz 1"
  },
  {
    "baz_field": "baz 2"
  }
]

More Examples

More examples for query expressions using the same document above:

expressionoutput formatoutput
baz.0.baz_fieldjson"baz 1"
baz.*.baz_fieldjson[ "baz 1", "baz 2" ]
baz.1.baz_fieldvaluebaz 2
baz.1tomlbaz_field = "baz 2"

INFO

The outputs have been slightly modified to fit into the table format.