Installation

MakrellTS is documented here as a published package with a normal installed CLI workflow. The source-tree workflow still exists for contributors, but it should not be the main user story.

Install the CLI

bun add -g makrellts

This gives you the makrellts command.

Run a first source file

Save a file as hello.mrts:

a = 2
b = a + 3
[a b 5] | sum

Then run it:

makrellts hello.mrts

Emit generated JavaScript:

makrellts hello.mrts --emit-js

Check a file and emit machine-readable diagnostics:

makrellts check hello.mrts --json

Use source checkout for development

If you are working on MakrellTS itself, use the source-tree workflow from impl/ts/:

bun install

Common commands

bun run build
bun run build:browser
bun run test
bun run typecheck
bun run lint
bun run test:browser

These cover the main development loop for MakrellTS:

  • build for the library output

  • build:browser for browser-facing bundles

  • test and test:browser for runtime coverage in different environments

  • typecheck and lint for TypeScript code quality

Environment focus

MakrellTS is aimed at:

  • Node.js

  • Bun

  • browser-oriented workflows

  • JavaScript and TypeScript interop

Typical workflow

A common user workflow is:

  1. install makrellts

  2. run a small .mrts file

  3. use check and --emit-js as needed

A common contributor workflow is:

  1. bun install

  2. run the build and test commands

  3. use the examples and browser build from the source tree