Installation

Requirements

• Node.js 18 or later
• npm, pnpm, bun, or yarn

Install Globally

npm

npm install -g fexapi

pnpm

pnpm add -g fexapi

bun

bun add --global fexapi

yarn

yarn global add fexapi

After installing, verify it works:

fexapi --help

Use Without Installing

You can run FexAPI directly with your package manager:

Legend: npx = npm, pnpm dlx = pnpm, bunx = bun, yarn dlx = yarn.

npx

npx fexapi@latest init

pnpm

pnpm dlx fexapi@latest init

bun

bunx fexapi@latest init

yarn

yarn dlx fexapi@latest init

Add to a Project

Install as a dev dependency in an existing project:

npm

npm install -D fexapi

pnpm

pnpm add -D fexapi

bun

bun add -d fexapi

yarn

yarn add -D fexapi

Then add scripts to your package.json:

{
  "scripts": {
    "mock:init": "fexapi init",
    "mock:generate": "fexapi generate",
    "mock:dev": "fexapi dev --watch",
    "mock:serve": "fexapi serve"
  }
}

Next Steps

Once installed, head to the Quick Start guide.