Skip to content

Installation

Prerequisites

This tool requires Node.js environment. The minimum required Node.js version is 16.16.0.

If you haven't installed Node.js yet, please visit the official Node.js website to download and install it.

Version Check

You can check your current Node.js version by running:

shell
node -v

Global Installation

shell
npm i @apisorcery/cli -g
shell
pnpm add @apisorcery/cli -g
shell
yarn global add @apisorcery/cli
shell
bun add @apisorcery/cli -g

Verify Installation

After installing globally, run the following command to confirm the CLI is available:

shell
apisorcery -v

You should see the current version number printed, e.g. 1.3.0.

Local Installation

shell
npm i @apisorcery/cli --save-dev
shell
pnpm add @apisorcery/cli --save-dev
shell
yarn add @apisorcery/cli --dev
shell
bun add @apisorcery/cli --dev