Install the APIMatic CLI

What the APIMatic CLI does and how to install, verify, and update it.

The APIMatic CLI (apimatic) is the command-line interface to APIMatic, for use in your terminal or in automation scripts and CI/CD pipelines.

What you can do with the APIMatic CLI

Validate and lint your API definition.
Transform your API definition between formats such as OpenAPI, RAML, Postman, and WSDL.
Generate APIMatic SDKs in C#, Python, and TypeScript.
Publish APIMatic SDKs to NuGet, PyPI, npm, and GitHub using publishing profiles.
Generate and preview a developer portal from your API definition and guides.
Generate and publish APIMatic Context Plugins for AI coding agents.

Prerequisites

Node.js v24 or later
npm
Git 2.38 or later, for sdk generate and sdk publish to keep your changes to a generated SDK when you regenerate it. Without it, the commands still generate the SDK and warn that your changes won't be kept.

Install the CLI

The APIMatic CLI is available on npm. Install it globally:

npm i -g @apimatic/cli@2

Verify the installation

apimatic --version

You should see the installed version of the CLI.

Update the CLI

Run the install command again to update to the latest v2 release:

npm i -g @apimatic/cli@2

Next steps

Get started with the APIMatic CLI

Sign in and learn how commands and help are organized.

CLI Reference

Every command in the APIMatic CLI, grouped by what it works on.

Get Started with the APIMatic CLI

Sign in to the APIMatic CLI and find your way around its commands and help.

On this page

What you can do with the APIMatic CLI Prerequisites Install the CLI Verify the installation Update the CLI Next steps