@fluid-app/fluid-cli-theme-dev
v0.1.15
Published
Fluid CLI plugin for theme developer workflows — dev server, push, pull, init
Keywords
Readme
@fluid-app/fluid-cli-theme-dev
Fluid CLI plugin for theme development. Adds fluid theme commands for local dev server, push, pull, and scaffolding.
Installation
npm install -g @fluid-app/fluid-cli @fluid-app/fluid-cli-theme-devRequires @fluid-app/fluid-cli as the core CLI.
Authentication
Log in before using any theme commands:
fluid loginCommands
fluid theme dev
Start a local dev server that proxies your storefront with hot reload:
fluid theme devThe dev server will:
- Create (or reuse) a development theme
- Upload all local files to the dev theme
- Watch for file changes and sync them automatically
- Proxy requests to
{company}.fluid.appwith local file overrides
| Flag | Default | Description |
| -------------------------- | ----------- | ----------------------------------------- |
| --host <host> | 127.0.0.1 | Local server host |
| --port <port> | 9292 | Local server port |
| -t, --theme <name-or-id> | auto | Use a specific theme instead of dev theme |
| --live-reload <mode> | full-page | Reload mode: full-page or off |
| --navigate | off | Open browser navigator after start |
| --root <path> | . | Theme root directory |
fluid theme push
Upload local theme files to a remote theme:
fluid theme push # Interactive theme selection
fluid theme push --theme "My Theme" # By name
fluid theme push --theme 42 # By ID
fluid theme push --publish # Push and publish
fluid theme push --nodelete # Keep remote files not present locallyfluid theme pull
Download a remote theme to your local directory:
fluid theme pull # Interactive theme selection
fluid theme pull --theme "My Theme" # By name or ID
fluid theme pull --nodelete # Keep local files not present on remotefluid theme init
Scaffold a new theme from the base template:
fluid theme init my-theme
cd my-theme
fluid theme devfluid theme navigate
Interactively select a route and open it in the browser (requires a running dev server):
fluid theme navigateTheme Directory Structure
A valid theme directory must contain at least one of: templates/, assets/, or config/.
Use a .fluidignore file (same syntax as .gitignore) to exclude files from syncing.
Development
For contributors working in fluid-mono:
pnpm --filter @fluid-app/fluid-cli-theme-dev build
node packages/cli/core/dist/bin/fluid.mjs theme --help