Skip to main content

​
Installation

​
Install from npm

Or with other package managers:

​
Verify installation

​
Authenticate

This opens your browser to authorize the CLI with your Swarm account. A device code is displayed in your terminal — confirm it matches in the browser, then click Authorize CLI. Your credentials are stored locally at ~/.config/swarm/config.json and persist across sessions.

​
Custom API URL

If you’re using a self-hosted or staging instance:

​
Log out

This removes stored credentials from your machine.

​
Requirements

  • Node.js 18 or later
  • A Swarm account on the Pro plan or higher
  • For local testing with Cloudflare tunnels: cloudflared binary (install guide)