Usage

ubconnect features explorative help pages. Add -h/--help to any command to see the available options. Many commands directly show the help page when executed without any options and arguments.

The following sections show all available (sub-)commands.

ubconnect

ubconnect Usage: ubconnect [OPTIONS] COMMAND [ARGS]... ubConnect CLI for integrating Sphinx-Needs with external systems. ╭─ Options ─────────────────────────────────────────────────────────────────────────╮ │--versionShow the version and exit│ │--install-completionInstall completion for the current shell.│ │--show-completionShow completion for the current shell, to copy it  │ │or customize the installation.                     │ │--helpShow this message and exit.│ ╰───────────────────────────────────────────────────────────────────────────────────╯ ╭─ Commands ────────────────────────────────────────────────────────────────────────╮ │reqif Data exchange with .reqif and .reqifz files                              │ ╰───────────────────────────────────────────────────────────────────────────────────╯

reqif

reqif Usage: ubconnect reqif [OPTIONS] COMMAND [ARGS]... Data exchange with .reqif and .reqifz files ╭─ Options ─────────────────────────────────────────────────────────────────────────╮ │--helpShow this message and exit.│ ╰───────────────────────────────────────────────────────────────────────────────────╯ ╭─ Commands ────────────────────────────────────────────────────────────────────────╮ │to-reqif Convert needs.json to .reqif(z) file                                  │ ╰───────────────────────────────────────────────────────────────────────────────────╯

to-reqif

to-reqif Usage: ubconnect reqif to-reqif [OPTIONS] NEEDSJSON_PATH Convert needs.json to .reqif(z) file ╭─ Arguments ───────────────────────────────────────────────────────────────────────╮ │*needsjson_pathFILEThe path to the needs.json input file[required]│ ╰───────────────────────────────────────────────────────────────────────────────────╯ ╭─ Options ─────────────────────────────────────────────────────────────────────────╮ │--outpath-oPATHThe path to the .reqif(z) output file│ │[default: needs.reqif]               │ │--name-nTEXTThe name of the ReqIfSpecification│ │--reqifz-zWrite the output as .reqifz file│ │--group-types-gtGroup need items to multiple                       │ │specifications/ObjectTypes by need types. If not   │ │enabled, all need items are collected into one     │ │specification/ObjectType.                          │ │--helpShow this message and exit.│ ╰───────────────────────────────────────────────────────────────────────────────────╯ ╭─ License ─────────────────────────────────────────────────────────────────────────╮ │--license-keyTEXT    Use a specific license key.     │ │[env var: UBCONNECT_LICENSE_KEY]│ │--license-userTEXT    Use a specific license user.     │ │[env var: UBCONNECT_LICENSE_USER]│ │--license-stageprod|devUse a specific license stage      │ │[env var: UBCONNECT_LICENSE_STAGE]│ ╰───────────────────────────────────────────────────────────────────────────────────╯ ╭─ Logging ─────────────────────────────────────────────────────────────────────────╮ │--verbose-vShow debug information│ │--quiet-qOnly show errors and warnings│ ╰───────────────────────────────────────────────────────────────────────────────────╯