Finqu CLI

Finqu CLI is a command-line tool for working with the Finqu unified commerce platform. It provides workflows for theme development (configure, download, deploy, dev) and headless storefront development (create, build, dev) with Puck editor integration.

Install

Install globally with npm:

npm install -g @finqu/cli

Verify installation:

finqu --version

Quick start (theme development)

1. Sign in:

finqu sign-in

2. Connect your local project to a theme:

finqu theme configure

3. Install the local Theme Development Kit (finqu-theme-dev) by following the installation guide.

4. Start local theme development:

finqu theme dev

On first run, finqu theme dev checks whether finqu-theme-dev authentication has already been completed. If credentials are missing, it automatically runs finqu-theme-dev auth and guides you through entering your store URL and channel API key.

5. (Optional) Download or deploy assets directly:

finqu theme download
finqu theme deploy

Quick start (storefront development)

Create a new headless storefront project:

finqu storefront create my-storefront

What’s in the CLI docs

• Authentication: how finqu sign-in works and how credentials/tokens are handled. See Authentication.
• App: reference for finqu app commands for app management, releases, and webhook forwarding. See App.
• Theme: reference + examples for finqu theme commands. See Theme.
• Storefront: reference + examples for finqu storefront commands. See Storefront.
• Configuration: .env file format, config keys, and config precedence. See Configuration.
• Troubleshooting: common issues and how to debug. See Troubleshooting.
• Theme Development Kit (recommended for local theme development): install and use the local preview server. See Theme Development Kit and finqu theme dev.

Global options

These options can be used with most commands: