Getting Started with the Fluent CLI
How-to Guide
Authors:
Lesley Dean, Marco Heuer
Changed on:
8 Oct 2024
Key Points
- Overview
- Prerequisites
- Installation
- Next Steps
Steps
Overview
Overview
This page will guide you through preparing your local environment, and installing the .
Prerequisites
Prerequisites
Before installing the , 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 NodeJS (includes npm): Node.js — Download Node.js®
Note: The Fluent CLI can support Node version:`>=20.0.0 <22.0.0`
and Npm version:`>=10.5.0 <11.0.0`
Installation
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 or equal to 20.0.0 and less than 22.0.0 - Run
`npm --version`
and verify the version is greater or equal to 10.5.0
- Run
- Install the Fluent CLI globally:
`npm install -g https://downloads.fluentcommerce.com/v1.0.0/fluent-cli/release/latest`
- Once installed, verify that the Fluent CLI has installed and is active on the path:
`fluent --version`
- 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
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 Slack Channel: #partner_support (Note: Requires Slack Connect)