Theme Commands

All theme-related commands are grouped under finqu theme. These commands help you manage theme assets, sync files between your local development environment and your Finqu theme, and streamline your development workflow. For local theme preview and development, the recommended approach is the Theme Development Kit — use finqu theme dev (or run finqu-theme-dev serve directly).

Overview

Command	Description
`finqu theme configure`	Set up your project to work with a theme
`finqu theme download`	Download theme assets from the connected Finqu theme
`finqu theme deploy`	Upload local theme assets to the connected Finqu theme
`finqu theme delete`	Delete specific assets from the theme
`finqu theme dev`	Start local theme development (recommended; uses Theme Development Kit)

`finqu theme configure`

Set up your project to work with a theme.

Usage


finqu theme configure

What it does

This interactive command walks you through:

Selecting a theme to work with
Saving the configuration to your configuration file

The configuration is stored in finqu.config.json (or the file specified by --config). For details on the configuration structure, see Configuration.

`finqu theme download`

Download theme assets from the connected Finqu theme.

Usage


finqu theme download [sources...]

Arguments

Argument	Description
`[sources...]`	Optional file paths to download specific files or directories

When no sources are specified, all theme assets will be downloaded to your local directory.

Example


# Download all theme assets
finqu theme download
 
# Download specific files or directories
finqu theme download assets/main.css sections/header.liquid
finqu theme download assets/

`finqu theme deploy`

Upload local theme assets to the connected Finqu theme.

Usage


finqu theme deploy [sources...]

Arguments

Argument	Description
`[sources...]`	Optional file paths to deploy specific files or directories

Options

Option	Description
`--clean`	Remove remote theme assets not found locally
`--force`	Include restricted paths like `config/` and `.draft` directories
`--no-compile`	Skip asset compilation on the server after upload

When no sources are specified, all local theme assets will be uploaded.

Note: By default, the config/settings_data.json file and config/.draft directory are protected and will not be uploaded to prevent accidental overwrites of theme settings made in the backend theme editor. Use the --force option to include them if necessary.

Example


# Deploy all local theme assets
finqu theme deploy
 
# Deploy specific files
finqu theme deploy assets/main.css sections/header.liquid
 
# Deploy and clean up remote files that don't exist locally
finqu theme deploy --clean
 
# Deploy including protected config files
finqu theme deploy --force

`finqu theme delete`

Delete specific assets from the theme.

Usage


finqu theme delete [sources...]

Arguments

Argument	Description
`[sources...]`	File paths of assets to delete

Options

Option	Description
`--no-compile`	Skip asset compilation on the server after deletion

Example


# Delete specific files
finqu theme delete assets/old-script.js sections/removed-section.liquid

`finqu theme dev`

Start local theme development using the Theme Development Kit (finqu-theme-dev binary).

Usage


finqu theme dev

Options

Option	Description	Default
`-p, --port <number>`	Port to listen on	`3000`
`-d, --dir <path>`	Theme directory path

What it does

This command provides the recommended local theme development workflow:

Checks that finqu-theme-dev is installed and available on your PATH
Checks whether finqu-theme-dev authentication has already been completed
Automatically starts finqu-theme-dev auth if credentials are missing
Starts the local theme development server with finqu-theme-dev serve

The finqu-theme-dev tool uses its own credentials file at ~/.finqu-theme-dev/credentials.json and requires a channel API key. This is separate from the OAuth access token used by finqu sign-in.

Example


# Start the local development server
finqu theme dev
 
# Custom port and theme directory
finqu theme dev --port 8080 --dir ./theme

Typical Workflow

Initial Setup

Authenticate: finqu sign-in
Configure your theme: finqu theme configure
Download theme assets: finqu theme download
Install finqu-theme-dev: Theme Development Kit installation
Start local development: finqu theme dev

Development Cycle

Make changes to theme files locally
Preview changes locally with finqu theme dev
Deploy changes when ready: finqu theme deploy

Project Structure

A typical Finqu theme has the following structure:


theme-name/
├── assets/          # CSS, JavaScript, images, and fonts
├── config/          # Theme settings and configuration
│   └── settings_data.json   # Theme settings (protected during deploy)
├── layout/          # Layout templates
├── locales/         # Translation files (JSON format)
├── blocks/          # Reusable blocks
├── sections/        # Page sections
├── snippets/        # Code snippets
├── templates/       # Page templates
└── finqu.config.json  # CLI configuration file

Next Steps

Theme Development Kit — Recommended local theme preview and development
CLI Overview — General CLI documentation
Configuration — Configuration reference
Troubleshooting — Common issues and solutions