A plain-text language for reasoning you can check — reference parser and CLI toolchain.
Project description
A plain-text language for reasoning you can check.
📖 Book · ▶ Playground · 📁 Examples
Prose is good at stating a conclusion and terrible at showing its shape. You can write three confident paragraphs that quietly contradict themselves, and no tool will say a word.
ThoughtML is a small language that fixes that. You write down what you believe and why — claims, evidence, who holds what, how confident, as of when — and it reads back a typed, dated, defeasible graph. Then it reads that graph a second time, mechanically, and tells you where your own structure disagrees with what you said.
It's a mirror, not an oracle. It shows you the conflict. It does not make the call.
Watch it catch a mistake
A hiring decision, written as ThoughtML:
focus strong-hire
kind claim
Alex is a strong hire.
focus aced-interview
kind observation
Aced the system-design round.
focus take-home-failed
kind observation
The take-home didn't run — tests were failing.
link aced-interview supports strong-hire
link take-home-failed opposes strong-hire
panel holds strong-hire
confidence 0.9 assumed
This document is clean — zero errors, zero warnings. The syntax is perfect. And
yet it's wrong, in a way no spell-checker or linter would ever catch. Run the mirror
over it (thoughtml --audit):
"audit": {
"conflicts": [
{
"kind": "confidence-vs-status",
"severity": "error",
"message": "`panel` asserts confidence 0.90 in `strong-hire`, but your own structure defeats it (argument status: out)"
}
]
}
The panel is 90% sure of a claim its own recorded evidence defeats — it wrote
down that the take-home failed, then made the offer anyway. Nothing about the text is
malformed; the reasoning is. ThoughtML surfaces that gap and hands it back to you.
(And that 0.9 labels itself assumed, not measured — provenance you can see.)
That's the whole idea in one screen.
▶ Try it live in your browser →
the real parser, compiled to WebAssembly — type on the left, watch the reasoning graph build on the right. No install.
Why now
For as long as reasoning has been expensive to produce, it made sense to trust it by default. That's changing. An AI agent can now emit pages of structured argument at no cost — which means the scarce, valuable thing is no longer producing reasoning but auditing it.
ThoughtML is built for that world. The agent (or you) writes the reasoning down in a form that's explicit enough to check; a human, another agent, or CI reads it back and catches where the confidence betrays the structure. The point was never to compute the answer. It's to make reasoning legible enough that its flaws can't hide.
Writing ThoughtML with an AI? The whole language travels inside the tool. Run
thoughtml guide --fullfor the complete, source-derived spec (or readllms.txt) and paste it into a system prompt.thoughtml guidealone prints a one-screen tour;thoughtml guide <topic>looks up one section.
The concepts
- Typed reasoning. A focus is an
observation,claim,hypothesis,option,decision,goal,assumption, … — not just a box. Foci nest into thought-trees: a claim and the reasoning that hangs off it, as one unit. - Defeasible evidence.
supports/opposes/undercutsform an argument graph; an opt-in grounded status reads every node asin/out/undecided. Purely structural relations (part-of,candidate-for) let you enumerate without silently inflating confidence. - Time is the spine. Beliefs are dated and ordered by valid-time. They can be
revised, and a dead end can be
abandoned— kept with its reason, not deleted. Redefining a focus never clobbers the first version; both are retained. Replay the whole thing as of any instant (--as-of, or the viewer's play button). Nothing is forgotten. - Honest numbers. One strength encoding — a numeric
weight— and every authored number can declare its basis:measured/estimated/assumed. - The mirror. An opt-in conflict report flags where your structure disagrees with
what you said: high confidence in a claim your own evidence defeats
(
confidence-vs-status), or the same focus defined two incompatible ways (definition-divergence). It reports; it does not decide.
What's in the repo
ThoughtML is a language; this repo is its reference implementation. One parser is the single source of truth — everything else is that same parser wearing a different hat, so the browser, the CLI, and the exported file can never disagree.
| Piece | What it is | |
|---|---|---|
| Reference parser | Rust: source → surface AST → canonical objects → JSON, with diagnostics. The source of truth for the language. | crates/thoughtml |
| CLI toolchain | The parser as git-style subcommands — check, fmt, explain, diff — plus the mirror (--audit), the compute layer (--compute), as-of replay (--as-of), and standalone HTML export (--html). |
same crate |
| wasm build | The same parser compiled for the web, so the playground and the CLI can't drift. | crates/thoughtml-wasm |
| Playground | Live editor + reasoning graph (mermaid.live in spirit): a time-driven Viewer with replay and Follow-mode storytelling, a node-link Structural view, and one-click standalone-HTML export. | web · live ↗ |
| The book | Tutorial, complete language reference, the mirror, and practical guides. | docs · live ↗ |
llms.txt |
The whole language in one file — embedded in the binary, so thoughtml guide --full prints it too. |
llms.txt |
| Example gallery | 20 worked, strict-clean documents — an incident triage, a clinical differential, an AI moderation call, a security threat model, a self-auditing hotfix, and more. | examples |
Install & run
You don't need any Rust to use the language — only to run the reference implementation.
Install the CLI. The quickest way, on any platform with Node:
npm install -g thoughtml
Or, if you have a Rust toolchain:
cargo install --git https://github.com/Fatin-Ishraq/ThoughtML thoughtml
Prebuilt binaries for macOS, Linux, and Windows are attached to every
release. (A pip install is on the way.)
Run the toolchain — the bare thoughtml <file> still emits the canonical JSON model:
thoughtml guide # the language itself, one screen (--full for all of it)
thoughtml examples/ship-the-hotfix.thml # canonical JSON + diagnostics
thoughtml --audit examples/ship-the-hotfix.thml # the mirror: where structure disagrees
thoughtml check --json doc.thml # diagnostics with stable codes + suggested fixes
thoughtml fmt -w doc.thml # format in the one canonical style
thoughtml explain doc.thml some-claim # why a node has its confidence / status
thoughtml diff before.thml after.thml # a semantic, belief-level diff
thoughtml --html -o record.html examples/choose-datastore.thml # bake to one interactive HTML file
Full reference: The CLI ↗.
Prefer not to install? Run any of it via cargo run -p thoughtml -- …, or just open the
playground.
Hack on the playground locally:
cd web && npm install
npm run wasm # build the parser to wasm (uses the rustup toolchain)
npm run dev
What you'd use it for
- Decision records (ADRs) you can lint — the options, the evidence, and the open question that blocks sign-off, all checkable.
- AI-agent reasoning a human or CI can audit — the agent emits its reasoning; the mirror catches where its confidence betrays its own structure. (guide ↗)
- Design & code review of an argument — surface "you hold this at 0.9, but your own listed risk defeats it."
- Incident postmortems as checkable causal graphs, and research / claim maps with provenance on every number.
More in Use cases ↗.
Status
v0.3.0 — the self-describing release. thoughtml guide now embeds the whole language
inside the binary — a one-screen tour, a section lookup, or --full for the complete,
source-derived spec to hand an AI — so an agent that runs cargo install can learn ThoughtML
with no website and no network. It builds on the 0.2.0 toolchain (check / fmt / explain
/ diff, the valid-time memory overhaul, and the standalone --html viewer). The full trail
is in CHANGELOG.md; the language as it stands today is in the
book. The surface may still move — hence 0.x, not 1.0.
Contributing
Issues and ideas are welcome — open one here. The reference parser is the source of truth for the language and the docs are derived from it, so if the two ever disagree, that's a bug worth reporting.
License
MIT © 2026 Fatin Ishraq.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distributions
Built Distributions
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file thoughtml-0.3.0-py3-none-win_amd64.whl.
File metadata
- Download URL: thoughtml-0.3.0-py3-none-win_amd64.whl
- Upload date:
- Size: 767.7 kB
- Tags: Python 3, Windows x86-64
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
1adcc37ff2b551e53c3666a3d6fb12fbcd7233e39dc63fe7f2c3d6db78eb4574
|
|
| MD5 |
c731d150b918a823f4d27ab8a99ad930
|
|
| BLAKE2b-256 |
478bc38ecfdc272b5e8eed07309bd430c3acb6d2d5925835c99c998c758e9c29
|
Provenance
The following attestation bundles were made for thoughtml-0.3.0-py3-none-win_amd64.whl:
Publisher:
pypi.yml on Fatin-Ishraq/ThoughtML
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
thoughtml-0.3.0-py3-none-win_amd64.whl -
Subject digest:
1adcc37ff2b551e53c3666a3d6fb12fbcd7233e39dc63fe7f2c3d6db78eb4574 - Sigstore transparency entry: 2161897665
- Sigstore integration time:
-
Permalink:
Fatin-Ishraq/ThoughtML@d927b7890ed8ee0a8e3fbd5a299f1d9510146709 -
Branch / Tag:
refs/heads/main - Owner: https://github.com/Fatin-Ishraq
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
pypi.yml@d927b7890ed8ee0a8e3fbd5a299f1d9510146709 -
Trigger Event:
workflow_dispatch
-
Statement type:
File details
Details for the file thoughtml-0.3.0-py3-none-manylinux_2_35_x86_64.whl.
File metadata
- Download URL: thoughtml-0.3.0-py3-none-manylinux_2_35_x86_64.whl
- Upload date:
- Size: 902.5 kB
- Tags: Python 3, manylinux: glibc 2.35+ x86-64
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
d422d1f941959d7872efe7f81c11d94e317e3ae8045f91098a008abc5ed98cf7
|
|
| MD5 |
5b76e42f5831ff8fb9253a92ecf4cc79
|
|
| BLAKE2b-256 |
454db6605a5658333e6c7c293d41736b1ec65febeb0275b730e8954d7c8bdaca
|
Provenance
The following attestation bundles were made for thoughtml-0.3.0-py3-none-manylinux_2_35_x86_64.whl:
Publisher:
pypi.yml on Fatin-Ishraq/ThoughtML
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
thoughtml-0.3.0-py3-none-manylinux_2_35_x86_64.whl -
Subject digest:
d422d1f941959d7872efe7f81c11d94e317e3ae8045f91098a008abc5ed98cf7 - Sigstore transparency entry: 2161897719
- Sigstore integration time:
-
Permalink:
Fatin-Ishraq/ThoughtML@d927b7890ed8ee0a8e3fbd5a299f1d9510146709 -
Branch / Tag:
refs/heads/main - Owner: https://github.com/Fatin-Ishraq
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
pypi.yml@d927b7890ed8ee0a8e3fbd5a299f1d9510146709 -
Trigger Event:
workflow_dispatch
-
Statement type:
File details
Details for the file thoughtml-0.3.0-py3-none-manylinux_2_35_aarch64.whl.
File metadata
- Download URL: thoughtml-0.3.0-py3-none-manylinux_2_35_aarch64.whl
- Upload date:
- Size: 898.2 kB
- Tags: Python 3, manylinux: glibc 2.35+ ARM64
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
029fe888204fbb08a23c598b60e52fd1c2a405c7ea37837435bea96ea01cf59f
|
|
| MD5 |
291e3e80bb7dec1855a028e403fb0025
|
|
| BLAKE2b-256 |
2e1180c784868d58cd19ef6d6d28373ff421ede700df15c2c16a39ee0d1b095c
|
Provenance
The following attestation bundles were made for thoughtml-0.3.0-py3-none-manylinux_2_35_aarch64.whl:
Publisher:
pypi.yml on Fatin-Ishraq/ThoughtML
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
thoughtml-0.3.0-py3-none-manylinux_2_35_aarch64.whl -
Subject digest:
029fe888204fbb08a23c598b60e52fd1c2a405c7ea37837435bea96ea01cf59f - Sigstore transparency entry: 2161897764
- Sigstore integration time:
-
Permalink:
Fatin-Ishraq/ThoughtML@d927b7890ed8ee0a8e3fbd5a299f1d9510146709 -
Branch / Tag:
refs/heads/main - Owner: https://github.com/Fatin-Ishraq
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
pypi.yml@d927b7890ed8ee0a8e3fbd5a299f1d9510146709 -
Trigger Event:
workflow_dispatch
-
Statement type:
File details
Details for the file thoughtml-0.3.0-py3-none-macosx_11_0_arm64.whl.
File metadata
- Download URL: thoughtml-0.3.0-py3-none-macosx_11_0_arm64.whl
- Upload date:
- Size: 886.5 kB
- Tags: Python 3, macOS 11.0+ ARM64
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
662887e087594cbab40d97d5b88d675c187e2954c3de8b83977853f8f4923fc0
|
|
| MD5 |
ba2e1f843aec33bc3a9ef411e505a7bf
|
|
| BLAKE2b-256 |
8032f52b50b933f665743c282f9389a59df86039fa8a4e737837ee51d8a799be
|
Provenance
The following attestation bundles were made for thoughtml-0.3.0-py3-none-macosx_11_0_arm64.whl:
Publisher:
pypi.yml on Fatin-Ishraq/ThoughtML
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
thoughtml-0.3.0-py3-none-macosx_11_0_arm64.whl -
Subject digest:
662887e087594cbab40d97d5b88d675c187e2954c3de8b83977853f8f4923fc0 - Sigstore transparency entry: 2161897810
- Sigstore integration time:
-
Permalink:
Fatin-Ishraq/ThoughtML@d927b7890ed8ee0a8e3fbd5a299f1d9510146709 -
Branch / Tag:
refs/heads/main - Owner: https://github.com/Fatin-Ishraq
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
pypi.yml@d927b7890ed8ee0a8e3fbd5a299f1d9510146709 -
Trigger Event:
workflow_dispatch
-
Statement type:
File details
Details for the file thoughtml-0.3.0-py3-none-macosx_10_12_x86_64.whl.
File metadata
- Download URL: thoughtml-0.3.0-py3-none-macosx_10_12_x86_64.whl
- Upload date:
- Size: 898.4 kB
- Tags: Python 3, macOS 10.12+ x86-64
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
540a2ed54cda946d0f2f4404653eaab5f82ab81537424e5f50654efbf13cf87b
|
|
| MD5 |
0a04769e25e77137cd297599ac56c6be
|
|
| BLAKE2b-256 |
edd7b16d14b93c26a6f055642d083fc59bddb5553a911cb78287acbd171b2526
|
Provenance
The following attestation bundles were made for thoughtml-0.3.0-py3-none-macosx_10_12_x86_64.whl:
Publisher:
pypi.yml on Fatin-Ishraq/ThoughtML
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
thoughtml-0.3.0-py3-none-macosx_10_12_x86_64.whl -
Subject digest:
540a2ed54cda946d0f2f4404653eaab5f82ab81537424e5f50654efbf13cf87b - Sigstore transparency entry: 2161897617
- Sigstore integration time:
-
Permalink:
Fatin-Ishraq/ThoughtML@d927b7890ed8ee0a8e3fbd5a299f1d9510146709 -
Branch / Tag:
refs/heads/main - Owner: https://github.com/Fatin-Ishraq
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
pypi.yml@d927b7890ed8ee0a8e3fbd5a299f1d9510146709 -
Trigger Event:
workflow_dispatch
-
Statement type: