Skip to main content

Documentation Index

Fetch the complete documentation index at: https://developer.lofty.com/llms.txt

Use this file to discover all available pages before exploring further.

​
Prerequisites

RequirementMinimum versionNotes
Bun or Node.jsBun 1.0+ / Node 18.0+Bun is recommended (the CLI bundle uses Bun internally). Node.js works via npm install but may require additional setup.
npm (or pnpm / yarn)any recentFor installing the package
A Lofty account—For API key or OAuth credentials
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

npm install -g @loftyai/lofty-cli

​
Verify installation

# Check version
lofty-cli --version

# Check available commands
lofty-cli --help

# Verify auth is working (after login)
lofty-cli auth status
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

npm install -g @loftyai/lofty-cli@latest
The CLI also performs a lightweight background check at startup and prints a notice when a newer version is available.

​
Uninstall

npm uninstall -g @loftyai/lofty-cli
Credential files are not removed automatically. Delete them manually for a clean slate: 
rm -f ~/.config/tokens/lofty-*.txt
rm -f ~/.config/tokens/lofty-*.json
PathCreated byContents
~/.config/tokens/lofty-session-cache.jsonauth login-sessionToken URL response
~/.config/tokens/lofty-pkce-cache.jsonauth login-browserBrowser OAuth tokens
~/.config/tokens/lofty-oauth-cache.jsonauth loginClient credentials tokens

​
Alternative: per-project install

npm install --save-dev @loftyai/lofty-cli
npx lofty-cli --help
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.