Skip to Content
APIs & ToolsCommand Line Interface (CLI)Overview

Finqu CLI

Finqu CLI is a command-line tool for working with the Finqu unified commerce platform. Today, it focuses on theme development workflows (configure, download, deploy, watch), and it’s designed to expand over time.

Install

Install globally with npm:

npm install -g @finqu/cli

Verify installation:

finqu --version

Quick start (theme development)

  1. Sign in:
finqu sign-in
  1. Connect your local project to a theme:
finqu theme configure
  1. Download theme assets:
finqu theme download
  1. Start a development loop:
finqu theme watch

What’s in the CLI docs

  • Authentication: how finqu sign-in works and how credentials/tokens are handled. See Authentication.
  • Theme: reference + examples for finqu theme commands. See Theme.
  • Configuration: finqu.config.json, environments, and config precedence. See Configuration.
  • Troubleshooting: common issues and how to debug. See Troubleshooting.

Global options

These options can be used with most commands:

OptionDescriptionDefault
-v, --verboseEnable detailed logging outputfalse
-e, --env <environment>Specify the configuration environment to useproduction
-c, --config <path>Path to the configuration file./finqu.config.json
--helpDisplay help information
--versionDisplay version information