CLI Setup

The OtterKit CLI needs Node.js 18 or later and works on macOS, Linux, and Windows.

Log in (one time)#

Endpoints are paid for with prepaid credits, so log in once before you create one. The browser opens; sign in and approve the device. The CLI saves a token to ~/.otterkit/credentials.json, and from then on the CLI and every AI agent on the machine can create endpoints with your credits.

npx otterkit login     # browser device-flow login
npx otterkit whoami    # show the account and credit balance
npx otterkit balance   # show just the credit balance
npx otterkit logout    # remove the saved token

New accounts get 10 free credits. Buy more in the console↗.

Headless machines and CI#

Create a token in the console under API keys↗. Then either set it as an environment variable, or save it without the browser flow:

export OTTERKIT_TOKEN=otk_...           # used instead of the saved login
npx otterkit login --token otk_...       # validates and saves the token

Run with npx (no install)#

Run commands directly without a global install. This suits one-off use or trying OtterKit out.

npx otterkit tunnel 3000

Install globally with npm#

A global install starts faster, which helps if you use OtterKit often.

npm install -g otterkit

After that, run commands without npx:

otterkit tunnel 3000
otterkit webhook
otterkit status

Check the installed version#

otterkit --version