CLI Commands
fluxlay login
Authenticate with your Fluxlay account via device authorization.
fluxlay loginOpens a browser window for sign-in. Displays a user code for verification. The session is saved locally after approval.
fluxlay logout
Remove the saved session.
fluxlay logoutfluxlay whoami
Display the currently authenticated user.
fluxlay whoamifluxlay dev
Start a development server for live wallpaper preview.
fluxlay dev [dir]| Argument | Description | Default |
|---|---|---|
dir | Project directory | . (current directory) |
Behavior:
- Validates
fluxlay.yaml. - Finds an available port starting from 3000.
- Starts a Vite dev server.
- Writes
dev.jsonto the app data directory. - The desktop app detects the dev server and renders with HMR.
fluxlay build
Build the wallpaper into an encrypted .fluxlay package.
fluxlay build [dir] [-o <name>]| Argument / Option | Description | Default |
|---|---|---|
dir | Project directory | . |
-o, --output <name> | Output file name | wallpaper.fluxlay |
Requires: Active login session and a kind field in fluxlay.yaml.
Behavior branches by kind:
kind: web→ Runs Vite build and packagesdist/.kind: video/kind: image→ Packages the single media file specified bysource.
fluxlay publish
Build and publish the wallpaper to the Fluxlay store.
fluxlay publish [dir]| Argument | Description | Default |
|---|---|---|
dir | Project directory | . |
Requires: Active login session, completed onboarding.
Behavior:
- Validates
fluxlay.yaml(thekindfield is required). - Generates a content encryption key.
- Registers the version with the API.
- Builds the bundle based on
kind:web: Packages the Vite build output (dist/).video/image: Packages the media file specified bysourceasmedia.<ext>(Vite build is skipped).
- Encrypts and uploads.
- Confirms with the API.
For kind: video / kind: image wallpapers, HTML is not bundled — the desktop app generates it dynamically at delivery time.