Docs

Search

Help & Feedback

Home
Essential Knowledge
By Type
Building Blocks
APIs
Releases

Fluent CLI Docs

Fluent CLI Documentation

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

Fluent CLI Reference

The Fluent CLI provides command line tooling for interacting with Fluent Accounts and Modules.

Usage

The 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

Overview
Prerequisites
Installation
Next Steps

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

Copyright © 2025 Fluent Retail Pty Ltd (trading as Fluent Commerce). All rights reserved. No materials on this docs.fluentcommerce.com site may be used in any way and/or for any purpose without prior written authorisation from Fluent Commerce. Current customers and partners shall use these materials strictly in accordance with the terms and conditions of their written agreements with Fluent Commerce or its affiliates.