Skip to main content

Command Reference

Available Commands

flowon-dynamics <command> [options]

Commands:
f, features Lists Installed FlowOn Features
p, projects Lists FlowOn Projects
e, export Exports Dynamics 365 Artifacts
i, import Imports Dynamics 365 Artifacts
gm, generate-mappings Generate Data Mapping Files
openapi, generate-openapi Generate OpenApi Schema
ep, enable-plugins Enables FlowOn Plugins
dp, disable-plugins Disables FlowOn Plugins
er, enable-recipe Enables a Logic Recipe
dr, disable-recipe Disables a Logic Recipe
isv, increment-solution-version Increments Dynamics 365 Solution Version
d, docs Generate Documentation
am, apply-mappings Apply Data Mapping Files
pa, publish-api Publish an Api Version
cp, create-patch Creates a new solution patch

Options:
-?, -h, --help Show help and usage information
--version Show version information
Options are per command

Logic Fabric CLI does not use shared global options. Every command declares its own -c, --connectionstring and -l, --log-level options where applicable, so they are shown per command below. -h/--help and --version are the only options handled at the root.

Common Options

Most commands accept the following two options:

OptionAliasRequiredDescription
--connectionstring-cYesThe connection string for Dynamics 365
--log-level-lNoLogging verbosity: None (default), Info, Verbose

The generate-mappings and docs commands work against a local .flop package and therefore do not take a --connectionstring.

Command Categories

CategoryCommandsPurpose
Discoveryfeatures, projectsList available Logic Fabric components
Export/Importexport, importMove artifacts between environments
Mappinggenerate-mappings, apply-mappingsHandle environment-specific data
Generationgenerate-openapi, docsGenerate documentation and schemas
Plugin Controlenable-plugins, disable-pluginsManage plugin registration
Recipe Controlenable-recipe, disable-recipeManage Logic Recipe activation
API Lifecyclepublish-apiPublish a draft API version
Versioningincrement-solution-version, create-patchManage solution versions and patches

Discovery Commands

List Features

Lists all installed Logic Fabric features in the connected environment.

flowon-dynamics features [options]

Options:
-c, --connectionstring <string> Connection string for Dynamics 365 (required)
-l, --log-level <level> None | Info | Verbose (default: None)

List Projects

Lists all Logic Fabric projects in the connected environment.

flowon-dynamics projects [options]

Options:
-c, --connectionstring <string> Connection string for Dynamics 365 (required)
-l, --log-level <level> None | Info | Verbose (default: None)

Plugin Management

Enable Plugins

Enables all Logic Fabric plugins in the connected environment.

flowon-dynamics enable-plugins [options]

Options:
-c, --connectionstring <string> Connection string for Dynamics 365 (required)
-l, --log-level <level> None | Info | Verbose (default: None)

Example:

flowon-dynamics enable-plugins --connectionstring "$CONNECTION_STRING"

Disable Plugins

Disables all Logic Fabric plugins in the connected environment.

flowon-dynamics disable-plugins [options]

Options:
-c, --connectionstring <string> Connection string for Dynamics 365 (required)
-l, --log-level <level> None | Info | Verbose (default: None)

Example:

# Disable plugins before data migration
flowon-dynamics disable-plugins --connectionstring "$CONNECTION_STRING"

# Perform data migration...

# Re-enable plugins
flowon-dynamics enable-plugins --connectionstring "$CONNECTION_STRING"
Environment-wide operation

enable-plugins and disable-plugins operate on all Logic Fabric plugins in the connected environment. They do not accept a project or individual plugin filter.


Recipe Management

Enable Recipe

Enables one or more Logic Recipes for a Logic Fabric project.

flowon-dynamics enable-recipe [options]

Options:
-c, --connectionstring <string> Connection string for Dynamics 365 (required)
-p, --project <name> Logic Fabric project associated with the recipe (required)
-r, --recipe <name> Recipe(s) to enable, space-separated (required)
-l, --log-level <level> None | Info | Verbose (default: None)

Example:

flowon-dynamics enable-recipe \
--connectionstring "$CONNECTION_STRING" \
--project "CustomerPortal" \
--recipe "OrderProcessing"

Disable Recipe

Disables one or more Logic Recipes for a Logic Fabric project.

flowon-dynamics disable-recipe [options]

Options:
-c, --connectionstring <string> Connection string for Dynamics 365 (required)
-p, --project <name> Logic Fabric project associated with the recipe (required)
-r, --recipe <name> Recipe(s) to disable, space-separated (required)
-l, --log-level <level> None | Info | Verbose (default: None)

Example:

flowon-dynamics disable-recipe \
--connectionstring "$CONNECTION_STRING" \
--project "CustomerPortal" \
--recipe "LegacyWorkflow"
Multiple recipes

--recipe accepts multiple values per token, so you can enable or disable several recipes at once: --recipe "OrderProcessing" "Notifications".


Solution Versioning

Increment Solution Version

Increments the version of a Dynamics 365 solution using a version increment strategy.

flowon-dynamics increment-solution-version [options]

Options:
-c, --connectionstring <string> Connection string for Dynamics 365 (required)
-s, --solution <name> Dynamics 365 solution unique name (required)
-v, --version <strategy> Increment strategy: Major | Minor | Revision | Build (required)
-l, --log-level <level> None | Info | Verbose (default: None)

The --version option takes a strategy value, not a version number:

StrategyEffect (example)
Major1.0.0.02.0.0.0
Minor1.0.0.01.1.0.0
Build1.0.0.01.0.1.0
Revision1.0.0.01.0.0.1

Examples

# Increment minor version for a feature release
flowon-dynamics increment-solution-version \
--connectionstring "$CONNECTION_STRING" \
--solution "CustomerPortal" \
--version Minor

# Increment build version for bug fixes
flowon-dynamics increment-solution-version \
--connectionstring "$CONNECTION_STRING" \
--solution "CustomerPortal" \
--version Build

Create Solution Patch

Creates a new patch for an existing Dynamics 365 solution.

flowon-dynamics create-patch [options]

Options:
-c, --connectionstring <string> Connection string for Dynamics 365 (required)
-sn, --solution-name <name> Unique name of the solution to patch (required)
-pn, --patch-name <name> Display name of the solution patch (required)
-v, --version <version> Version of the patch (optional, e.g. 1.0.1.0)
-l, --log-level <level> None | Info | Verbose (default: None)

Example

flowon-dynamics create-patch \
--connectionstring "$CONNECTION_STRING" \
--solution-name "CustomerPortal" \
--patch-name "CustomerPortal Hotfix" \
--version "1.0.1.0"

API Lifecycle

Publish API Version

Publishes the current draft version of a Logic Fabric API as a new major or minor version.

flowon-dynamics publish-api [options]

Options:
-c, --connectionstring <string> Connection string for Dynamics 365 (required)
-p, --project <name> Logic Fabric project (required)
-a, --api <name> FlowOn API to publish (required)
-v, --version <mode> Version to publish: Major | Minor (default: Major)
-l, --log-level <level> None | Info | Verbose (default: None)

Example

flowon-dynamics publish-api \
--connectionstring "$CONNECTION_STRING" \
--project "CustomerPortal" \
--api "CustomerPortalAPI" \
--version Major

OpenAPI Generation

Generate the OpenAPI (Swagger) schema for a Logic Fabric API.

flowon-dynamics generate-openapi [options]

Options:
-c, --connectionstring <string> Connection string for Dynamics 365 (required)
-p, --project-name <name> Logic Fabric project associated with the API (required)
-a, --api <name> FlowOn API name (required)
-v, --version <version> API version to generate (optional, latest if omitted)
-o, --output-directory <path> Output directory for the schema file (required)
-l, --log-level <level> None | Info | Verbose (default: None)

Example

flowon-dynamics generate-openapi \
--connectionstring "$CONNECTION_STRING" \
--project-name "CustomerPortal" \
--api "CustomerPortalAPI" \
--output-directory "./docs" \
--version "1.0"

The schema is written to the output directory as <ApiName>.json (spaces in the API name are replaced with underscores). When --version is omitted, the latest published version is used. Output is always JSON.


Documentation Generation

Generate documentation from a Flowon .flop package. This command works against a local package file and does not connect to Dynamics 365.

flowon-dynamics docs [options]

Options:
-p, --package-file-path <path> Path to the .flop package file (required)
-o, --output-directory <path> Output directory for documentation (required)
-l, --log-level <level> None | Info | Verbose (default: None)

Example

flowon-dynamics docs \
--package-file-path "./artifacts/flowon/CustomerPortal.flop" \
--output-directory "./docs"