CLI Reference

Install or update the APIMatic CLI with npm:

npm install -g @apimatic/cli@latest

Command format: Commands use spaces between topics, for example apimatic portal serve. Older CLI releases used colons (apimatic portal:serve); if a command from an older guide doesn't work, swap the colons for spaces.

QuickstartCopy Anchor Link

apimatic quickstart

Interactive guide that sets up your first API portal or SDK. No prior setup needed.

PortalCopy Anchor Link

portal generateCopy Anchor Link

Generates a static API documentation portal from your src directory.

apimatic portal generate

Flags: --input · --destination · -f, --force · --zip · --auth-key

portal serveCopy Anchor Link

Builds the portal and serves it locally with hot reload.

apimatic portal serve --open

Flags: --input · --destination · -p, --port · -o, --open · -i, --ignore · --auth-key · --no-reload

APICopy Anchor Link

api validateCopy Anchor Link

Checks the syntax and semantics of an API definition.

apimatic api validate --file=<path>
apimatic api validate --url=<url>

Flags: --file · --url · --auth-key

api transformCopy Anchor Link

Converts an API definition between formats such as OpenAPI, RAML, WSDL, and Postman.

apimatic api transform --format=<format> --file=<path>

Flags: --format (required) · --file · --url · --destination · -f, --force · --auth-key

SDKCopy Anchor Link

sdk generateCopy Anchor Link

Generates an SDK in the language you choose.

apimatic sdk generate --language=<language>

Supported values for --language: csharp, python, typescript.

Flags: -l, --language (required) · -i, --input · -d, --destination · --api-version · --skip-changes · --track-changes · --codegen-version · --stability · -f, --force · -k, --auth-key · --zip

sdk save-changesCopy Anchor Link

Saves your customizations to a generated SDK so they carry over to future generations.

apimatic sdk save-changes --language=<language> --sdk=<path>

Flags: -i, --input · -l, --language (required) · --sdk · --api-version

sdk publishCopy Anchor Link

Publishes an SDK to package registries (NuGet, PyPI, npm) and GitHub using a publishing profile. Run it with no flags for guided mode, or pass flags for CI/CD.

apimatic sdk publish
apimatic sdk publish --profile-id=<id> --language=<lang> --version=<version> --publish-type=<type>

Flags: -p, --profile-id · -l, --language · -v, --version · --publish-type · --input · --destination · --dry-run · -f, --force · --update-plugin-config

PluginCopy Anchor Link

plugin generateCopy Anchor Link

Creates a Context Plugin from your published SDKs for AI coding agents.

apimatic plugin generate

Flags: -i, --input · -d, --destination · -f, --force · -k, --auth-key

Warning: Context Plugins reference your SDK repositories, so publish your SDKs with source code first (--publish-type=sourcecode).

plugin publishCopy Anchor Link

Prints the git commands to publish your plugin to GitHub. It doesn't run them, so you can review what becomes public first.

apimatic plugin publish

Flags: -i, --input · -d, --destination

PublishingCopy Anchor Link

publishing profile listCopy Anchor Link

Lists your publishing profiles with their IDs and enabled languages.

apimatic publishing profile list

AuthCopy Anchor Link

auth loginCopy Anchor Link

Signs the APIMatic CLI in to your APIMatic account.

apimatic auth login

Flags: --auth-key

auth logoutCopy Anchor Link

Clears your local credentials.

apimatic auth logout

auth statusCopy Anchor Link

Shows whether you're signed in and as whom.

apimatic auth status

HelpCopy Anchor Link

apimatic help <command>
apimatic <command> --help

Flags: -n, --nested-commands