@fluxlay/cli

CLI for building, developing, and publishing Fluxlay wallpapers.

Installation

npm install -g @fluxlay/cli
# or
pnpm add -g @fluxlay/cli

Commands

fluxlay login

Authenticate with Fluxlay. Opens a browser window for sign-in and stores the session locally.

fluxlay login

fluxlay logout

Remove the stored session.

fluxlay logout

fluxlay whoami

Display the currently authenticated user.

fluxlay whoami

fluxlay dev [dir]

Start a development server for a wallpaper project. The Fluxlay app will hot-reload as you edit files.

fluxlay dev
fluxlay dev ./my-wallpaper

fluxlay build [dir]

Build and package a wallpaper into a .fluxlay file.

fluxlay build
fluxlay build ./my-wallpaper -o output.fluxlay

| Option | Default | Description | |--------|---------|-------------| | -o, --output <name> | wallpaper.fluxlay | Output filename |

fluxlay publish [dir]

Build and publish a wallpaper to the Fluxlay store.

fluxlay publish
fluxlay publish ./my-wallpaper

Project Structure

A Fluxlay wallpaper project requires a fluxlay.yaml manifest at the root:

name: My Wallpaper
slug: my-wallpaper
version: 0.1.0
description: |
  A description of your wallpaper.

Minimal package.json

{
  "name": "my-wallpaper",
  "private": true,
  "version": "0.1.0",
  "type": "module",
  "scripts": {
    "dev": "fluxlay dev",
    "build": "fluxlay build",
    "publish": "fluxlay publish"
  },
  "dependencies": {
    "@fluxlay/react": "latest",
    "react": "^19.0.0",
    "react-dom": "^19.0.0"
  },
  "devDependencies": {
    "@fluxlay/cli": "latest",
    "@fluxlay/vite": "latest"
  }
}