@apimatic/cli

apimatic is in Alpha.

The official CLI for APIMatic.

Getting Started

To get started with APIMatic's CLI using a step by step wizard, run the following command:

$ apimatic portal:quickstart

Usage

$ npm install -g @apimatic/cli
$ apimatic COMMAND
running command...
$ apimatic (--version)
@apimatic/cli/1.1.0-alpha.10 win32-x64 node-v23.4.0
$ apimatic --help [COMMAND]
USAGE
  $ apimatic COMMAND
...

Commands

apimatic api:transform
apimatic api:validate
apimatic auth:login
apimatic auth:logout
apimatic auth:status
apimatic autocomplete [SHELL]
apimatic help [COMMAND]
apimatic portal:generate
apimatic portal:quickstart
apimatic portal:recipe:new
apimatic portal:serve
apimatic portal:toc:new
apimatic sdk:generate

`apimatic api:transform`

Transform API specifications from one format to another. Supports 10+ different formats including OpenApi/Swagger, RAML, WSDL and Postman Collections.

USAGE
  $ apimatic api:transform --format <value> [--file <value>] [--url <value>] [--destination <value>] [-f]
    [--auth-key <value>]

FLAGS
  -f, --force                overwrite if same file exist in the destination
      --auth-key=<value>     override current authentication state with an authentication key
      --destination=<value>  [default: ./] directory to download transformed file to
      --file=<value>         path to the API specification file to transform
      --format=<value>       (required) specification format to transform API specification into
                             APIMATIC|WADL2009|WSDL|SWAGGER10|SWAGGER20|SWAGGERYAML|OAS3|OPENAPI3YAML|APIBLUEPRINT|RAML|
                             RAML10|POSTMAN10|POSTMAN20|GRAPHQLSCHEMA
      --url=<value>          URL to the API specification file to transform. Can be used in place of the --file option
                             if the API specification is publicly available.

DESCRIPTION
  Transform API specifications from one format to another. Supports [10+ different
  formats](https://www.apimatic.io/transformer/#supported-formats) including OpenApi/Swagger, RAML, WSDL and Postman
  Collections.

EXAMPLES
  $ apimatic api:transform --format="OpenApi3Json" --file="./specs/sample.json" --destination="D:/"
  Success! Your transformed file is located at D:/Transformed_OpenApi3Json.json

  $ apimatic api:transform --format=RAML --url="https://petstore.swagger.io/v2/swagger.json"  --destination="D:/"
  Success! Your transformed file is located at D:/swagger_raml.yaml

See code: src/commands/api/transform.ts

`apimatic api:validate`

Validate the syntactic and semantic correctness of an API specification

USAGE
  $ apimatic api:validate [--file <value>] [--url <value>] [--auth-key <value>]

FLAGS
  --auth-key=<value>  override current authentication state with an authentication key
  --file=<value>      Path to the API specification file to validate
  --url=<value>       URL to the specification file to validate. Can be used in place of the --file option if the API
                      specification is publicly available.

DESCRIPTION
  Validate the syntactic and semantic correctness of an API specification

EXAMPLES
  $ apimatic api:validate --file="./specs/sample.json"
  Specification file provided is valid

  $ apimatic api:validate --url=https://petstore.swagger.io/v2/swagger.json
  Specification file provided is valid

See code: src/commands/api/validate.ts

`apimatic auth:login`

Login using your APIMatic credentials or an API Key

USAGE
  $ apimatic auth:login [--auth-key <value>]

FLAGS
  --auth-key=<value>  Set authentication key for all commands

DESCRIPTION
  Login using your APIMatic credentials or an API Key

EXAMPLES
  $ apimatic auth:login
  Enter your registered email: [email protected]
  Please enter your password: *********
  You have successfully logged into APIMatic

  $ apimatic auth:login --auth-key=xxxxxx
  Authentication key successfully set

See code: src/commands/auth/login.ts

`apimatic auth:logout`

Clear local login credentials

USAGE
  $ apimatic auth:logout

DESCRIPTION
  Clear local login credentials

EXAMPLES
  $ apimatic auth:logout
  Logged out

See code: src/commands/auth/logout.ts

`apimatic auth:status`

View current authentication state

USAGE
  $ apimatic auth:status

DESCRIPTION
  View current authentication state

EXAMPLES
  $ apimatic auth:status
  Currently logged in as [email protected]

See code: src/commands/auth/status.ts

`apimatic autocomplete [SHELL]`

Display autocomplete installation instructions.

USAGE
  $ apimatic autocomplete [SHELL] [-r]

ARGUMENTS
  SHELL  shell type

FLAGS
  -r, --refresh-cache  Refresh cache (ignores displaying instructions)

DESCRIPTION
  Display autocomplete installation instructions.

EXAMPLES
  $ apimatic autocomplete
  $ apimatic autocomplete bash
  $ apimatic autocomplete zsh
  $ apimatic autocomplete --refresh-cache

See code: @oclif/plugin-autocomplete

`apimatic help [COMMAND]`

Display help for apimatic.

USAGE
  $ apimatic help [COMMAND...] [-n]

ARGUMENTS
  COMMAND...  Command to show help for.

FLAGS
  -n, --nested-commands  Include all nested commands in the output.

DESCRIPTION
  Display help for apimatic.

See code: @oclif/plugin-help

`apimatic portal:generate`

Generate and download a static API Documentation portal. Requires an input directory containing API specifications, a config file and optionally, markdown guides. For details, refer to the documentation

USAGE
  $ apimatic portal:generate [--folder <value>] [--destination <value>] [-f] [--zip] [--auth-key <value>]

FLAGS
  -f, --force                overwrite if a portal exists in the destination
      --auth-key=<value>     override current authentication state with an authentication key
      --destination=<value>  [default: ./generated_portal] path to the downloaded portal
      --folder=<value>       [default: ./] path to the input directory containing API specifications and config files
      --zip                  download the generated portal as a .zip archive

DESCRIPTION
  Generate and download a static API Documentation portal. Requires an input directory containing API specifications, a
  config file and optionally, markdown guides. For details, refer to the [documentation](https://docs.apimatic.io/platfo
  rm-api/#/http/guides/generating-on-prem-api-portal/build-file-reference)

EXAMPLES
  $ apimatic portal:generate --folder="./portal/" --destination="D:/"
  Your portal has been generated at D:/

See code: src/commands/portal/generate.ts

`apimatic portal:quickstart`

Create your first API Portal using APIMatic's Docs as Code offering.

USAGE
  $ apimatic portal:quickstart

DESCRIPTION
  Create your first API Portal using APIMatic's Docs as Code offering.

EXAMPLES
  $ apimatic portal:quickstart

See code: src/commands/portal/quickstart.ts

`apimatic portal:recipe:new`

Generate an API Recipe for a static API Documentation portal.

USAGE
  $ apimatic portal:recipe:new [--name <value>] [--folder <value>] [--build-config <value>]

FLAGS
  --build-config=<value>  path to the APIMATIC-BUILD.json file. Defaults to the APIMATIC-BUILD.json file in the build
                          directory if not provided.
  --folder=<value>        [default: C:\Users\Ali\Desktop\apimatic-cli] path to the build directory containing specs,
                          content, and build config file. Defaults to the current working directory if not provided.
  --name=<value>          name for the recipe

DESCRIPTION
  Generate an API Recipe for a static API Documentation portal.

  To learn more about API Recipes, visit:
  https://docs.apimatic.io/platform-api/#/http/guides/generating-on-prem-api-portal/api-recipes

EXAMPLES
  $ apimatic portal:recipe:new --name="My API Recipe" --folder="./build-folder" --build-config-file="./build-folder/APIMATIC-BUILD.json"
  Generated recipe has been added to build directory at: C:/build-folder/

  $ apimatic portal:recipe:new
  Generated recipe has been added to build directory at: C:/

See code: src/commands/portal/recipe/new.ts

`apimatic portal:serve`

Generate and deploy a Docs as Code portal with hot reload.

USAGE
  $ apimatic portal:serve [-p <value>] [-d <value>] [-s <value>] [-o] [--no-reload] [-i <value>] [--auth-key
    <value>]

FLAGS
  -d, --destination=<value>  [default: ./generated_portal] Directory to store and serve the generated portal.
  -i, --ignore=<value>       Comma-separated list of files/directories to ignore.
  -o, --open                 Open the portal in the default browser.
  -p, --port=<value>         [default: 3000] Port to serve the portal.
  -s, --source=<value>       [default: ./] Source directory containing specs, content, and build file. By default, the
                             current directory is used.
      --auth-key=<value>     Override current authentication state with an authentication key.
      --no-reload            Disable hot reload.

DESCRIPTION
  Generate and deploy a Docs as Code portal with hot reload.

EXAMPLES
  $ apimatic portal:serve --source="./" --destination="./generated_portal" --port=3000 --open --no-reload

See code: src/commands/portal/serve.ts

`apimatic portal:toc:new`

Generates a TOC file based on the content directory and spec folder provided in your working directory

USAGE
  $ apimatic portal:toc:new [--destination <value>] [--folder <value>] [--force] [--expand-endpoints]
    [--expand-models]

FLAGS
  --destination=<value>  optional path where the generated TOC file will be saved. Defaults to the current working
                         directory if not provided.
  --expand-endpoints     include individual entries for each endpoint in the generated TOC. Requires a valid API
                         specification in the working directory.
  --expand-models        include individual entries for each model in the generated TOC. Requires a valid API
                         specification in the working directory.
  --folder=<value>       [default: C:\Users\Ali\Desktop\apimatic-cli] path to the working directory containing the API
                         project files. Defaults to the current working directory if not specified.
  --force                overwrite the TOC file if one already exists at the destination.

DESCRIPTION
  Generates a TOC file based on the content directory and spec folder provided in your working directory

  This command generates a new Table of Contents (TOC) file used in the
  generation of your API documentation portal.

  The output is a YAML file with the .yml extension.

  To learn more about the TOC file and APIMatic build directory structure, visit:
  https://docs.apimatic.io/platform-api/#/http/guides/generating-on-prem-api-portal/overview-generating-api-portal

EXAMPLES
  $ apimatic portal:toc:new --destination="./portal/content/"
  A new toc file has been created at ./portal/content/toc.yml

  $ apimatic portal:toc:new --folder="./my-project" 
  A new toc file has been created at ./my-project/content/toc.yml

  $ apimatic portal:toc:new --folder="./my-project" --destination="./portal/content/"
  A new toc file has been created at ./portal/content/toc.yml

See code: src/commands/portal/toc/new.ts

`apimatic sdk:generate`

Generate SDK for your APIs

USAGE
  $ apimatic sdk:generate --platform <value> [--file <value>] [--url <value>] [--destination <value>] [-f] [--zip]
    [--auth-key <value>]

FLAGS
  -f, --force                overwrite if an SDK already exists in the destination
      --auth-key=<value>     override current authentication state with an authentication key
      --destination=<value>  [default: ./] directory to download the generated SDK to
      --file=<value>         path to the API specification to generate SDKs for
      --platform=<value>     (required) language platform for sdk
                             Simple: CSHARP|JAVA|PYTHON|RUBY|PHP|TYPESCRIPT|GO
                             Legacy: CS_NET_STANDARD_LIB|JAVA_ECLIPSE_JRE_LIB|PHP_GENERIC_LIB_V2|PYTHON_GENERIC_LIB|RUBY
                             _GENERIC_LIB|TS_GENERIC_LIB|GO_GENERIC_LIB
      --url=<value>          URL to the API specification to generate SDKs for. Can be used in place of the --file
                             option if the API specification is publicly available.
      --zip                  download the generated SDK as a .zip archive

DESCRIPTION
  Generate SDK for your APIs

EXAMPLES
  $ apimatic sdk:generate --platform="CSHARP" --file="./specs/sample.json"
  Generating SDK... done
  Downloading SDK... done
  Success! Your SDK is located at swagger_sdk_csharp

  $ apimatic sdk:generate --platform="CSHARP" --url=https://petstore.swagger.io/v2/swagger.json
  Generating SDK... done
  Downloading SDK... done
  Success! Your SDK is located at swagger_sdk_csharp

See code: src/commands/sdk/generate.ts

Name		Name	Last commit message	Last commit date
Latest commit History 241 Commits
.github/workflows		.github/workflows
.husky		.husky
.vscode		.vscode
bin		bin
src		src
test		test
.editorconfig		.editorconfig
.gitignore		.gitignore
.npmrc		.npmrc
.prettierrc		.prettierrc
CHANGELOG.md		CHANGELOG.md
README.md		README.md
commitlint.config.js		commitlint.config.js
eslint.config.js		eslint.config.js
package-lock.json		package-lock.json
package.json		package.json
release.config.cjs		release.config.cjs
tsconfig.json		tsconfig.json

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Repository files navigation

@apimatic/cli

Getting Started

Usage

Commands

`apimatic api:transform`

`apimatic api:validate`

`apimatic auth:login`

`apimatic auth:logout`

`apimatic auth:status`

`apimatic autocomplete [SHELL]`

`apimatic help [COMMAND]`

`apimatic portal:generate`

`apimatic portal:quickstart`

`apimatic portal:recipe:new`

`apimatic portal:serve`

`apimatic portal:toc:new`

`apimatic sdk:generate`

About

Uh oh!

Releases

Packages

Uh oh!

Contributors 12

Uh oh!

Languages

apimatic/apimatic-cli

Folders and files

Latest commit

History

Repository files navigation

@apimatic/cli

Getting Started

Usage

Commands

apimatic api:transform

apimatic api:validate

apimatic auth:login

apimatic auth:logout

apimatic auth:status

apimatic autocomplete [SHELL]

apimatic help [COMMAND]

apimatic portal:generate

apimatic portal:quickstart

apimatic portal:recipe:new

apimatic portal:serve

apimatic portal:toc:new

apimatic sdk:generate

About

Resources

Uh oh!

Stars

Watchers

Forks

Releases

Packages 0

Uh oh!

Contributors 12

Uh oh!

Languages

`apimatic api:transform`

`apimatic api:validate`

`apimatic auth:login`

`apimatic auth:logout`

`apimatic auth:status`

`apimatic autocomplete [SHELL]`

`apimatic help [COMMAND]`

`apimatic portal:generate`

`apimatic portal:quickstart`

`apimatic portal:recipe:new`

`apimatic portal:serve`

`apimatic portal:toc:new`

`apimatic sdk:generate`

Packages