Docs

Search

Help & Feedback

Get Started
Functionality
Learning
Extension
Dev Tooling
APIs
Releases

Fluent CLI Docs

Fluent CLI Documentation

Add Existing Retailer to Fluent CLI Profile

This page shows you how to add an existing retailer to a Fluent CLI Profile

Bootstrap an account using the Fluent CLI

Create a profile
Create a retailer
Configure and Install the Fluent Reference Modules
Configure and Install the Extension Data module
Validate the Account setup

CI/CD Pipeline Configuration Using Fluent CLI

The CI/CD pipeline is configured for Bitbucket and requires changes for other repositories
The CLI is not used for retailer creation in the deployment process
One retailer's assets can be deployed at a time through manual selection.
The E2E plugin must be manually placed in the `plugins/` folder before starting the pipeline.

Fluent CLI Reference

TopicThe Fluent CLI provides command line tooling for interacting with Fluent Accounts and Modules.UsageThe Fluent CLI is activated by typing the keyword `fluent` into a terminal command line, followed by a Command, Subcommand, Argument, and Options:`fluent <command> <subcommand> <argument> [options]`

The `<command>` will refer to a noun (or “a thing”).
The `<subcommand>` will refer to a verb (or action).
The `<argument>` is the primary required name of the “thing” identified by the `<command>`.
The `[options]` may include required or optional additional parameters to be used by the `<command>` and `<subcommand>`.

Getting Started with the Fluent CLI

Log in as an Admin and confirm you have permission to install software.
Install `Node.js` LTS (`>=20.0.0 <23.0.0`) and `npm` (`>=10.5.0`), then verify both are on your path.
Install the Fluent CLI globally
`npm install -g https://downloads.fluentcommerce.com/v1.0.0/fluent-cli/release/latest`
Confirm installation with `fluent --version and explore commands with fluent --help`.

Module Recipe - Plugin Setup and Installation Guide

Create the new module: `fluent module create -n <module-name> `
Populate the plugin structure in `plugins/`
  `rules/` - Contains rules, unit tests and GraphQL queries/mutations
  `types/` - Stores model classes and extended DTOs
  `util/` - Holds service classes and utilities
Build the module: `./scripts/build-module.sh`
Install the module: `fluent module install dist/<module-name>-<version>.zip -p <profile> -r <retailer>`

Set up a new Account with Reference Modules and B2C Sample Data

Create a profile
Create a retailer
Install the Fluent Reference Modules
Install B2C Sample Data modules
Validate the Account set up

Troubleshooting the Fluent CLI

This section will detail a few common issues and troubleshooting options for Fluent CLI.

Copyright © 2024-2026 Fluent Retail Pty Ltd (trading as Fluent Commerce). Unless otherwise expressly stated in a current written agreement with Fluent Commerce or any of its affiliates or on any single page of the docs.fluentcommerce.com site, use of the materials on this site is strictly limited to viewing by individuals over 18 years old for legitimate commercially appropriate reasons; and any downloading, copying or other actions or uses of any kind or by any means of the materials on this site, including by artificial intelligence tools, is strictly prohibited. All other rights reserved.