Getting Started with the Fluent CLI

How-to Guide

Authors:

Lesley Dean, Marco Heuer

Changed on:

14 Sept 2026

Key Points

Log in as an Admin and confirm you have permission to install software.
Install `Node.js` LTS (`(>=20.0.0 <25.0.0 for version 2.2.2+; >=20.0.0 <23.0.0 for earlier versions`) 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 changelog list` and explore commands with `fluent --help`

Steps

Overview

This page will guide you through preparing your local environment, and installing the Fluent CLI.

Prerequisites

Before installing the Fluent CLI, there are few prerequisites required:

Make sure you are logged in with an Admin User on your local machine and that you have permissions to install new software.
Install the LTS version of Node.js (includes npm): Node.js — Download Node.js®.
Note: The Fluent CLI can support Node versions: `>=20.0.0 <23.0.0` (or `>=20.0.0 <25.0.0` for version 2.2.2+) and Npm versions: `>=10.5.0`.

Installation

Open a Terminal window
Make sure you have the correct versions of Node and npm activated on your path:
- Run `node --version` and verify the version is greater than or equal to 20.0.0 and less than 22.0.0 (or less than 25.0.0 for version 2.2.2+)
- Run `npm --version` and verify the version is greater than or equal to 10.5.0
Install the Fluent CLI globally: `npm install -g https://downloads.fluentcommerce.com/v1.0.0/fluent-cli/release/latest`
- Note: the `v1.0.0` in the URL is the version of the API. You're still downloading the `latest` of the Fluent CLI!
Once installed, verify that the Fluent CLI has installed and is active on the path: `fluent changelog list`
Optionally, run the help command to view available commands: `fluent --help`

1➜  ~ fluent -h
2Usage: fluent <command> <subcommand> <argument> [options]
3
4A CLI for interacting with Fluent Commerce Accounts and Modules.
5
6Options:
7  -v, --version   Returns the installed version of the Fluent CLI.
8  -d, --debug     Enable verbose debug logging
9  -q, --quiet     Enable quiet logging
10  -h, --help      display help for command
11
12Commands:
13  help [command]  display help for command
14  module
15  profile
16  retailer

Next Steps

Explore the Fluent CLI Reference
Learn How to Set up a new Account with Reference Modules
Need more help?
- Log a bug - select the incident type "Fluent CLI"
- Ask a question in the developer community in the Builders portal forums.

Related content

Fluent CLI Reference

Edited 47 days ago

The 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>`.

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

Edited 130 days ago

Knowledge Tracks Related To This Topic

Introduction to AI Assisted Fluent Development

Introduction to AI Assisted Fluent Development [BETA]

Introduction to the Search MCP Tool [BETA]

Getting Started with the Fluent CLI

Setting Up Fluent Sandbox with Claude Code

Agentic Development Skills in Fluent CLI [BETA]

Getting started with the Fluent Builder MCP server

Configuring and Extending Fluent UI Using Fluent Builder MCP Server

Installation

Open a Terminal window
Make sure you have the correct versions of Node and npm activated on your path:
- Run `node --version` and verify the version is greater than or equal to 20.0.0 and less than 22.0.0 (or less than 25.0.0 for version 2.2.2+)
- Run `npm --version` and verify the version is greater than or equal to 10.5.0
Install the Fluent CLI globally: `npm install -g https://downloads.fluentcommerce.com/v1.0.0/fluent-cli/release/latest`
- Note: the `v1.0.0` in the URL is the version of the API. You're still downloading the `latest` of the Fluent CLI!
Once installed, verify that the Fluent CLI has installed and is active on the path: `fluent changelog list`
Optionally, run the help command to view available commands: `fluent --help`

1➜  ~ fluent -h
2Usage: fluent <command> <subcommand> <argument> [options]
3
4A CLI for interacting with Fluent Commerce Accounts and Modules.
5
6Options:
7  -v, --version   Returns the installed version of the Fluent CLI.
8  -d, --debug     Enable verbose debug logging
9  -q, --quiet     Enable quiet logging
10  -h, --help      display help for command
11
12Commands:
13  help [command]  display help for command
14  module
15  profile
16  retailer

Getting Started with the Fluent CLI

Key Points

Steps

Overview

Prerequisites

Installation

Next Steps

Related content

Fluent CLI Reference

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

Lesley Dean

Contributors:

Knowledge Tracks Related To This Topic

Building Blocks

By Type

Helpful Resources

Quick Links

Overview

Prerequisites

Installation

Next Steps