Skip to main content

Installing APIMatic CLI

APIMatic CLI, or apimatic is a command-line interface to APIMatic for use in your favorite terminal or automation scripts.

Features Supported by APIMatic CLI​

Currently, APIMatic CLI supports the following features:

  1. Validation of API Specifications.
  2. Transformation between API specification formats including OpenAPI/Swagger, RAML, WSDL and Postman Collections. To view a full list for these formats, refer to API Transformer.
  3. SDK/Client library generation for APIs.
  4. API Documentation generation.

How to Install APIMatic CLI?​

APIMatic CLI is built with Node.js and is installable via npm.

note

If you do not have Node.js and npm, please install through Node.js Downloads.

Install CLI​

Run the following command to install the CLI.

npm install -g @apimatic/cli

Verify Installation​

To verify the CLI installation, use apimatic --version command. You should be able to see the installed version of the CLI after successful installation.

$ apimatic --version

To learn more about APIMatic commands, refer to Getting Started Guide.