Floe CLI

@floehq/cli is the official command-line interface for the Floe API.

Install

npm install -g @floehq/cli

Or run without a global install:

npx @floehq/cli --help

Commands

floe upload ./video.mp4
floe upload status <uploadId>
floe upload cancel <uploadId>
floe upload complete <uploadId>
floe upload wait <uploadId>
floe file metadata <fileId>
floe file manifest <fileId>
floe file stream-url <fileId>
floe ops health
floe ops version
floe doctor
floe config show
floe config path
floe config set base-url https://api.floehq.com/v1
floe config unset api-key

Useful flags for the newer upload contract:

floe upload ./video.mp4 --include-blob-id --include-walrus-debug --idempotency-key upload-video-1
floe upload complete <uploadId> --idempotency-key complete-upload-1
floe upload cancel <uploadId> --idempotency-key cancel-upload-1
floe upload status <uploadId> --include-walrus-debug

Shortcuts are also supported for the most common lookups:

floe status <uploadId>
floe cancel <uploadId>
floe metadata <fileId>
floe manifest <fileId>
floe stream-url <fileId>

Compatibility

The CLI checks the server-reported compatibility contract before normal API commands.

Useful commands:

floe ops version
floe doctor

Bypass the guard only when you are debugging an older deployment:

floe ops health --no-compat-check

Config

The CLI can persist defaults in a local config file. Precedence is:

flags > environment variables > config file > defaults

Supported persistent keys:

base-url
api-key
bearer
owner-address
auth-user
wallet-address

Examples:

floe config path
floe config set base-url https://api.floehq.com/v1
floe config set api-key sk_live_xxx
floe config unset api-key

Auth notes:

• --api-key sends x-api-key
• --bearer sends Authorization: Bearer <token>
• if both are set, Floe core evaluates Authorization first