Fluent Commerce Logo
Docs

Fluent CLI Commands and use cases

Essential knowledgeCore knowledge to understand Fluent Commerce

Changed on:

15 Sept 2026

Overview

Fluent CLI is a command-line interface tool that enables support teams and operations engineers to:
  • Authenticate and manage multiple account profiles
  • Investigate orders, fulfilments, and system configuration
  • Download and analyze workflows
  • Query events and audit trails
  • Execute GraphQL queries for custom investigations
  • Manage retailers, modules, and blueprints
  • Extract permissions, catalogues, and inventory data

Key points


Profile Management (Account Authentication & Configuration)

`fluent profile list`Purpose: Identify which accounts you have access to on your local machine`fluent profile list`When to Use: Starting an investigation - see what account profiles are configured before connecting to target account.`fluent profile create`Purpose: Set up credentials for a new account that needs investigation`fluent profile create PROFILE --id ACME --base-url https://acme.sandbox.api.fluentretail.com --username acme_admin --password S3CR37 --client-secret abc123-xyz987-s3cr37`When to Use: Received credentials for a new account reporting issues - quickly configure access.`fluent profile export`Purpose: Share account credentials with team members or export for backup`fluent profile export PROFILE --format postman --retailer b2c`When to Use: Need to provide account access to another team member investigating the same issue.

Retailer Investigation

`fluent retailer list`Purpose: Discover all retailers configured across all profiles`fluent retailer list`When to Use: Customer says "Retailer X has an issue" - verify the retailer exists and which profile it belongs to.`fluent retailer create`Purpose: Create a new retailer for testing or replication scenarios`fluent retailer create fc_test --email test@test.com --profile PROFILE --trading-name "Test Retailer" --region AU`When to Use: Need to replicate an issue in a clean retailer environment.

Module Analysis (Configuration & Deployment Investigation)

`fluent module list`Purpose: Verify which modules and versions are installed on an account`fluent module list -p PROFILE`When to Use: Customer reports "Feature X isn't working" - check if the required module is installed and version matches expected behavior.Output Includes:
Module name
Installed version
Installation date
Status
`fluent module describe`Purpose: Inspect module contents before installation or to understand what was deployed`fluent module describe order``fluent module describe order --module-version 1.3.0`When to Use: Need to understand what assets (workflows, rules, settings) are included in a specific module version before troubleshooting.`fluent module config`Purpose: Generate configuration template to see what values a module requires`fluent module config order --retailer b2c --profile PROFILE`When to Use: Module installed but not working properly - review required configuration values that may be missing or misconfigured.

Workflow Investigation (Process Flow Analysis)

`fluent workflow list`Purpose: List all workflows configured for a retailer with version and metadata`fluent workflow list -p PROFILE -r b2c`When to Use: Order processing issue - identify which workflow version is active (ORDER::HD, ORDER::CC, ORDER::MULTI).Common Workflow Types:`ORDER::HD` - Home Delivery`ORDER::CC` - Click & Collect`ORDER::MULTI` - Multi-channel fulfillment`fluent workflow download`Purpose: Export workflow definitions for inspection or comparison`Download specific workflow``fluent workflow download -p PROFILE -r b2c -w ORDER::HD -o ./workflows/``# Download ALL workflows``fluent workflow download -p PROFILE -r b2c -w all -o ./workflows/retailer1/`When to Use:Need to compare workflows between two retailers
Validate workflow structure causing issues
Archive configuration for documentation
`fluent workflow merge`Purpose: Test merging workflow fragments to validate configuration`fluent workflow merge ./my-fragment.json ORDER::HD -p PROFILE -r b2c`When to Use: Investigating if a recent workflow fragment deployment broke existing functionality.

Workflow Log Analysis (Change Tracking & Audit Trail)

`fluent workflowlog list`Purpose: See which workflows have audit logs/change tracking`fluent workflowlog list -p PROFILE -r b2c`When to Use: Determine which workflows have been modified recently.`fluent workflowlog describe`Purpose: View complete history of workflow changes including fragments applied`# View summary of all fragments``fluent workflowlog describe ORDER::HD -p PROFILE -r b2c``# View specific fragment at position 1``fluent workflowlog describe ORDER::HD 1 -p PROFILE -r b2c`When to Use: Order workflow started failing after recent deployment - trace which fragments were applied and when.Output Shows:Fragment deployment timestamp
Applied changes
Deployment operator
Fragment version

Event Investigation (Runtime Execution Analysis)

`fluent event list`Purpose: Query orchestration events for specific entities to troubleshoot execution failures`# List events for specific order``fluent event list --category ruleSet --root-entity-type ORDER --root-entity-id ORD-001 --event-type ORCHESTRATION_AUDIT -p PROFILE``# List events from specific date``fluent event list --category ruleSet --from 2024-01-01T00:00:00.000Z --size 50 -p PROFILE --json``# List fulfilment option events``fluent event list --category ruleSet --root-entity-type FULFILMENT_OPTIONS --root-entity-id FO-001 -p PROFILE`When to Use: Order stuck in "PENDING" status - trace all orchestration events to find where it failed and execution time.Key Event Types:
  • `ORCHESTRATION_AUDIT` - Rule execution events
  • `WORKFLOW_TRANSITION` - Workflow status changes
  • `ERROR` - Exception events

Settings Investigation (Configuration Values)

`fluent setting list`Purpose: List all settings with summary view (name, context, type)`# List all settings``fluent setting list -p PROFILE -r b2c``# Filter by name pattern``fluent setting list -p PROFILE -r b2c --name "%manifest%"``# List account-level settings only``fluent setting list -p PROFILE -r b2c --context account``# Output as JSON for parsing``fluent setting list -p PROFILE -r b2c --json | jq '.'`When to Use: Feature behaving differently across retailers - compare settings to find configuration discrepancies.Common Settings Patterns:`fc.mystique.*` - UI/Frontend settings`fc.carrier.*` - Carrier configuration`fc.fulfillment.*` - Fulfillment rules`fc.security.*` - Security configuration


Practical Investigation Scenarios

Scenario 1: Order Stuck Investigation

Problem: Customer reports order ORD-001 is stuck in "PENDING" status for 2 hours.Investigation Steps:`# Step 1: Verify account and retailer access``fluent profile list``fluent retailer list``# Step 2: Check which order module is installed and version``fluent module list -p PROFILE``# Step 3: Verify active workflow for this retailer``fluent workflow list -p PROFILE -r b2c``# Step 4: Query exact order state and details``fluent gql query --query-file ./get-order.gql --variables '{"ref":"ORD-001"}' -p PROFILE -r b2c --json``# Step 5: Check orchestration events to find where it failed``fluent event list --root-entity-type ORDER --root-entity-id ORD-001 --category ruleSet -p PROFILE --json``# Step 6: Download workflow for detailed analysis``fluent workflow download -p PROFILE -r b2c -w ORDER::HD -o ./investigation/``# Step 7: Check recent workflow changes``fluent workflowlog describe ORDER::HD -p PROFILE -r b2c`What to Look For:
  • Order status and last update timestamp
  • Orchestration event errors
  • Recent workflow fragment deployments
  • Failed rule executions
  • Missing configuration or settings


Scenario 2: Configuration Comparison Between Retailers

Problem: Feature works in Retailer A but not in Retailer B.Investigation Steps:`# Step 1: Download workflows from both retailers``fluent workflow download -p my-profile -r retailer-a -w all -o ./retailer-a/``fluent workflow download -p my-profile -r retailer-b -w all -o ./retailer-b/``# Step 2: Compare workflows``diff -r ./retailer-a/ ./retailer-b/``# Step 3: Export settings from both retailers``fluent setting list -p my-profile -r retailer-a --json > retailer-a-settings.json``fluent setting list -p my-profile -r retailer-b --json > retailer-b-settings.json``# Step 4: Compare settings``diff retailer-a-settings.json retailer-b-settings.json``# Step 5: Get specific setting values``fluent setting get -p my-profile -r retailer-a --name "%feature-name%" --json``fluent setting get -p my-profile -r retailer-b --name "%feature-name%" --json``# Step 6: Check module versions``fluent module list -p my-profile`What to Look For:
  • Workflow differences between retailers
  • Setting value discrepancies
  • Module version differences
  • Missing configuration in retailer B


Scenario 3: Post-Deployment Validation

Problem: Module deployed. Need to verify everything is installed and configured correctly.Investigation Steps:`# Step 1: Verify module was installed``fluent module list -p PROFILE``# Step 2: Check module configuration requirements``fluent module config order --retailer b2c --profile PROFILE``# Step 3: Verify workflow versions are correct``fluent workflow list -p PROFILE -r b2c``# Step 4: Check workflow change history for deployment``fluent workflowlog describe ORDER::HD -p PROFILE -r b2c``# Step 5: Validate all required settings were applied``fluent setting get -p PROFILE -r b2c --name "default:carrier.ref" --json``fluent setting get -p PROFILE -r b2c --name "%manifest%" --json``# Step 6: Test with sample order to ensure workflows execute``fluent gql query --query-file ./test-order.gql -p PROFILE -r b2c --json``# Step 7: Check for deployment events``fluent event list --from $(date -u -d '1 hour ago' +%Y-%m-%dT%H:%M:%S.000Z) --category deployment  -p PROFILE --json`What to Look For:
  • Module installation successful
  • All configuration values present
  • Workflow versions match deployment plan
  • No error events in recent history


Scenario 4: Permission Issues

Problem: User reports they cannot access a specific feature.Investigation Steps:`# Step 1: Extract user permissions``fluent extract userpermissions -p PROFILE -r b2c``# Step 2: Extract role permissions to understand what they should have``fluent extract rolepermissions -p PROFILE -r b2c``# Step 3: Check role assignments``fluent gql query --query 'query { users { edges { node { email roles { name } } } } }' -p PROFILE -r b2c --json``# Step 4: If catalogue-related, check catalogue access``fluent extract catalogues -p PROFILE -r b2c`What to Look For:
  • User role assignment
  • Role permissions vs required permissions
  • Catalogue assignments
  • Context-level restrictions


Essential Commands

Investigation NeedCommand
List available accounts`fluent profile list`
Create new account profile`fluent profile create <name> --id <id> --base-url <url> --username <user> --password <pass> --client-secret <secret>`
Export profile`fluent profile export <profile> --format postman`
List retailers`fluent retailer list`
Check installed modules`fluent module list -p <profile>`
View module contents`fluent module describe <module>`
Get module config template`fluent module config <module> --retailer <retailer> -p <profile>`
List workflows`fluent workflow list -p <profile> -r <retailer>`
Download workflow`fluent workflow download -p <profile> -r <retailer> -w <workflow-name>`
Download all workflows`fluent workflow download -p <profile> -r <retailer> -w all`
Check workflow history`fluent workflowlog describe <workflow> -p <profile> -r <retailer>`
Query orchestration events`fluent event list --root-entity-type <type> --root-entity-id <id> -p <profile>`
Query events by date`fluent event list --from 2024-01-01T00:00:00.000Z -p <profile>`
List settings`fluent setting list -p <profile> -r <retailer>`
Filter settings`fluent setting list -p <profile> -r <retailer> --name "%pattern%"`
Get setting values`fluent setting get -p <profile> -r <retailer> --name "<setting-name>"`
Execute GraphQL query`fluent gql query --query-file <file> -p <profile> -r <retailer>`
Execute inline GraphQL`fluent gql query --query '<query>' -p <profile>`
Check user permissions`fluent extract userpermissions -p <profile> -r <retailer>`
List role permissions`fluent extract rolepermissions -p <profile> -r <retailer>`
List catalogues`fluent extract catalogues -p <profile> -r <retailer>`
List blueprints`fluent blueprint list -p <profile>`