Installation #

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

npm

Install as a development dependency in your project:

npm install --save-dev @antithesishq/bombadil

Add a script to your package.json to run Bombadil:

{
  "scripts": {
    "test": "bombadil browser test --time-limit=1m https://your-app.example.com"
  }
}

Then run it with npm test. This also provides TypeScript type definitions for writing specifications.

macOS

Download the bombadil binary using curl (or wget) and make it executable:

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

Put the binary somewhere on your PATH, like in ~/.local/bin if that is configured.

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

You should now be able to run it:

bombadil --version

Do not download the executable with your web browser. It will be blocked by GateKeeper.

Linux

Download the bombadil binary and make it executable:

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

Put the binary somewhere on your PATH, like in ~/.local/bin if that is configured.

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

You should now be able to run it:

bombadil --version
Nix (flake) 
nix run github:antithesishq/bombadil/v0.7.2 -- --version
GitHub Actions 
- uses: antithesishq/bombadil-action@v2
  with:
    driver: browser
    origin: https://your-app.example.com
    specification: ./bombadil/specification.ts
    time-limit: 5m
    exit-on-violation: true
    output-path: bombadil-output

See its README for detailed instructions.

Docker

Releases are published as tags on Docker Hub:

docker run antithesishq/bombadil:0.7.2 --version

If you want to compile from source, see Contributing.