Introduction

Our Command Line Interface (CLI) provides a unified method for interacting with all of our product offerings.

Command structure breakdown

Commands within the CLI adhere to the following format:

cyphor <command> <sub-command> [action] <arguments> [--optional parameters]

  • The base call to the cyphor CLI.

  • Primary command (<command>): Targets a specific area of functionality.

  • Sub-Command (<sub-command>): Narrows down the operation to a specific area or task.

  • Action ([action]): The operation to execute on the chosen feature.

  • Mandatory options or parameters (<arguments>): Required settings that must be provided in the stated order.

  • Optional parameters ([--options]): Additional parameters that might not be crucial for every operation. These are prefixed with -- and can be specified in any sequence after mandatory arguments.

PreviousAlert InsightsNextGlobal options

Last updated