Fluent CLI Docs

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

• 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.

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

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

• 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>`

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

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