Install the runner
Pick the host language your team uses today. The runner reads the same .tml file no matter where it lives.
$ pip install testml # or: npm i -D testml # or: gem install testml
TESTML / V0.4 · QUICKSTART
This is the short path from zero to a green run. Install the runner, write one .tml file, and watch it pass in Python, Ruby and JavaScript. No new language. No paid tier.
01 · BEFORE YOU START
TestML is small and self-contained. You do not need an agent, a server, or a paid plan. Make sure these four things are in place and you are ready to go.
About 12 MB for the runner and bindings.
Any editor with YAML syntax help works well.
Plain shell exit codes, no special agent needed.
MIT. Use it in private or public work.
02 · FOUR STEPS
Each step takes about a minute. Copy the snippet, adapt the names, and move on. The whole loop is under five minutes for most teams.
Pick the host language your team uses today. The runner reads the same .tml file no matter where it lives.
$ pip install testml # or: npm i -D testml # or: gem install testml
Drop a tests/login.tml file beside your code. The format is YAML-shaped and reads like plain English.
%TestML 0.4.0 Add two numbers => sum: - [1, 2, 3] - [4, 5, 9] - [-1, 1, 0]
Map each row to a function in your project. Bindings live in a small bridge file you keep next to the suite.
// bridge.js
runner.bind('sum', (a, b) => a + b);The same .tml file runs across stacks. Use one CI job per language and share fixtures across the team.
$ testml tests/ PASS tests/login.tml 3 of 3 PASS tests/sum.tml 3 of 3
03 · SUPPORTED RUNTIMES
The same .tml suite runs in every host below. Add a binding file per language. Share fixtures across the team. Drop a stack from CI without losing test coverage.
04 · WHERE TO GO NEXT
Some teams want the full spec. Others want example suites to copy. All four routes below are short reads. None of them ask for an email or a signup.
The full grammar lives in one short document. Skim it once and keep it bookmarked.
Browse examplesReal .tml suites from the project. Copy a pattern that fits your stack and adapt it.
Open the docsDeeper guides on bindings, fixtures and CI wiring. Updated with every minor release.
Join the communityAsk questions, share suites and follow the roadmap. Maintainers reply in the same week.
05 · COMMON QUESTIONS
No. TestML files are YAML-shaped. If you can read a config file, you can read a test.
The runner is light. A 200-case suite finishes in under a second on a typical laptop.
Yes. Keep your unit tests where they are. Use TestML for cases that span more than one stack.
Fixtures sit in plain files near each suite. Secrets stay in your CI vault, not in .tml files.
READY?
Open the docs, copy a snippet, run the file. If something feels off, the community channel is small and friendly. Maintainers reply in the same week.