Specmatic Open Source

Open Source CLI standalone executable

Read our “Getting started (in 5 min)” section learn more about using the standalone executable.

  • 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 page

    docker run -it --rm specmatic/specmatic:VERSION --help 
  • The standalone JAR file can be downloaded from the following sources:

    For older versions, please refer to the Releases page.

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

    To install the latest version:

    # install the latest version curl https://docs.specmatic.io/install-specmatic.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.sh | bash -- --version VERSION 
  • If you have Java 17 or above installed, you can install the executable using the following command and follow the onscreen instructions:

    To install the latest version:

    irm https://docs.specmatic.io/install-specmatic.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.ps1') } --version VERSION" 
  • To run the latest version:

    npx specmatic 

    For older versions, replace VERSION with the desired version number from the NPM Registry page

    npx specmatic@VERSION 
  • To install Specmatic via pip, run the following command:

    pip install specmatic 

    To install a specific version, replace VERSION with the desired version number from the PyPI page:

    pip install specmatic==VERSION 

Specmatic Commercial offerings

Specmatic OpenAPI

  • To run the latest version:

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

    Please make sure to mount the license file as described in the License Setup Guide

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

    docker run -it --rm specmatic/specmatic-openapi:VERSION --help 
  • The standalone JAR file can be downloaded from the following sources:

    For older versions, please refer to the Releases page.

  • 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-openapi.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-openapi.sh | bash -- --version VERSION 
  • If you have Java 17 or above installed, you can install the executable using the following command and follow the onscreen instructions:

    To install the latest version:

    irm https://docs.specmatic.io/install-specmatic-openapi.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-openapi.ps1') } --version VERSION" 

Specmatic Studio

  • To run the latest version:

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

    Please make sure to mount the license file as described in the License Setup Guide

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

    docker run -it --rm specmatic/specmatic-studio:VERSION --help 
  • The standalone JAR file can be downloaded from the following sources:

    For older versions, please refer to the Releases page.

  • 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-studio.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-studio.sh | bash -- --version VERSION 
  • If you have Java 17 or above installed, you can install the executable using the following command and follow the onscreen instructions:

    To install the latest version:

    irm https://docs.specmatic.io/install-specmatic-studio.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-studio.ps1') } --version VERSION" 

Specmatic Kafka

  • To run the latest version:

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

    Please make sure to mount the license file as described in the License Setup Guide

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

    docker run -it --rm specmatic/specmatic-kafka:VERSION --help 
  • The standalone JAR file can be downloaded from the following sources:

    For older versions, please refer to the Releases page.

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

    To install the latest version:

    curl https://docs.specmatic.io/install-specmatic-kafka.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-kafka.sh | bash -- --version VERSION 
  • If you have Java 17 or above installed, you can install the executable using the following command and follow the onscreen instructions:

    To install the latest version:

    irm https://docs.specmatic.io/install-specmatic-kafka.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-kafka.ps1') } --version VERSION" 

Specmatic gRPC

  • To run the latest version:

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

    Please make sure to mount the license file as described in the License Setup Guide

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

    docker run -it --rm specmatic/specmatic-grpc:VERSION --help 
  • The standalone JAR file can be downloaded from the following sources:

    For older versions, please refer to the Releases page.

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

    To install the latest version:

    curl https://docs.specmatic.io/install-specmatic-grpc.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-grpc.sh | bash -- --version VERSION 
  • If you have Java 17 or above installed, you can install the executable using the following command and follow the onscreen instructions:

    To install the latest version:

    irm https://docs.specmatic.io/install-specmatic-grpc.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-grpc.ps1') } --version VERSION" 

Specmatic GraphQL

  • To run the latest version:

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

    Please make sure to mount the license file as described in the License Setup Guide

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

    docker run -it --rm specmatic/specmatic-graphql:VERSION --help 
  • The standalone JAR file can be downloaded from the following sources:

    For older versions, please refer to the Releases page.

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

    To install the latest version:

    curl https://docs.specmatic.io/install-specmatic-graphql.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-graphql.sh | bash -- --version VERSION 
  • If you have Java 17 or above installed, you can install the executable using the following command and follow the onscreen instructions:

    To install the latest version:

    irm https://docs.specmatic.io/install-specmatic-graphql.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-graphql.ps1') } --version VERSION" 

Specmatic Arazzo

  • To run the latest version:

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

    Please make sure to mount the license file as described in the License Setup Guide

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

    docker run -it --rm specmatic/specmatic-arazzo:VERSION --help 
  • The standalone JAR file can be downloaded from the following sources:

    For older versions, please refer to the Releases page.

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

    To install the latest version:

    curl https://docs.specmatic.io/install-specmatic-arazzo.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-arazzo.sh | bash -- --version VERSION 
  • If you have Java 17 or above installed, you can install the executable using the following command and follow the onscreen instructions:

    To install the latest version:

    irm https://docs.specmatic.io/install-specmatic-arazzo.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-arazzo.ps1') } --version VERSION" 

Specmatic Redis

  • To run the latest version:

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

    Please make sure to mount the license file as described in the License Setup Guide

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

    docker run -it --rm specmatic/specmatic-redis:VERSION --help 
  • The standalone JAR file can be downloaded from the following sources:

    For older versions, please refer to the Releases page.

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

    To install 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 
  • If you have Java 17 or above installed, you can install the executable using the following 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:

  • Be sure to add the following repository to the repositories section of your pom.xml if you haven’t already:

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

    Then add the following dependency to the dependencies section of your pom.xml:

     <dependency> <groupId>io.specmatic.jdbc</groupId> <artifactId>specmatic-jdbc</artifactId> <version>0.12.2</version> </dependency> 
  • Be sure to register the Specmatic repository in your repositories section if you haven’t already:

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

    Add the following dependency in the dependencies section:

    implementation 'io.specmatic.jdbc:specmatic-jdbc:0.12.2' 
  • Be sure to register the Specmatic repository in your repositories section if you haven’t already:

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

    Add the following dependency in the dependencies section:

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

Specmatic JMS

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

  • Be sure to add the following repository to the repositories section of your pom.xml if you haven’t already:

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

    Then add the following dependency to the dependencies section of your pom.xml:

     <dependency> <groupId>io.specmatic.jms</groupId> <artifactId>specmatic-jms</artifactId> <version>0.6.1</version> </dependency> 
  • Be sure to register the Specmatic repository in your repositories section if you haven’t already:

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

    Add the following dependency in the dependencies section:

    implementation 'io.specmatic.jms:specmatic-jms:0.6.1' 
  • Be sure to register the Specmatic repository in your repositories section if you haven’t already:

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

    Add the following dependency in the dependencies section:

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

Specmatic Google pubsub

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

  • Be sure to add the following repository to the repositories section of your pom.xml if you haven’t already:

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

    Then add the following dependency to the dependencies section of your pom.xml:

     <dependency> <groupId>io.specmatic.googlepubsub</groupId> <artifactId>specmatic-google-pubsub</artifactId> <version>1.6.1</version> </dependency> 
  • Be sure to register the Specmatic repository in your repositories section if you haven’t already:

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

    Add the following dependency in the dependencies section:

    implementation 'io.specmatic.googlepubsub:specmatic-google-pubsub:1.6.1' 
  • Be sure to register the Specmatic repository in your repositories section if you haven’t already:

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

    Add the following dependency in the dependencies section:

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