docscli
Last edit November 19, 2024

CLI

The Command Line Interface (CLI) provides commands to interact with our products and perform various operations.

Linux
MacOs
Window
***

diphyx

It provides various commands to interact with DiPhyx product.

shell
Usage:
  diphyx [command]

Available Commands:
  info        View diphyx CLI information
  login       Login to the DiPhyx platforms
  dashboard   Open the DiPhyx platform dashboard
  logout      Logout from the DiPhyx platform
  update      Update diphyx CLI to the latest version
  dxflow      dxflow command line interface
  help        Help about any command
  completion  Generate the autocompletion script for the specified shell

Flags:
      --no-color   disable color output
  -h, --help       help for diphyx
  -v, --version    version for diphyx

Tip

The DiPhyx CLI includes the dxflow product CLI as a subcommand with extended features.

***

dxflow

It provides various commands to interact with dxflow product.

shell
Usage:
  dxflow [command]

Available Commands:
  info        View dxflow CLI information
  up          Start the dxflow core and extension services
  down        Stop the dxflow core and extension services
  login       Login to the dxflow platform
  search      Search over published flows
  inspect     Inspect published flow variables
  compose     Compose published flow with variables
  run         Run a flow
  projects    List of projects and manage them
  session     Open interactive session
  logout      Logout from the dxflow platform
  update      Update dxflow CLI to the latest version
  help        Help about any command
  completion  Generate the autocompletion script for the specified shell

Flags:
      --no-color   disable color output
  -h, --help       help for dxflow
  -v, --version    version for dxflow