Fluent CLI Docs

Fluent CLI Documentation

Add Existing Retailer to Fluent CLI Profile

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.

Smart Resume for Recovery: If an installation fails due to network or timeout issues, simply re-running the same command allows the CLI to skip successful modules and resume from the point of failure.
Version Safety Rails: The system automatically upgrades modules to newer versions but blocks downgrades and re-installs of the same version to prevent accidental data loss unless the `--force` flag is used.
Conflict & Validation Gates: Installations are blocked if blueprint-defined conflicts with existing modules are detected. Use `blueprint describe` to identify exact module names if filters or conflict rules trigger errors.
Strict Config Naming: Custom configurations are only recognized during install if they follow the `module.config.<RETAILER-REF>.<MODULE-SHORT-NAME>.json` pattern; otherwise, the system defaults to auto-generated configs.

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 changelog list` 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>`