API Builder CLI

This document will walk you through the process of how to create and initialize new projects using the API Builder CLI.

Setup

We recommend using the command-line interface (CLI) with npx.  This will ensure you are always working with the latest CLI.

npx @axway/api-builder

However, it is possible to install the API Builder CLI if you wish:

[sudo] npm install -g @axway/api-builder

Create a project

To create a new project:

npx @axway/api-builder init myproject

The CLI will create and initialize the ./myproject new project directory.

Create a plugin

To create a new plugin:

npx @axway/api-builder plugin init myplugin

The CLI will create and initialize the plugin in a new directory ./api-builder-plugin-myplugin.

CLI commands

Command Arguments Description
api-builder init <dir> dir - The directory to initialize. Creates and initializes a new API Builder project by creating the project in a directory specified by dir. The command will fail if the directory exists or if the command is run within an API Builder project directory.
api-builder plugin init <dir> dir - The directory to initialize. Creates and initializes a new API Builder plugin by creating a directory specified by dir. The dir must be prefixed with "api-builder-plugin-name". If dir is not prefixed, the prefix will be added for you.

Related Links