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 ────────────────────────────────────────────────────────────────────────╮ │from-reqif Convert reqif(z) to needs.json                                      │ │to-reqif   Convert needs.json to .reqif(z)                                     │ ╰───────────────────────────────────────────────────────────────────────────────────╯

from-reqif

from-reqif Usage: ubconnect reqif from-reqif [OPTIONS] [REQIF_PATH] Convert reqif(z) to needs.json ╭─ Arguments ───────────────────────────────────────────────────────────────────────╮ │reqif_path[REQIF_PATH]The path to the reqif(z) input file│ │[default: None]                    │ ╰───────────────────────────────────────────────────────────────────────────────────╯ ╭─ Options ─────────────────────────────────────────────────────────────────────────╮ │--config-cFILEPath to the TOML configuration file[default: None]│ │--reqifz-zIndicates that the input file is a .reqifz (zipped)  │ │file                                                 │ │--outdir-oPATHThe output directory for generated files.│ │[default: None]                          │ │--id-prefix-pTEXTPrefix for need IDs.│ │--back-links-bEnable backlink generation.│ │--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│ ╰───────────────────────────────────────────────────────────────────────────────────╯

to-reqif

to-reqif Usage: ubconnect reqif to-reqif [OPTIONS] [NEEDSJSON_PATH] Convert needs.json to .reqif(z) ╭─ Arguments ───────────────────────────────────────────────────────────────────────╮ │needsjson_path[NEEDSJSON_PATH]The path to the needs.json input file│ │[default: None]                      │ ╰───────────────────────────────────────────────────────────────────────────────────╯ ╭─ Options ─────────────────────────────────────────────────────────────────────────╮ │--config-cFILEPath to the TOML configuration file[default: None]│ │--outpath-oPATHThe path to the .reqif(z) output file.│ │[default: None]                       │ │--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.                          │ │--prefix-pTEXTThe prefix for ReqIfSpecification.│ │--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│ ╰───────────────────────────────────────────────────────────────────────────────────╯