Skip to content

Quick start

The batect and batect.cmd scripts are designed to be committed alongside your project, and not installed globally. Committing them alongside your code improves consistency within your team, as everyone uses the same version of batect. They will automatically pull down the correct version of batect for your operating system.

  1. Download the latest version of batect and batect.cmd from the releases page, and copy them into your project.

    Note that you only need the scripts - you don't need to download batect.jar.

  2. If you're on Linux or macOS, make sure the script is executable: run chmod +x batect.

  3. Create your batect.yml to define your tasks and the environments they run in:

Requirements

batect requires Docker 18.03.1 or newer, Java 8 or newer (although this requirement will be removed before v1.0), and:

  • On Linux and macOS: Bash and curl
  • On Windows: Windows 10

batect supports both Linux and Windows containers.

A 64-bit version of Java is required on Windows.