Getting Started

Create an Account

Create an account on this site. Make sure to confirm your account by clicking the link in the email we send you.

Download the CLI

Download the Brisk binary for your platform:

Log In with the CLI

Run the following command to authenticate:

brisk login

This opens a browser to log in to your brisktest.com account. Credentials are stored at ~/.config/brisk/config.toml

Create Your First Project

In the root directory of your project, run one of:

brisk project init rails

brisk project init jest

This creates a project on brisktest.com and initializes a brisk.json file with your project configuration. The free plan includes 5X concurrency.

Run Brisk & Set Up CI

Run your tests locally with:

brisk

To set up GitHub Actions, create .github/workflows/brisk_ci.yml with:

name: Brisk CI
on: [push]
jobs:
  Brisk-CI:
    runs-on: ubuntu-latest
    steps:
      - name: Check out repository code
        uses: actions/checkout@v3
      - name: Install Brisk
        uses: brisktest/setup-brisk@v1.1
        with:
          brisk_version: 'latest'
          api_token: '${{ secrets.BRISK_APITOKEN }}'
          api_key: '${{ secrets.BRISK_APIKEY }}'
          config_file: 'brisk-ci.json'
      - name: Run Brisk
        run: brisk

If running GitHub Actions alongside local pre-commit tests, use a separate project file (e.g. brisk-ci.json ) for CI-specific configuration.