Skip to main content

Prerequisites

The CLI is distributed as an npm package but internally uses Bun. If you only have Node.js, npm install -g will work, but some edge cases may require Bun installed as the runtime.

Install

Verify installation

If lofty-cli: command not found appears:
  • npm: Run npm config get prefix and add <prefix>/bin to your shell PATH
  • nvm: Make sure your current Node version is active (nvm use default)
  • Windows/PowerShell: Use npx lofty-cli instead, or add the npm global bin to your system PATH

Upgrade

The CLI also performs a lightweight background check at startup and prints a notice when a newer version is available.

Uninstall

Credential files are not removed automatically. Delete them manually for a clean slate:

Alternative: per-project install

Useful when different projects need different CLI versions, or in CI without a global install.

Next steps

Authenticate

Required before any API call.

Quickstart

Common end-to-end examples.