Skip to content
Riot Docs

Search is only available in production builds. Try building and previewing the site to test it out locally.

Install Riot GitHub

TOML

TOML is the configuration-native complement to JSON in Riot.

If JSON is where machine-first payloads live, TOML is where human-edited structured configuration often fits better.

Riot already leans on configuration files as part of the toolchain story.

That means a good TOML surface matters because:

  • configuration should be readable
  • versioned config should diff well
  • users should not need a separate dependency just to work with configuration data

TOML is usually the better fit for:

  • toolchain configuration
  • package or workspace operational settings
  • documents intended to be read and edited by humans

Use TOML when:

  • the document is configuration
  • the audience is primarily a human editor
  • readability in code review matters

Use JSON when:

  • the document is exchanged between programs
  • the surrounding system already expects JSON
  • canonical machine output is the main concern

That split is simple, but it keeps packages from drifting into unclear configuration habits.