TIBCO Flogo Commands Reference

This comprehensive reference topic provides detailed information about all TIBCO Flogo commands, their flags, and usage examples.

Commands Overview

The following table lists commands organized into categories:

Command Description Category
flogo:build-info Retrieve comprehensive information for a Flogo application build Build Management
flogo:capability-info Show Flogo Capability info from the data plane Information
flogo:create-build Create a TIBCO Flogo application build Build Management
flogo:delete-app Delete a Flogo app from the data plane Application Management
flogo:delete-build Delete an application build Build Management
flogo:delete-connector Delete a connector from the data plane Connector Management
flogo:delete-flogo-version Delete a provisioned Flogo version from the data plane Version Management
flogo:delete-supplement Delete a connector supplement from the data plane Connector Management
flogo:deploy-app Deploy or upgrade a Flogo application using build Id Deployment
flogo:deploy-app-release Deploy or upgrade a Flogo application helm chart using values.yaml Deployment
flogo:export-build Export Flogo app build from the data plane Build Management
flogo:generate-values-from-build Generate values.yaml from an app build Deployment
flogo:get-app-release-history Release history of an application deployment Application Management
flogo:get-app-release-status Get Flogo helm-managed app release status Application Management
flogo:get-app-release-values Get Flogo helm-managed app release values Application Management
flogo:get-build-status Get Flogo app build status from the data plane Build Management
flogo:import-build Import Flogo app build on the data plane Build Management
flogo:list-app-endpoints List application endpoints for a Flogo app Application Management
flogo:list-app-instances Get a list of application instances for provided app Id Application Management
flogo:list-builds List Flogo app builds from the data plane Build Management
flogo:list-connectors List Flogo Connectors from the data plane Connector Management
flogo:list-flogo-versions List Flogo versions provisioned in the data plane Version Management
flogo:list-supplements List supplements from the data plane Connector Management
flogo:provision-connector Provision Flogo Connector on the data plane Connector Management
flogo:provision-flogo-version Provision Flogo version on the data plane Version Management
flogo:rollback-app-release Roll back an application helm chart release Deployment
flogo:scale-app Scale Flogo app from the data plane Application Management
flogo:update-app Update Flogo application configuration Application Management
flogo:update-app-autoscaling Create, modify, or remove autoscaling configuration Application Management
flogo:update-app-endpoint-visibility Make an application endpoint public or private Application Management
flogo:update-app-release Update helm chart values for Flogo application chart Deployment
flogo:update-app-release-endpoint-visibility Make an application endpoint public or private for helm-managed apps Application Management
flogo:upload-supplement Upload the supplement for a connector on the data plane Connector Management

Available Flags

The following table lists all available flags across commands:

Flag Description Used In Commands Category
--all-values All (computed) values get-app-release-values Output Control
--app-id Flogo application Id delete-app, get-app-release-*, list-app-*, rollback-app-release, scale-app, update-app* Application Management
--arch Target system architecture for app builds create-build Build Configuration
--build-id Application build Id build-info, delete-build, export-build, generate-values-from-build Build Management
--chart-name Flogo application helm chart name deploy-app-release Deployment
--chart-version Flogo application helm chart version deploy-app-release Deployment
--config Path to the local config file All commands Authentication
--connector-id Flogo Connector Id delete-connector, delete-supplement, provision-connector, upload-supplement Connector Management
--count Replica Count scale-app Application Management
--cpurl Control plane url All commands Authentication
-d, --debug Enable debug mode All commands Output Control
--dataplane-id Data plane id All commands Data Plane
--dataplane-name Data plane name All commands Data Plane
--enabled Enable autoscaling update-app-autoscaling Application Management
--eula EULA acceptance deploy-app-release Deployment
--flogo-version Flogo Version create-build Build Configuration
--force Force rollback, default is false rollback-app-release Deployment
--json Format output as JSON All commands (Global Flag) Output Control
--json-payload JSON payload file update-app-autoscaling, update-app-endpoint-visibility, update-app-release-endpoint-visibility Application Management
--namespace Namespace Various app management commands Application Management
--no-warnings Disable warnings from command output All commands Output Control
--os Target OS for app builds create-build Build Configuration
--output-dir Output directory export-build, generate-values-from-build, get-app-release-values Output Control
--profile Select a profile All commands Authentication
--request-json Request payload JSON file create-build Build Configuration
--retain-failed-app Retain application release if failed during deployment deploy-app-release Deployment
--revision Revision number to roll back to rollback-app-release Deployment
--token OAuth token to interact with the TIBCO Platform™ All commands Authentication
--version Version (Flogo or connector) delete-connector, delete-flogo-version, provision-connector, provision-flogo-version Version Management
--visibility App endpoint visibility (public|private) update-app-endpoint-visibility, update-app-release-endpoint-visibility Application Management

Detailed Command Reference

Build Management Commands

flogo:build-info

Retrieve comprehensive information for a Flogo application build, including details such as the operating system, architecture, base version, and build time.

Usage:

Copy 
tibcop flogo:build-info --build-id <value> [flags]

Required Flags:

  • --build-id - Application build Id

Examples:

Copy 
# Get build information
tibcop flogo:build-info --build-id myBuildId

# Get build information in JSON format
tibcop flogo:build-info --build-id myBuildId --json

flogo:get-build-status

Get the build status for a Flogo application from the data plane.

Usage:

Copy 
tibcop flogo:get-build-status --build-id <value> [flags]

Required Flags:

  • --build-id - Flogo app build Id

Examples:

Copy 
# Get build status
tibcop flogo:get-build-status --build-id myBuildId

# Get build status in JSON format
tibcop flogo:get-build-status --build-id myBuildId --json

flogo:create-build

Create a TIBCO Flogo application build. The command expects application (.flogo or .json) file, Flogo base version and build tags as input along with connector dependencies details.

Usage:

Copy 
tibcop flogo:create-build FLOGOAPP [flags]

Arguments:

  • FLOGOAPP - Flogo app file (.flogo or .json) to be used for creating app build

Optional Flags:

  • --flogo-version - Flogo Version
  • --os - Target OS for app build
  • --arch - Target system architecture for app build
  • --request-json - Request payload JSON file

Examples:

Copy 
# Basic build creation
tibcop flogo:create-build myapp.flogo

# Build with specific version and target platform
tibcop flogo:create-build --flogo-version 1.2.0 --os linux --arch amd64 myapp.flogo

# Build with request payload
tibcop flogo:create-build --request-json request.json --flogo-version 1.2.0 myapp.flogo

flogo:delete-build

Delete an application build.

Caution: Ensure the build to be deleted is not used by any application.

Usage:

Copy 
tibcop flogo:delete-build --build-id <value> [flags]

Required Flags:

  • --build-id - Flogo application build Id

Examples:

Copy 
tibcop flogo:delete-build --build-id myBuildId

flogo:export-build

Export Flogo app build from the data plane.

Usage:

Copy 
tibcop flogo:export-build --build-id <value> --output-dir <value> [flags]

Required Flags:

  • --build-id - Flogo application build Id
  • --output-dir - Build output directory

Examples:

Copy 
tibcop flogo:export-build --build-id myBuildId --output-dir ./exports

flogo:import-build

Import Flogo app build on the data plane.

Usage:

Copy 
tibcop flogo:import-build BUILDZIPFILE [flags]

Arguments:

  • BUILDZIPFILE - build zip file to be used for importing Flogo app build

Examples:

Copy 
tibcop flogo:import-build mybuild.zip

flogo:list-builds

List Flogo app builds from the data plane.

Usage:

Copy 
tibcop flogo:list-builds [flags]

Examples:

Copy 
# List all builds
tibcop flogo:list-builds

# List builds in JSON format
tibcop flogo:list-builds --json

flogo:generate-values-from-build

Generate values.yaml from an app build.

Usage:

Copy 
tibcop flogo:generate-values-from-build --build-id <value> --output-dir <value> [flags]

Required Flags:

  • --build-id - Application build Id
  • --output-dir - values.yaml output directory

Examples:

Copy 
tibcop flogo:generate-values-from-build --build-id myBuildId --output-dir ./output

Application Management Commands

flogo:delete-app

Delete a Flogo app from the data plane.

Usage:

Copy 
tibcop flogo:delete-app --app-id <value> [flags]

Required Flags:

  • --app-id - Flogo application Id

Optional Flags:

  • --namespace - Namespace

Examples:

Copy 
# Delete app
tibcop flogo:delete-app --app-id myAppId

# Delete app in specific namespace
tibcop flogo:delete-app --app-id myAppId --namespace mynamespace

flogo:scale-app

Scale Flogo app from the data plane.

Usage:

Copy 
tibcop flogo:scale-app --app-id <value> --count <value> [flags]

Required Flags:

  • --app-id - Flogo application Id
  • --count - Replica Count

Optional Flags:

  • --namespace - Namespace

Examples:

Copy 
# Scale app to 3 replicas
tibcop flogo:scale-app --app-id myAppId --count 3

# Scale app in specific namespace
tibcop flogo:scale-app --app-id myAppId --namespace mynamespace --count 5

flogo:list-app-instances

Get a list of application instances for the provided app Id.

Usage:

Copy 
tibcop flogo:list-app-instances --app-id <value> [flags]

Required Flags:

  • --app-id - Flogo application Id

Examples:

Copy 
# List app instances
tibcop flogo:list-app-instances --app-id myAppId

# List app instances with JSON output
tibcop flogo:list-app-instances --app-id myAppId --json

flogo:list-app-endpoints

List application endpoints for a Flogo app. The API returns details about public/private endpoints and ingress configuration for the public endpoints.

Usage:

Copy 
tibcop flogo:list-app-endpoints --app-id <value> [flags]

Required Flags:

  • --app-id - Flogo application Id

Examples:

Copy 
# List app endpoints
tibcop flogo:list-app-endpoints --app-id myAppId

# List app endpoints in specific namespace
tibcop flogo:list-app-endpoints --app-id myAppId --namespace mynamespace

flogo:get-app-release-history

Release history of an application deployment for an app Id.

Note: This command is applicable only for Flogo helm-managed applications.

Usage:

Copy 
tibcop flogo:get-app-release-history --app-id <value> [flags]

Required Flags:

  • --app-id - Flogo application Id

Examples:

Copy 
# Get release history
tibcop flogo:get-app-release-history --app-id myAppId

# Get release history with JSON output
tibcop flogo:get-app-release-history --app-id myAppId --json

flogo:get-app-release-status

Get Flogo helm-managed app release status from the data plane.

Usage:

Copy 
tibcop flogo:get-app-release-status --app-id <value> [flags]

Required Flags:

  • --app-id - Flogo application Id

Examples:

Copy 
# Get release status
tibcop flogo:get-app-release-status --app-id myAppId

# Get release status in specific namespace
tibcop flogo:get-app-release-status --app-id myAppId --namespace mynamespace

flogo:get-app-release-values

Get Flogo helm-managed app release values from the data plane.

Usage:

Copy 
tibcop flogo:get-app-release-values --app-id <value> --output-dir <value> [flags]

Required Flags:

  • --app-id - Flogo application Id
  • --output-dir - values.yaml output directory

Optional Flags:

  • --all-values - all (computed) values

Examples:

Copy 
# Get release values
tibcop flogo:get-app-release-values --app-id myAppId --output-dir ./output

# Get all computed values
tibcop flogo:get-app-release-values --app-id myAppId --output-dir ./output --all-values

flogo:update-app

Update Flogo application configuration for Flogo provisioner managed application.

Note: The application restarts while applying the configuration.

Usage:

Copy 
tibcop flogo:update-app JSONPAYLOADFILE --app-id <value> [flags]

Arguments:

  • JSONPAYLOADFILE - JSON request payload file to be used for Flogo app deployment

Required Flags:

  • --app-id - App Id to be used for updating the app

Examples:

Copy 
# Update app configuration
tibcop flogo:update-app --app-id myAppId config.json

# Update app in specific namespace
tibcop flogo:update-app --app-id myAppId --namespace mynamespace config.json

flogo:update-app-autoscaling

Create, modify, or remove autoscaling configuration for a Flogo Provisioner managed application. You can provide min/max replicas and CPU/memory thresholds for the HPA resource configuration.

Usage:

Copy 
tibcop flogo:update-app-autoscaling --app-id <value> [flags]

Required Flags:

  • --app-id - App Id to be used for updating the autoscaling config

Optional Flags:

  • --enabled - Enable autoscaling
  • --json-payload - JSON payload file for autoscaling configuration

Examples:

Copy 
# Enable autoscaling
tibcop flogo:update-app-autoscaling --app-id myAppId --enabled

# Configure autoscaling with payload
tibcop flogo:update-app-autoscaling --app-id myAppId --enabled --json-payload autoscaling.json

flogo:update-app-endpoint-visibility

Make an application endpoint public or private for Flogo provisioner managed apps. The API creates an ingress resource with provided inputs - ingress class name, FQDN, path prefix, and so on.

Usage:

Copy 
tibcop flogo:update-app-endpoint-visibility --app-id <value> --visibility public|private [flags]

Required Flags:

  • --app-id - App Id to be used for updating the app
  • --visibility - App endpoint visibility (public|private)

Optional Flags:

  • --json-payload - JSON payload file for public visibility

Examples:

Copy 
# Make endpoint private
tibcop flogo:update-app-endpoint-visibility --app-id myAppId --visibility private

# Make endpoint public with configuration
tibcop flogo:update-app-endpoint-visibility --app-id myAppId --visibility public --json-payload ingress.json

Deployment Commands

flogo:deploy-app

Deploy or upgrade a Flogo application using build Id. The API lets you provide override app properties, engine variables, resource limits for the pod, replicas, or autoscaling configuration and network policy configurations while deploying or upgrading the app.

Important: The app Id field in the payload is mandatory only when upgrading an existing application.

Usage:

Copy 
tibcop flogo:deploy-app JSONPAYLOADFILE --build-id <value> [flags] 

Arguments:

  • JSONPAYLOADFILE - JSON request payload file to be used for Flogo app deployment

Required Flags:

  • --build-id - Application build Id

Optional Flags:

  • --namespace - Namespace

Examples:

Copy 
# Deploy app
tibcop flogo:deploy-app deployment.json --build-id myBuildId 

# Deploy app to specific namespace
tibcop flogo:deploy-app --namespace mynamespace deployment.json --build-id myBuildId

flogo:deploy-app-release

Deploy or upgrade a Flogo application helm chart using values.yaml.

Important: An appId inside values.yaml is mandatory for upgrading an existing application.

Usage:

Copy 
tibcop flogo:deploy-app-release VALUESYAMLFILE --eula [flags]

Arguments:

  • VALUESYAMLFILE - values.yaml file to be used for Flogo app deployment

Required Flags:

  • --eula - EULA acceptance

Optional Flags:

  • --namespace - Namespace
  • --chart-name - Flogo application helm chart name
  • --chart-version - Flogo application helm chart version
  • --retain-failed-app - Retain application release if failed during deployment

Examples:

Copy 
# Basic deployment
tibcop flogo:deploy-app-release --eula values.yaml

# Advanced deployment
tibcop flogo:deploy-app-release --eula --namespace mynamespace --chart-name mychart --chart-version 1.0.0 --retain-failed-app values.yaml

flogo:rollback-app-release

Roll back an application helm chart release for an app Id to the specified revision.

Usage:

Copy 
tibcop flogo:rollback-app-release --app-id <value> --revision <value> [flags]

Required Flags:

  • --app-id - Flogo application Id
  • --revision - Revision number to roll back to

Optional Flags:

  • --force - Force rollback, default is false

Examples:

Copy 
# Rollback to specific revision
tibcop flogo:rollback-app-release --app-id myAppId --revision 2

# Force rollback
tibcop flogo:rollback-app-release --app-id myAppId --revision 2 --force

flogo:update-app-release

Update helm chart values for Flogo application chart using values.yaml.

Usage:

Copy 
tibcop flogo:update-app-release VALUESYAMLFILE --app-id <value> [flags]

Arguments:

  • VALUESYAMLFILE - values.yaml file to be used for Flogo app update

Required Flags:

  • --app-id - Flogo application Id to upgrade

Examples:

Copy 
# Update app release
tibcop flogo:update-app-release --app-id myAppId values.yaml

# Update app release in specific namespace
tibcop flogo:update-app-release --app-id myAppId --namespace mynamespace values.yaml

flogo:update-app-release-endpoint-visibility

Make an application endpoint public or private for helm-managed apps. The API creates an ingress resource with provided inputs - ingress class name, FQDN, path prefix, and so on.

Usage:

Copy 
tibcop flogo:update-app-release-endpoint-visibility --app-id <value> --visibility public|private [flags]

Required Flags:

  • --app-id - App Id to be used for updating the app
  • --visibility - App endpoint visibility (public|private)

Optional Flags:

  • --json-payload - JSON payload file for public visibility

Examples:

Copy 
# Make helm app endpoint private
tibcop flogo:update-app-release-endpoint-visibility --app-id myAppId --visibility private

# Make helm app endpoint public
tibcop flogo:update-app-release-endpoint-visibility --app-id myAppId --visibility public --json-payload ingress.json

Connector Management Commands

flogo:provision-connector

Provision a Flogo Connector on the data plane.

Usage:

Copy 
tibcop flogo:provision-connector --connector-id <value> --version <value> [flags]

Required Flags:

  • --connector-id - Connector Id
  • --version - Connector Version

Examples:

Copy 
tibcop flogo:provision-connector --connector-id myConnector --version 1.0.0

flogo:delete-connector

Delete a connector from the data plane.

Caution: Ensure the connector to be deleted is not used in any application or build.

Usage:

Copy 
tibcop flogo:delete-connector --version <value> --connector-id <value> [flags]

Required Flags:

  • --connector-id - Flogo Connector Id
  • --version - Flogo Connector Version

Examples:

Copy 
tibcop flogo:delete-connector --connector-id myConnector --version 1.0.0

flogo:list-connectors

List Flogo Connectors from the data plane.

Usage:

Copy 
tibcop flogo:list-connectors [flags]

Examples:

Copy 
# List all connectors
tibcop flogo:list-connectors

# List connectors in JSON format
tibcop flogo:list-connectors --json

# List all flogo connectors including non-provisioned connectors
tibcop flogo:list-connectors --all

flogo:upload-supplement

Upload the supplement for a connector on the data plane.

Usage:

Copy 
tibcop flogo:upload-supplement SUPPLEMENTFILE --connector-id <value> [flags]

Arguments:

  • SUPPLEMENTFILE - supplement file for the connector to be used for Flogo app build

Required Flags:

  • --connector-id - Connector Id

Examples:

Copy 
tibcop flogo:upload-supplement --connector-id myConnector supplement.zip

flogo:delete-supplement

Delete a connector supplement from the data plane.

Caution: Ensure the supplement to be deleted is not used in any application or build.

Usage:

Copy 
tibcop flogo:delete-supplement --connector-id <value> [flags]

Required Flags:

  • --connector-id - Flogo Connector Id

Examples:

Copy 
tibcop flogo:delete-supplement --connector-id myConnector

flogo:list-supplements

List supplements from the data plane.

Usage:

Copy 
tibcop flogo:list-supplements [flags]

Examples:

Copy 
# List all supplements
tibcop flogo:list-supplements

# List supplements in JSON format
tibcop flogo:list-supplements --json

Version Management Commands

flogo:provision-flogo-version

Provision Flogo version on the data plane.

Usage:

Copy 
tibcop flogo:provision-flogo-version --version <value> [flags]

Required Flags:

  • --version - Flogo Version

Examples:

Copy 
tibcop flogo:provision-flogo-version --version 1.2.0

flogo:delete-flogo-version

Delete a provisioned Flogo version from the data plane.

Caution:

Ensure the Flogo version to be deleted is not used by any application or build.

Usage:

Copy 
tibcop flogo:delete-flogo-version --version <value> [flags]

Required Flags:

  • --version - Flogo Version

Examples:

Copy 
tibcop flogo:delete-flogo-version --version 1.2.0

flogo:list-flogo-versions

List Flogo versions provisioned in the data plane.

Usage:

Copy 
tibcop flogo:list-flogo-versions [flags]

Examples:

Copy 
# List all Flogo versions
tibcop flogo:list-flogo-versions

# List Flogo versions in JSON format
tibcop flogo:list-flogo-versions --json

# List all Flogo versions including non-provisioned versions from the control plane
tibcop flogo:list-flogo-versions --all

Information Commands

flogo:capability-info

Show Flogo Capability info from the data plane.

Usage:

Copy 
tibcop flogo:capability-info [flags]

Examples:

Copy 
# Get capability info
tibcop flogo:capability-info

# Get capability info in JSON format
tibcop flogo:capability-info --json

Common Flag Usage Patterns

Authentication Flags

All commands support these authentication options:

  • --config - Use local config file
  • --profile - Use specific profile
  • --cpurl and --token - Direct authentication
  • --dataplane-name or --dataplane-id - Specify target data plane

Output Control Flags

  • --json - Format output as JSON (available on all commands)
  • --no-warnings - Suppress warning messages
  • --debug - Enable debug output

Example Authentication Usage

Copy 
# Using profile
tibcop flogo:list-builds --profile production

# Using direct authentication
tibcop flogo:list-builds --cpurl https://api.example.com --token mytoken

# Using config file and specific dataplane
tibcop flogo:list-builds --config ./config.yaml --dataplane-name prod-dp

Best Practices

  1. Always specify the data plane when working with multiple environments.
  2. Use profiles for different environments to avoid repeating authentication flags.
  3. Enable JSON output when integrating with scripts or automation tools.
  4. Use namespaces to organize applications in multi-tenant environments.
  5. Check build status before deploying applications.
  6. Verify that EULA acceptance is available before using helm deployment commands.
  7. Ensure that dependencies are not in use before deleting builds, connectors, or versions.

Troubleshooting

Common Issues

  1. Authentication failures: Ensure that tokens are valid and have proper permissions.
  2. Data plane connectivity: Verify that the data plane is accessible and running.
  3. Resource conflicts: Check if resources are in use before deletion.
  4. Namespace issues: Ensure that the namespace exists and you have access rights.
  5. EULA acceptance: Required for helm deployment commands.

Debug Commands

Use the --debug flag with any command to get detailed execution information:

Copy 
tibcop flogo:list-builds --debug

Getting Help

For detailed help on any command, use:

Copy 
tibcop flogo:<command> --help