CLI Setup

The OtterKit CLI requires Node.js 18+ and works on macOS, Linux, and Windows.

Quick start with npx (no install)

Run commands directly without installing anything globally. Best for one-off usage or trying OtterKit out.

bash
npx otterkit tunnel 3000

Global install via npm

Install globally for faster startup and repeated use. Recommended if you use OtterKit regularly.

bash
npm install -g otterkit

Once installed globally, you can run commands directly without npx:

bash
otterkit tunnel 3000
otterkit webhook
otterkit status

When to use which

Use npx otterkit if you want zero setup and don't mind a slight startup delay. Use npm install -g otterkit if you use the CLI frequently and want instant startup.

Verify installation

bash
otterkit --version