Download

Specmatic Open Source

Open Source CLI standalone executable

Read the CLI Quick Start (in 5 min) guide to learn more about using the standalone executable:

Docker

To run the latest version:

docker run -it --rm specmatic/specmatic --help

For older versions, replace VERSION with the desired version number from the Docker Hub tags page:

docker run -it --rm specmatic/specmatic:VERSION --help

JAR

You can download the standalone JAR from:

• GitHub
• Maven Central

To run the JAR:

java -jar specmatic.jar --help

Linux / macOS

If you have Java 17 or above installed, you can install Specmatic with a shell script:

To install the latest version:

curl https://docs.specmatic.io/install-specmatic.sh | bash

To install a specific version, replace VERSION with a release number from GitHub:

curl https://docs.specmatic.io/install-specmatic.sh | bash -- --version VERSION

Windows

If you have Java 17 or above installed, you can install Specmatic using PowerShell:

To install the latest version:

irm https://docs.specmatic.io/install-specmatic.ps1 | iex

To install a specific version, replace VERSION with a release number from GitHub:

iex "& { $(irm 'https://docs.specmatic.io/install-specmatic.ps1') } --version VERSION"

NPM

To run the latest version:

npx specmatic

To run a specific version, replace VERSION with a version from npm:

npx specmatic@VERSION

Python (pip)

To install Specmatic via pip:

pip install specmatic

To install a specific version, replace VERSION with a version from PyPI:

pip install specmatic==VERSION

---

Specmatic Commercial Offerings

info

These tools are part of Specmatic's commercial suite.Please visit the pricing page for more information or visit the product pages for licensing details.

Specmatic Enterprise

Docker (Linux/macOS)

To run the latest version:

docker run -it --rm specmatic/enterprise --help

To mount the license file when using Docker, use the -v option to map the host directory containing the license file to /root/.specmatic in the container.

docker run -v "$(pwd):/app" -w /app -v ~/.specmatic:/root/.specmatic -it --rm specmatic/enterprise --help

For older versions, replace VERSION with the desired version number from the Docker Hub page:

docker run -it --rm specmatic/enterprise:VERSION --help

Docker (Win PowerShell)

To run the latest version:

docker run -it --rm specmatic/enterprise --help

To mount the license file when using Docker, use the -v option to map the host directory containing the license file to /root/.specmatic in the container.

If running in PowerShell, use the following command:

docker run -v "${PWD}:/app" -w /app -v "${env:USERPROFILE}/.specmatic:/root/.specmatic" -it --rm specmatic/enterprise --help

For older versions, replace VERSION with the desired version number from the Docker Hub page:

docker run -it --rm specmatic/enterprise:VERSION --help

Docker (Win CMD)

To run the latest version:

docker run -it --rm specmatic/enterprise --help

To mount the license file when using Docker, use the -v option to map the host directory containing the license file to /root/.specmatic in the container.

If running in Command Prompt, use the following command:

docker run -v "%cd%:/app" -w /app -v "%USERPROFILE%\.specmatic:/root/.specmatic" -it --rm specmatic/enterprise --help

For older versions, replace VERSION with the desired version number from the Docker Hub page:

docker run -it --rm specmatic/enterprise:VERSION --help

Maven

Add this dependency to your project:

<dependency>
  <groupId>io.specmatic.enterprise</groupId>
  <artifactId>specmatic-enterprise-all</artifactId>
  <version>0.99</version>
</dependency>

JAR

The standalone JAR file can be downloaded from the following sources:

• Specmatic Repository

For older versions, please refer to the Releases page.

Linux/macOS

If you have Java 17 or above installed, you can install the executable using the following command and follow the onscreen instructions:

To run the latest version:

curl https://docs.specmatic.io/install-specmatic-enterprise.sh | bash

To install an older version, replace VERSION with the desired version number from the Releases page.

curl https://docs.specmatic.io/install-specmatic-enterprise.sh | bash -- --version VERSION

Windows

If you have Java 17 or above installed, you can install the executable using the following PowerShell command and follow the onscreen instructions:

To install the latest version:

irm https://docs.specmatic.io/install-specmatic-enterprise.ps1 | iex

To install an older version, replace VERSION with the desired version number from the Releases page.

iex "& { $(irm 'https://docs.specmatic.io/install-specmatic-enterprise.ps1') } --version VERSION"

---

Specmatic Redis

Docker (Linux/macOS)

To run the latest version:

docker run -it --rm specmatic/specmatic-redis --help

To mount the license file when using Docker, use the -v option to map the host directory containing the license file to /root/.specmatic in the container.

docker run -v "$(pwd):/app" -w /app -v ~/.specmatic:/root/.specmatic -it --rm specmatic/specmatic-redis --help

For older versions, replace VERSION with the desired version number from the Docker Hub page:

docker run -it --rm specmatic/specmatic-redis:VERSION --help

Docker (Win PowerShell)

To run the latest version:

docker run -it --rm specmatic/specmatic-redis --help

To mount the license file when using Docker, use the -v option to map the host directory containing the license file to /root/.specmatic in the container.

If running in PowerShell, use the following command:

docker run -v "${PWD}:/app" -w /app -v "${env:USERPROFILE}/.specmatic:/root/.specmatic" -it --rm specmatic/specmatic-redis --help

For older versions, replace VERSION with the desired version number from the Docker Hub page:

docker run -it --rm specmatic/specmatic-redis:VERSION --help

Docker (Win CMD)

To run the latest version:

docker run -it --rm specmatic/specmatic-redis --help

To mount the license file when using Docker, use the -v option to map the host directory containing the license file to /root/.specmatic in the container.

If running in Command Prompt, use the following command:

docker run -v "%cd%:/app" -w /app -v "%USERPROFILE%\.specmatic:/root/.specmatic" -it --rm specmatic/specmatic-redis --help

For older versions, replace VERSION with the desired version number from the Docker Hub page:

docker run -it --rm specmatic/specmatic-redis:VERSION --help

Maven

Maven coordinates are not available for this tool.

JAR

The standalone JAR file can be downloaded from the following sources:

• Specmatic Repository

For older versions, please refer to the Releases page.

Linux/macOS

If you have Java 17 or above installed, you can install the executable using the following command and follow the onscreen instructions:

To run the latest version:

curl https://docs.specmatic.io/install-specmatic-redis.sh | bash

To install an older version, replace VERSION with the desired version number from the Releases page.

curl https://docs.specmatic.io/install-specmatic-redis.sh | bash -- --version VERSION

Windows

If you have Java 17 or above installed, you can install the executable using the following PowerShell command and follow the onscreen instructions:

To install the latest version:

irm https://docs.specmatic.io/install-specmatic-redis.ps1 | iex

To install an older version, replace VERSION with the desired version number from the Releases page.

iex "& { $(irm 'https://docs.specmatic.io/install-specmatic-redis.ps1') } --version VERSION"

---

Specmatic JDBC

Specmatic JDBC needs to be imported as a dependency in your project:

Maven

<repository>
  <id>specmatic-repo</id>
  <url>https://repo.specmatic.io/releases/</url>
</repository>

<dependency>
  <groupId>io.specmatic.jdbc</groupId>
  <artifactId>specmatic-jdbc</artifactId>
  <version>0.12.2</version>
</dependency>

Gradle

repositories {
  maven {
    url "https://repo.specmatic.io/releases/"
  }
}

implementation 'io.specmatic.jdbc:specmatic-jdbc:0.12.2'

Kotlin DSL

repositories {
  maven {
    url = uri("https://repo.specmatic.io/releases/")
  }
}

implementation("io.specmatic.jdbc:specmatic-jdbc:0.12.2")

---

Specmatic JMS

Specmatic JMS needs to be imported as a dependency in your project:

Maven

<repository>
  <id>specmatic-repo</id>
  <url>https://repo.specmatic.io/releases/</url>
</repository>

<dependency>
  <groupId>io.specmatic.jms</groupId>
  <artifactId>specmatic-jms</artifactId>
  <version>0.6.1</version>
</dependency>

Gradle

repositories {
  maven {
    url "https://repo.specmatic.io/releases/"
  }
}

implementation 'io.specmatic.jms:specmatic-jms:0.6.1'

Kotlin DSL

repositories {
  maven {
    url = uri("https://repo.specmatic.io/releases/")
  }
}

implementation("io.specmatic.jms:specmatic-jms:0.6.1")

---

Specmatic Google Pub/Sub

Specmatic Google Pub/Sub needs to be imported as a dependency in your project:

Maven

<repository>
  <id>specmatic-repo</id>
  <url>https://repo.specmatic.io/releases/</url>
</repository>

<dependency>
  <groupId>io.specmatic.googlepubsub</groupId>
  <artifactId>specmatic-google-pubsub</artifactId>
  <version>0.6.1</version>
</dependency>

Gradle

repositories {
  maven {
    url "https://repo.specmatic.io/releases/"
  }
}

implementation 'io.specmatic.googlepubsub:specmatic-google-pubsub:0.6.1'

Kotlin DSL

repositories {
  maven {
    url = uri("https://repo.specmatic.io/releases/")
  }
}

implementation("io.specmatic.googlepubsub:specmatic-google-pubsub:0.6.1")