README.md
Token-Oriented Object Notation is a compact, human-readable encoding of the JSON data model that minimizes tokens and makes structure easy for models to follow. It's intended for LLM input as a drop-in, lossless representation of your existing JSON.
TOON combines YAML's indentation-based structure for nested objects with a CSV-style tabular form for uniform arrays. Its sweet spot is uniform arrays of objects β multiple fields per row, same structure across items β reaching CSV-like compactness while adding explicit structure that helps LLMs parse and validate data reliably. For deeply nested or non-uniform data, JSON may be more efficient.
Think of it as a translation layer: use JSON programmatically, and encode it as TOON for LLM input.
[!TIP] The TOON format is stable, but also an idea in progress. Nothing's set in stone β help shape where it goes by contributing to the spec or sharing feedback.
AI is becoming cheaper and more accessible, but larger context windows allow for larger data inputs as well. LLM tokens still cost money β and standard JSON is verbose and token-expensive:
{
"location": {
"city": "Berlin",
"country": "DE",
"units": "metric"
},
"alerts": [
"frost",
"wind"
],
"forecast": [
{
"day": "Mon",
"temp": {
"min": -2,
"max": 4
},
"condition": "snow",
"rainChance": 80
},
{
"day": "Tue",
"temp": {
"min": 1,
"max": 7
},
"condition": "cloudy",
"rainChance": 20
},
{
"day": "Wed",
"temp": {
"min": 3,
"max": 11
},
"condition": "sunny",
"rainChance": 5
}
]
}
location:
city: Berlin
country: DE
units: metric
alerts:
- frost
- wind
forecast:
- day: Mon
temp:
min: -2
max: 4
condition: snow
rainChance: 80
- day: Tue
temp:
min: 1
max: 7
condition: cloudy
rainChance: 20
- day: Wed
temp:
min: 3
max: 11
condition: sunny
rainChance: 5
TOON conveys the same information with even fewer tokens β combining YAML-like indentation with CSV-style tabular arrays:
location:
city: Berlin
country: DE
units: metric
alerts[2]: frost,wind
forecast[3]{day,temp{min,max},condition,rainChance}:
Mon,-2,4,snow,80
Tue,1,7,cloudy,20
Wed,3,11,sunny,5
Three things are happening at once. Two are forms β one rendering of a value, picked automatically from the data's shape β and the third is a header feature:
alerts[2]: frost,wind is inline form: a primitive array on its header line.forecast[3]{day,β¦}: is tabular form: the field list is declared once in the header, then one row per element.temp{min,max} inside that header is a nested field group: the uniform nested temp objects fold into the header while rows stay flat.The third form is keyed tabular, for objects whose values are uniform objects β config maps, feature flags, records by ID. The colon after the length ([2:]) marks it, and each row carries its own key:
{
"environments": {
"production": { "region": "eu-central-1", "replicas": 6, "debug": false },
"staging": { "region": "eu-central-1", "replicas": 2, "debug": true }
}
}
environments[2:]{region,replicas,debug}:
production: eu-central-1,6,false
staging: eu-central-1,2,true
Anything that fits none of these β mixed types, non-uniform objects β falls back to the fourth form, list form: one - item per element, or a bare - for an empty object. Those four cover the shapes; the Format Overview covers the rest.
[!TIP] Try it on your own data β no install required:
bashcat data.json | npx @toon-format/cli --statsIt prints the TOON alongside what the conversion saved:
βΉ Token estimates: ~117 (JSON) β ~66 (TOON) β Saved ~51 tokens (-43.6%)
[N] lengths and {fields} field lists give models a clear schema to follow, improving parsing reliability.TOON excels with uniform arrays of objects. Reach for something else when:
Benchmarks below quantify the token and accuracy trade-offs; latency is the one you have to measure yourself.
Two tracks, so every comparison is like-for-like:
Benchmarks test LLM comprehension across different input formats using 244 data retrieval questions on 4 models.
<details> <summary><strong>Show Dataset Catalog</strong></summary>| Dataset | Rows | Structure | CSV Support | Eligibility |
|---|---|---|---|---|
| Uniform employee records | 100 | uniform | β | 100% |
| E-commerce orders with nested structures | 50 | nested | β | 33% |
| Time-series analytics data | 60 | uniform | β | 100% |
| Top 100 GitHub repositories | 100 | uniform | β | 100% |
| Semi-uniform event logs | 75 | semi-uniform | β | 50% |
| Deeply nested configuration | 1 | deep | β | 0% |
| Valid complete dataset (control) | 20 | uniform | β | 100% |
| Array truncated: 3 rows removed from end | 20 | uniform | β | 100% |
| Extra rows added beyond declared length | 20 | uniform | β | 100% |
| Inconsistent field count (missing salary in row 10) | 20 | uniform | β | 100% |
| Missing required fields (no email in multiple rows) | 20 | uniform | β | 100% |
| Feature flags keyed by name | 40 | uniform | β | 100% |
| Contacts with nested address and plan groups | 50 | nested | β | 100% |
Structure classes:
CSV Support: β (supported), β (not supported β would require lossy flattening)
Eligibility: Percentage of arrays that qualify for TOON's tabular form (uniform objects with primitive values)
</details>Each format ranked by efficiency (accuracy percentage per 1,000 tokens):
TOON ββββββββββββββββββββ 29.2 acc%/1K tok β 72.2% Β±2.8 acc β 2,474 tokens
JSON compact ββββββββββββββββββββ 23.8 acc%/1K tok β 69.0% Β±2.9 acc β 2,892 tokens
YAML ββββββββββββββββββββ 20.1 acc%/1K tok β 70.1% Β±2.9 acc β 3,487 tokens
JSON ββββββββββββββββββββ 16.6 acc%/1K tok β 71.4% Β±2.8 acc β 4,308 tokens
XML ββββββββββββββββββββ 14.4 acc%/1K tok β 70.7% Β±2.9 acc β 4,909 tokens
Efficiency score = (Accuracy % Γ· Tokens) Γ 1,000. Higher is better.
[!TIP] TOON achieves 72.2% accuracy (vs JSON's 71.4%) while using 42.6% fewer tokens.
[!NOTE] CSV is excluded from the ranking as it only supports 109 of 244 questions (flat tabular data only). While CSV is highly token-efficient for simple tabular data, it cannot represent nested structures that other formats handle.
Every format answers the same 109 flat-dataset questions per model, so CSV can be compared on equal footing here.
| Format | Accuracy | Correct/Total | Avg Tokens |
|---|---|---|---|
toon | 63.1% Β±4.5 | 275/436 | 1,994 |
csv | 62.2% Β±4.5 | 271/436 | 1,851 |
json-pretty | 60.3% Β±4.6 | 263/436 | 3,950 |
xml | 60.1% Β±4.6 | 262/436 | 4,516 |
yaml | 59.9% Β±4.6 | 261/436 | 3,270 |
json-compact | 58.0% Β±4.6 | 253/436 | 2,718 |
Accuracy across 4 LLMs on 244 data retrieval questions:
claude-haiku-4-5-20251001
β TOON ββββββββββββββββββββ 65.6% Β±5.9 (160/244)
JSON ββββββββββββββββββββ 63.5% Β±6.0 (155/244)
XML ββββββββββββββββββββ 62.3% Β±6.0 (152/244)
YAML ββββββββββββββββββββ 62.3% Β±6.0 (152/244)
JSON compact ββββββββββββββββββββ 61.9% Β±6.0 (151/244)
CSV ββββββββββββββββββββ 49.5% Β±9.2 (54/109)
gemini-3.6-flash
β TOON ββββββββββββββββββββ 69.3% Β±5.8 (169/244)
JSON ββββββββββββββββββββ 68.4% Β±5.8 (167/244)
YAML ββββββββββββββββββββ 67.6% Β±5.8 (165/244)
XML ββββββββββββββββββββ 65.2% Β±5.9 (159/244)
JSON compact ββββββββββββββββββββ 63.5% Β±6.0 (155/244)
CSV ββββββββββββββββββββ 57.8% Β±9.1 (63/109)
gpt-5.4-nano
XML ββββββββββββββββββββ 59.4% Β±6.1 (145/244)
JSON ββββββββββββββββββββ 57.4% Β±6.2 (140/244)
β TOON ββββββββββββββββββββ 57.0% Β±6.2 (139/244)
JSON compact ββββββββββββββββββββ 54.9% Β±6.2 (134/244)
YAML ββββββββββββββββββββ 54.5% Β±6.2 (133/244)
CSV ββββββββββββββββββββ 46.8% Β±9.2 (51/109)
grok-4.5
β TOON ββββββββββββββββββββ 97.1% Β±2.2 (237/244)
JSON ββββββββββββββββββββ 96.3% Β±2.5 (235/244)
XML ββββββββββββββββββββ 95.9% Β±2.6 (234/244)
YAML ββββββββββββββββββββ 95.9% Β±2.6 (234/244)
JSON compact ββββββββββββββββββββ 95.5% Β±2.7 (233/244)
CSV ββββββββββββββββββββ 94.5% Β±4.5 (103/109)
<details> <summary><strong>Performance by dataset and question type</strong></summary>[!NOTE] Accuracy figures include Wilson 95% confidence intervals (Β±); when two formats' intervals overlap, the difference between them is not statistically meaningful. CSV answers only the 109 flat-dataset questions, so its per-model cells cover a smaller, easier population than the other formats.
| Question Type | TOON | JSON | XML | YAML | JSON compact | CSV |
|---|---|---|---|---|---|---|
| Field Retrieval | 97.8% | 99.2% | 99.2% | 99.7% | 98.9% | 100.0% |
| Aggregation | 48.4% | 48.4% | 46.0% | 46.0% | 45.2% | 32.8% |
| Filtering | 38.0% | 41.1% | 37.5% | 40.1% | 38.0% | 33.3% |
| Structure Awareness | 90.3% | 84.0% | 84.0% | 79.2% | 78.5% | 82.8% |
| Structural Validation | 100.0% | 50.0% | 80.0% | 50.0% | 45.0% | 80.0% |
| Format | Accuracy | Tokens | Correct/Total |
|---|---|---|---|
csv | 64.6% | 2,336 | 106/164 |
toon | 62.8% | 2,537 | 103/164 |
json-compact | 62.2% | 3,919 | 102/164 |
yaml | 64.0% | 4,982 | 105/164 |
json-pretty | 62.2% | 6,326 | 102/164 |
xml | 61.0% | 7,286 | 100/164 |
| Format | Accuracy | Tokens | Correct/Total |
|---|---|---|---|
json-compact | 70.7% | 6,875 | 116/164 |
toon | 71.3% | 7,344 | 117/164 |
yaml | 72.0% | 8,456 | 118/164 |
json-pretty | 71.3% | 10,842 | 117/164 |
xml | 74.4% | 12,180 | 122/164 |
| Format | Accuracy | Tokens | Correct/Total |
|---|---|---|---|
csv | 64.2% | 1,408 | 77/120 |
toon | 63.3% | 1,595 | 76/120 |
json-compact | 59.2% | 2,351 | 71/120 |
yaml | 62.5% | 2,951 | 75/120 |
json-pretty | 65.0% | 3,678 | 78/120 |
xml | 62.5% | 4,386 | 75/120 |
| Format | Accuracy | Tokens | Correct/Total |
|---|---|---|---|
toon | 57.6% | 9,017 | 76/132 |
csv | 54.5% | 8,726 | 72/132 |
json-compact | 53.8% | 11,650 | 71/132 |
yaml | 53.8% | 13,350 | 71/132 |
json-pretty | 55.3% | 15,350 | 73/132 |
xml | 53.8% | 17,304 | 71/132 |
| Format | Accuracy | Tokens | Correct/Total |
|---|---|---|---|
json-compact | 56.7% | 4,793 | 68/120 |
toon | 60.8% | 5,814 | 73/120 |
json-pretty | 60.0% | 6,759 | 72/120 |
yaml | 55.0% | 5,798 | 66/120 |
xml | 50.8% | 7,668 | 61/120 |
| Format | Accuracy | Tokens | Correct/Total |
|---|---|---|---|
json-compact | 91.4% | 562 | 106/116 |
yaml | 93.1% | 675 | 108/116 |
toon | 91.4% | 669 | 106/116 |
json-pretty | 94.8% | 918 | 110/116 |
xml | 94.0% | 1,007 | 109/116 |
| Format | Accuracy | Tokens | Correct/Total |
|---|---|---|---|
toon | 100.0% | 566 | 4/4 |
json-compact | 100.0% | 772 | 4/4 |
yaml | 100.0% | 984 | 4/4 |
json-pretty | 100.0% | 1,259 | 4/4 |
xml | 0.0% | 1,441 | 0/4 |
csv | 0.0% | 473 | 0/4 |
| Format | Accuracy | Tokens | Correct/Total |
|---|---|---|---|
csv | 100.0% | 408 | 4/4 |
toon | 100.0% | 498 | 4/4 |
xml | 100.0% | 1,229 | 4/4 |
json-pretty | 0.0% | 1,075 | 0/4 |
yaml | 0.0% | 841 | 0/4 |
json-compact | 0.0% | 660 | 0/4 |
| Format | Accuracy | Tokens | Correct/Total |
|---|---|---|---|
csv | 100.0% | 547 | 4/4 |
toon | 100.0% | 644 | 4/4 |
xml | 100.0% | 1,663 | 4/4 |
json-pretty | 0.0% | 1,452 | 0/4 |
yaml | 0.0% | 1,135 | 0/4 |
json-compact | 0.0% | 893 | 0/4 |
| Format | Accuracy | Tokens | Correct/Total |
|---|---|---|---|
csv | 100.0% | 470 | 4/4 |
toon | 100.0% | 563 | 4/4 |
json-compact | 75.0% | 767 | 3/4 |
xml | 100.0% | 1,432 | 4/4 |
yaml | 75.0% | 977 | 3/4 |
json-pretty | 75.0% | 1,251 | 3/4 |
| Format | Accuracy | Tokens | Correct/Total |
|---|---|---|---|
csv | 100.0% | 442 | 4/4 |
toon | 100.0% | 535 | 4/4 |
xml | 100.0% | 1,386 | 4/4 |
yaml | 75.0% | 941 | 3/4 |
json-pretty | 75.0% | 1,207 | 3/4 |
json-compact | 50.0% | 732 | 2/4 |
| Format | Accuracy | Tokens | Correct/Total |
|---|---|---|---|
toon | 97.1% | 931 | 66/68 |
json-compact | 94.1% | 1,264 | 64/68 |
yaml | 92.6% | 1,443 | 63/68 |
json-pretty | 95.6% | 1,873 | 65/68 |
xml | 95.6% | 2,306 | 65/68 |
| Format | Accuracy | Tokens | Correct/Total |
|---|---|---|---|
toon | 94.4% | 1,444 | 68/72 |
json-compact | 91.7% | 2,357 | 66/72 |
yaml | 94.4% | 2,797 | 68/72 |
json-pretty | 97.2% | 4,014 | 70/72 |
xml | 98.6% | 4,534 | 71/72 |
claude-haiku-4-5-20251001, gemini-3.6-flash, gpt-5.4-nano, grok-4.5gpt-tokenizer with o200k_base encoding (GPT-5 tokenizer). Other providers tokenize differently, so absolute counts are tokenizer-specific; relative differences between formats hold directionally.reasoning: 'none' (Gemini 3 floors at minimal thinking, grok-4.5 at low)What the datasets contain, how the questions are generated, and how answers are validated is documented in the benchmark README.
<!-- /automd -->Token counts are measured using the GPT-5 o200k_base tokenizer via gpt-tokenizer. Savings are calculated against formatted JSON (2-space indentation) as the primary baseline, with additional comparisons to compact JSON (minified), YAML, and XML. Actual savings vary by model and tokenizer.
The benchmarks test datasets across different structural patterns (uniform, semi-uniform, nested, deeply nested) to show where TOON excels and where other formats may be better.
<!-- automd:file src="./benchmarks/results/token-efficiency.md" -->Datasets with nested or semi-uniform structures. CSV excluded as it cannot properly represent these structures.
π E-commerce orders with nested structures β Tabular: 33%
β
TOON ββββββββββββββββββββ 72,832 tokens
ββ vs JSON (β32.9%) 108,611 tokens
ββ vs JSON compact (+5.6%) 68,944 tokens
ββ vs YAML (β14.0%) 84,701 tokens
ββ vs XML (β40.4%) 122,119 tokens
π§Ύ Semi-uniform event logs β Tabular: 50%
β
TOON ββββββββββββββββββββ 154,084 tokens
ββ vs JSON (β15.0%) 181,201 tokens
ββ vs JSON compact (+19.9%) 128,529 tokens
ββ vs YAML (β0.8%) 155,397 tokens
ββ vs XML (β25.2%) 205,859 tokens
π§© Deeply nested configuration β Tabular: 0%
β
TOON ββββββββββββββββββββ 589 tokens
ββ vs JSON (β34.9%) 905 tokens
ββ vs JSON compact (+6.7%) 552 tokens
ββ vs YAML (β11.0%) 662 tokens
ββ vs XML (β40.9%) 997 tokens
π Feature flags keyed by name β Tabular: 100%
β
TOON ββββββββββββββββββββ 10,503 tokens
ββ vs JSON (β54.6%) 23,141 tokens
ββ vs JSON compact (β32.8%) 15,635 tokens
ββ vs YAML (β41.3%) 17,905 tokens
ββ vs XML (β63.3%) 28,655 tokens
π Contacts with nested address and plan groups β Tabular: 100%
β
TOON ββββββββββββββββββββ 26,726 tokens
ββ vs JSON (β66.5%) 79,779 tokens
ββ vs JSON compact (β42.9%) 46,791 tokens
ββ vs YAML (β51.8%) 55,475 tokens
ββ vs XML (β70.4%) 90,306 tokens
ββββββββββββββββββββββββββββββββββββ Total ββββββββββββββββββββββββββββββββββββ
TOON ββββββββββββββββββββ 264,734 tokens
ββ vs JSON (β32.7%) 393,637 tokens
ββ vs JSON compact (+1.6%) 260,451 tokens
ββ vs YAML (β15.7%) 314,140 tokens
ββ vs XML (β40.9%) 447,936 tokens
Datasets with flat, fully tabular-eligible data where CSV is applicable.
π₯ Uniform employee records β Tabular: 100%
β
CSV ββββββββββββββββββββ 47,153 tokens
TOON ββββββββββββββββββββ 49,978 tokens (+6.0% vs CSV)
ββ vs JSON (β60.7%) 127,061 tokens
ββ vs JSON compact (β36.8%) 79,057 tokens
ββ vs YAML (β50.0%) 100,054 tokens
ββ vs XML (β65.9%) 146,605 tokens
π Time-series analytics data β Tabular: 100%
β
CSV ββββββββββββββββββββ 8,383 tokens
TOON ββββββββββββββββββββ 9,115 tokens (+8.7% vs CSV)
ββ vs JSON (β59.0%) 22,245 tokens
ββ vs JSON compact (β35.9%) 14,211 tokens
ββ vs YAML (β49.0%) 17,858 tokens
ββ vs XML (β65.8%) 26,616 tokens
β Top 100 GitHub repositories β Tabular: 100%
β
CSV ββββββββββββββββββββ 8,711 tokens
TOON ββββββββββββββββββββ 8,937 tokens (+2.6% vs CSV)
ββ vs JSON (β41.7%) 15,337 tokens
ββ vs JSON compact (β23.2%) 11,640 tokens
ββ vs YAML (β33.0%) 13,337 tokens
ββ vs XML (β48.3%) 17,294 tokens
ββββββββββββββββββββββββββββββββββββ Total ββββββββββββββββββββββββββββββββββββ
CSV ββββββββββββββββββββ 64,247 tokens
TOON ββββββββββββββββββββ 68,030 tokens (+5.9% vs CSV)
ββ vs JSON (β58.7%) 164,643 tokens
ββ vs JSON compact (β35.2%) 104,908 tokens
ββ vs YAML (β48.2%) 131,249 tokens
ββ vs XML (β64.3%) 190,515 tokens
Token counts use gpt-tokenizer with o200k_base encoding (GPT-5 tokenizer). Other providers tokenize differently, so absolute counts are tokenizer-specific; relative differences between formats hold directionally.
Savings: 13,130 tokens (59.0% reduction vs JSON)
JSON (22,245 tokens):
{
"metrics": [
{
"date": "2025-01-01",
"views": 6138,
"clicks": 174,
"conversions": 12,
"revenue": 2712.49,
"bounceRate": 0.35
},
{
"date": "2025-01-02",
"views": 4616,
"clicks": 274,
"conversions": 34,
"revenue": 9156.29,
"bounceRate": 0.56
},
{
"date": "2025-01-03",
"views": 4460,
"clicks": 143,
"conversions": 8,
"revenue": 1317.98,
"bounceRate": 0.59
},
{
"date": "2025-01-04",
"views": 4740,
"clicks": 125,
"conversions": 13,
"revenue": 2934.77,
"bounceRate": 0.37
},
{
"date": "2025-01-05",
"views": 6428,
"clicks": 369,
"conversions": 19,
"revenue": 1317.24,
"bounceRate": 0.3
}
]
}
TOON (9,115 tokens):
metrics[5]{date,views,clicks,conversions,revenue,bounceRate}:
2025-01-01,6138,174,12,2712.49,0.35
2025-01-02,4616,274,34,9156.29,0.56
2025-01-03,4460,143,8,1317.98,0.59
2025-01-04,4740,125,13,2934.77,0.37
2025-01-05,6428,369,19,1317.24,0.3
Savings: 6,400 tokens (41.7% reduction vs JSON)
JSON (15,337 tokens):
{
"repositories": [
{
"id": 132750724,
"name": "build-your-own-x",
"repo": "codecrafters-io/build-your-own-x",
"description": "Master programming by recreating your favorite technologies from scratch.",
"createdAt": "2018-05-09T12:03:18Z",
"updatedAt": "2026-07-23T18:57:15Z",
"pushedAt": "2026-07-14T19:25:58Z",
"stars": 530712,
"watchers": 6778,
"forks": 50205,
"defaultBranch": "master"
},
{
"id": 21737465,
"name": "awesome",
"repo": "sindresorhus/awesome",
"description": "π Awesome lists about all kinds of interesting topics",
"createdAt": "2014-07-11T13:42:37Z",
"updatedAt": "2026-07-23T18:57:24Z",
"pushedAt": "2026-06-30T18:21:16Z",
"stars": 488074,
"watchers": 8292,
"forks": 36010,
"defaultBranch": "main"
},
{
"id": 28457823,
"name": "freeCodeCamp",
"repo": "freeCodeCamp/freeCodeCamp",
"description": "freeCodeCamp.org's open-source codebase and curriculum. Learn math, programming,β¦",
"createdAt": "2014-12-24T17:49:19Z",
"updatedAt": "2026-07-22T07:01:33Z",
"pushedAt": "2026-07-21T18:00:51Z",
"stars": 452380,
"watchers": 8590,
"forks": 45624,
"defaultBranch": "main"
}
]
}
TOON (8,937 tokens):
repositories[3]{id,name,repo,description,createdAt,updatedAt,pushedAt,stars,watchers,forks,defaultBranch}:
132750724,build-your-own-x,codecrafters-io/build-your-own-x,Master programming by recreating your favorite technologies from scratch.,"2018-05-09T12:03:18Z","2026-07-23T18:57:15Z","2026-07-14T19:25:58Z",530712,6778,50205,master
21737465,awesome,sindresorhus/awesome,π Awesome lists about all kinds of interesting topics,"2014-07-11T13:42:37Z","2026-07-23T18:57:24Z","2026-06-30T18:21:16Z",488074,8292,36010,main
28457823,freeCodeCamp,freeCodeCamp/freeCodeCamp,"freeCodeCamp.org's open-source codebase and curriculum. Learn math, programming,β¦","2014-12-24T17:49:19Z","2026-07-22T07:01:33Z","2026-07-21T18:00:51Z",452380,8590,45624,main
# npm
npm install @toon-format/toon
# pnpm
pnpm add @toon-format/toon
# yarn
yarn add @toon-format/toon
To keep the CLI around instead of invoking it through npx, install it globally:
npm install -g @toon-format/cli
Example usage:
import { encode } from '@toon-format/toon'
const data = {
users: [
{ id: 1, name: 'Ada', role: 'admin' },
{ id: 2, name: 'Bob', role: 'user' }
]
}
console.log(encode(data))
// users[2]{id,name,role}:
// 1,Ada,admin
// 2,Bob,user
Streaming large datasets:
import { encodeLines } from '@toon-format/toon'
const largeData = await fetchThousandsOfRecords()
// Memory-efficient streaming for large data
for (const line of encodeLines(largeData)) {
process.stdout.write(`${line}\n`)
}
[!TIP] For streaming decode APIs, see
decodeFromLines()anddecodeStream().
Transforming values with replacer:
import { encode } from '@toon-format/toon'
// Remove sensitive fields
const user = { name: 'Ada', password: 'secret', email: '[email protected]' }
const safe = encode(user, {
replacer: (key, value) => key === 'password' ? undefined : value
})
// name: Ada
// email: [email protected]
// Transform values
const data = { status: 'active', count: 5 }
const transformed = encode(data, {
replacer: (key, value) =>
typeof value === 'string' ? value.toUpperCase() : value
})
// status: ACTIVE
// count: 5
[!TIP] The
replacerfunction provides fine-grained control over encoding, similar toJSON.stringify's replacer but with path tracking. See the API Reference for more examples, including verbatim output withrawString.
Command-line tool for quick JSONβTOON conversions, token analysis, and pipeline integration. Auto-detects format from file extension, supports stdin/stdout workflows, and offers delimiter options (comma, tab, pipe) that trade readability for fewer tokens.
# Encode JSON to TOON (auto-detected)
npx @toon-format/cli input.json -o output.toon
# Decode TOON to JSON (auto-detected)
npx @toon-format/cli data.toon -o output.json
# Pipe from stdin (no argument needed)
cat data.json | npx @toon-format/cli
echo '{"name": "Ada"}' | npx @toon-format/cli
# Output to stdout
npx @toon-format/cli input.json
# Show token savings
npx @toon-format/cli data.json --stats
[!TIP] See the full CLI documentation for all options, examples, and advanced usage.
TOON works best when you show the format instead of describing it. Once a model sees one tabular example, the header β [N] length plus {fields} field list β tells it how to read the rest. Wrap data in ```toon code blocks for input, and show the expected header template when asking models to generate TOON. Tab delimiters buy further token savings. Full-line # comments are stripped on decode, so hand-annotated prompt data β and model output with explainer lines β still decodes cleanly.
Follow the detailed LLM integration guide for strategies, examples, and validation techniques.
Playgrounds β the official playground converts JSON or YAML to TOON in real time, compares token counts, and shares experiments by URL. Community alternatives: Format Tokenization Playground, TOON Tools.
Editors β TOON Language Support for VS Code (code --install-extension vishalraut.vscode-toon) adds highlighting, validation, and token analysis. tree-sitter-toon covers Neovim, Helix, Emacs, and Zed; toon.nvim is a Lua-native alternative. Elsewhere, YAML highlighting is a close approximation.
Tooling β Tooner is an MCP proxy that converts JSON tool responses to TOON.
Comprehensive guides, references, and resources to help you get the most out of the TOON format and tools.
TOON files use the .toon extension and the provisional media type text/toon. Documents are always UTF-8; the charset=utf-8 parameter may be given but is assumed when absent. See SPEC.md Β§17 for normative details.
TOON has official and community implementations across multiple languages including Python, Rust, Go, Java, Swift, .NET, and many more.
See the full list of implementations in the documentation.
MIT License Β© 2025-PRESENT Johann Schopplich