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.
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 watch | Automatically deploy changes to assets as you work |
finqu theme configure
Set up your project to work with a theme.
Usage
finqu theme configureWhat 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.jsonfile andconfig/.draftdirectory are protected and will not be uploaded to prevent accidental overwrites of theme settings made in the backend theme editor. Use the--forceoption 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 --forcefinqu 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.liquidfinqu theme watch
Automatically deploy changes to assets as you work.
Usage
finqu theme watchOptions
| Option | Description |
|---|---|
--ignore <patterns...> | Patterns to ignore (in addition to default ignores) |
What it does
This command monitors your local theme directory for changes and automatically uploads modified files to your connected theme. This is ideal for active development when you want to see changes reflected immediately.
Example
# Start watching for changes
finqu theme watch
# Watch while ignoring specific patterns
finqu theme watch --ignore "*.log" --ignore "node_modules/**"Typical Workflow
Initial Setup
- Authenticate:
finqu sign-in - Configure your theme:
finqu theme configure - Download theme assets:
finqu theme download
Development Cycle
- Make changes to theme files locally
- Deploy changes:
finqu theme deploy - Or use the watcher for continuous sync:
finqu theme watch
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 fileNext Steps
- CLI Overview - General CLI documentation
- Configuration - Configuration reference
- Troubleshooting - Common issues and solutions