Getting started

Bombadil runs on your development machine if you’re on macOS or Linux. You can use it to validate changes to TypeScript specifications, and to run short tests while working on your system. Then you’ll have something like GitHub Actions to run longer tests on your main branch or in nightlies.

Installation

The most straightforward way for you to get started is downloading the executable for your platform:

curl -L -o bombadil https://github.com/antithesishq/bombadil/releases/download/v0.3.1/bombadil-aarch64-darwin
chmod +x bombadil

mv ./bombadil ~/.local/bin/bombadil

bombadil --version

curl -L -o bombadil https://github.com/antithesishq/bombadil/releases/download/v0.3.1/bombadil-x86_64-linux
chmod +x bombadil

mv ./bombadil ~/.local/bin/bombadil

bombadil --version

nix run github:antithesishq/bombadil

Not yet available, but coming soon:

• executables bundled in NPM package (i.e. npx @antithesishq/bombadil)
• Docker images
• a GitHub Action, ready to be used in your CI configuration

If you want to compile from source, see Contributing.

TypeScript support

When writing specifications in TypeScript, you’ll want the types available. Get them from NPM with your package manager of choice:

npm install --save-dev @antithesishq/bombadil

yarn add --dev @antithesishq/bombadil

bun add --development @antithesishq/bombadil

Or use the files provided in the release package.

Your first test

With the CLI installed, let’s run a test just to see that things are working:

bombadil test https://en.wikipedia.org --output-path my-test

This will run until you shut it down using CTRL+C. Any property violations will be logged as errors, and with the --output-path option you get a JSONL file to inspect afterwards.

Find the URLs with violations (assuming you have jq installed):

jq -r 'select(.violations != []) | .url' my-test/trace.jsonl

Nothing? That’s fine, Wikipedia is pretty solid! This confirms that Bombadil runs and produces results.