Skip to main content

Command Reference

Available Commands​

flowon <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
  generate-mappings, gm            Generate Data Mapping Files
  generate-openapi, openapi        Generate OpenAPI Schema
  enable-plugins, ep               Enables FlowOn Plugins
  disable-plugins, dp              Disables FlowOn Plugins
  enable-recipe, er                Enables a Logic Recipe
  disable-recipe, dr               Disables a Logic Recipe
  increment-solution-version, isv  Increments Dynamics 365 Solution Version
  d, docs                          Generate Documentation
  am, apply-mappings               Apply Data Mapping Files

Global Options:
  -c, --connection <string>        Connection string or config file
  -v, --verbose                    Enable verbose output
  -h, --help                       Show help information
  --version                        Show version information

Command Categories​

CategoryCommandsPurpose
Discoveryfeatures, projectsList available FlowOn 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
Versioningincrement-solution-versionManage solution versions

Discovery Commands​

List Features​

Lists all installed FlowOn features in the connected environment.

flowon features [options]

Options:
  -c, --connection <string>       Connection string

List Projects​

Lists all FlowOn projects in the connected environment.

flowon projects [options]

Options:
  -c, --connection <string>       Connection string

Plugin Management​

Enable Plugins​

flowon enable-plugins [options]

Options:
  -p, --project <name>            FlowOn project name
  --all                           Enable all plugins
  --plugin <name>                 Specific plugin to enable
  -c, --connection <string>       Connection string

Example:

flowon enable-plugins --project "CustomerPortal" --all

Disable Plugins​

flowon disable-plugins [options]

Options:
  -p, --project <name>            FlowOn project name
  --all                           Disable all plugins
  --plugin <name>                 Specific plugin to disable
  -c, --connection <string>       Connection string

Example:

# Disable plugins before data migration
flowon disable-plugins --project "CustomerPortal" --all

# Perform data migration...

# Re-enable plugins
flowon enable-plugins --project "CustomerPortal" --all

Recipe Management​

Enable Recipe​

flowon enable-recipe [options]

Options:
  -p, --project <name>            FlowOn project name
  -r, --recipe <name>             Recipe name to enable
  --all                           Enable all recipes
  -c, --connection <string>       Connection string

Example:

flowon enable-recipe --project "CustomerPortal" --recipe "OrderProcessing"

Disable Recipe​

flowon disable-recipe [options]

Options:
  -p, --project <name>            FlowOn project name
  -r, --recipe <name>             Recipe name to disable
  --all                           Disable all recipes
  -c, --connection <string>       Connection string

Example:

flowon disable-recipe --project "CustomerPortal" --recipe "LegacyWorkflow"

Solution Versioning​

Increment Version Command​

flowon increment-solution-version [options]

Options:
  -s, --solution <name>           Solution name
  --major                         Increment major version (1.0.0.0 → 2.0.0.0)
  --minor                         Increment minor version (1.0.0.0 → 1.1.0.0)
  --build                         Increment build version (1.0.0.0 → 1.0.1.0)
  --revision                      Increment revision (1.0.0.0 → 1.0.0.1)
  --version <version>             Set specific version
  -c, --connection <string>       Connection string

Examples​

# Increment minor version for feature release
flowon increment-solution-version \
  --solution "CustomerPortal" \
  --minor

# Increment build version for bug fixes
flowon increment-solution-version \
  --solution "CustomerPortal" \
  --build

# Set specific version
flowon increment-solution-version \
  --solution "CustomerPortal" \
  --version "2.0.0.0"

OpenAPI Generation​

Generate OpenAPI (Swagger) schema for FlowOn APIs.

flowon generate-openapi [options]

Options:
  -p, --project <name>            FlowOn project name
  -a, --api <name>                FlowOn API name
  -o, --output <path>             Output file path
  -f, --format <format>           Output format: json, yaml
  --version <version>             API version to generate
  -c, --connection <string>       Connection string

Example​

flowon generate-openapi \
  --project "CustomerPortal" \
  --api "CustomerPortalAPI" \
  --output "./docs/openapi.json" \
  --format json \
  --version "1.0"

Generated Output​

The command generates a complete OpenAPI 3.0 specification including:

  • All endpoints (queries, actions, process actions)
  • Request/response schemas
  • Authentication requirements
  • Parameter definitions
  • Error responses

Documentation Generation​

Generate documentation for FlowOn projects.

flowon docs [options]

Options:
  -p, --project <name>            FlowOn project name
  -o, --output <path>             Output directory
  -f, --format <format>           Format: markdown, html
  --include-diagrams              Generate visual diagrams
  -c, --connection <string>       Connection string

Example​

flowon docs \
  --project "CustomerPortal" \
  --output "./docs" \
  --format markdown \
  --include-diagrams

Generated Documentation​

  • Logic Block documentation
  • Flow diagrams
  • API endpoint reference
  • BPM process documentation
  • Entity relationship diagrams