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                           │ │jama     Data exchange with Jama Connect                                       │ │csv      Data exchange with CSV files                                          │ │doors-ng Data exchange with IBM DOORS Next Generation                          │ ╰───────────────────────────────────────────────────────────────────────────────────╯

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 or RST                               │ │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 or RST ╭─ Arguments ───────────────────────────────────────────────────────────────────────╮ │reqif_path[REQIF_PATH]The path to the reqif(z) input file│ ╰───────────────────────────────────────────────────────────────────────────────────╯ ╭─ Options ─────────────────────────────────────────────────────────────────────────╮ │--config-cFILEPath to the TOML configuration file│ │--reqifz-zIndicates that the input file is a .reqifz        │ │(zipped) file                                     │ │--outdir-oPATHThe output directory for generated files.│ │--id-prefix-pTEXTPrefix for need IDs.│ │--back-links-bEnable backlink generation.│ │--output-format-fTEXTOutput format: 'json' (default) or 'rst'.│ │--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│ ╰───────────────────────────────────────────────────────────────────────────────────╯ ╭─ Options ─────────────────────────────────────────────────────────────────────────╮ │--config-cFILE              Path to the TOML configuration  │ │file                            │ │--outpath-oPATH              The path to the .reqif(z) output│ │file.                           │ │--name-nTEXT              The 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-pTEXT              The prefix for                  │ │ReqIfSpecification.             │ │--alm-tool[doors|codebeamer]Target ALM tool. Affects field  │ │mappings (e.g., title field).   │ │--section-typeTEXT              The long name for               │ │ReqIFSpecObjectType used for    │ │sections (headings)             │ │--import-dateAdd an 'import_date' Date       │ │attribute to every spec-object  │ │with the current datetime.      │ │--html-dirDIRECTORY         Path to the Sphinx HTML build   │ │output directory. Enables HTML  │ │content extraction.             │ │--target-image-dirTEXT              Target directory name for images│ │inside the ReqIFz archive       │ │(requires --html-dir and        │ │--reqifz).                      │ │--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│ ╰───────────────────────────────────────────────────────────────────────────────────╯

jama

jama Usage: ubconnect jama [OPTIONS] COMMAND [ARGS]... Data exchange with Jama Connect ╭─ Options ─────────────────────────────────────────────────────────────────────────╮ │--helpShow this message and exit.│ ╰───────────────────────────────────────────────────────────────────────────────────╯ ╭─ Commands ────────────────────────────────────────────────────────────────────────╮ │from-jama  Import requirements from Jama Connect                               │ │to-jama    Export requirements to Jama Connect                                 │ │list-types List available item types from Jama instance                        │ │check      Check if connection to Jama is possible with provided credentials   │ ╰───────────────────────────────────────────────────────────────────────────────────╯

from-jama

from-jama Usage: ubconnect jama from-jama [OPTIONS] Import requirements from Jama Connect ╭─ Options ─────────────────────────────────────────────────────────────────────────╮ │--config-cFILEPath to the TOML configuration file│ │--urlTEXTJama Connect instance URL (env: JAMA_URL)│ │[env var: JAMA_URL]                      │ │--usernameTEXTJama Connect username or client ID (env:          │ │JAMA_USERNAME)                                    │ │[env var: JAMA_USERNAME]                          │ │--passwordTEXTJama Connect password or client secret (env:      │ │JAMA_PASSWORD)                                    │ │[env var: JAMA_PASSWORD]                          │ │--project-idTEXTJama project ID (can be numeric string ID or a    │ │project key like 'FVC'). (env: JAMA_PROJECT_ID)   │ │[env var: JAMA_PROJECT_ID]                        │ │--outdir-oPATHOutput directory for generated files│ │--id-prefix-pTEXTPrefix for need IDs│ │--oauthUse OAuth authentication (required for API        │ │credentials)                                      │ │--no-ssl-verifyDisable SSL certificate verification (for         │ │self-signed certificates)                         │ │--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-jama

to-jama Usage: ubconnect jama to-jama [OPTIONS] [NEEDSJSON_PATH] Export requirements to Jama Connect ╭─ Arguments ───────────────────────────────────────────────────────────────────────╮ │needsjson_path[NEEDSJSON_PATH]Path to needs.json file│ ╰───────────────────────────────────────────────────────────────────────────────────╯ ╭─ Options ─────────────────────────────────────────────────────────────────────────╮ │--config-cFILEPath to the TOML configuration file│ │--urlTEXTJama Connect instance URL (env: JAMA_URL)│ │[env var: JAMA_URL]                      │ │--usernameTEXTJama Connect username or client ID (env:          │ │JAMA_USERNAME)                                    │ │[env var: JAMA_USERNAME]                          │ │--passwordTEXTJama Connect password or client secret (env:      │ │JAMA_PASSWORD)                                    │ │[env var: JAMA_PASSWORD]                          │ │--project-idTEXTJama project ID (can be numeric string ID or a    │ │project key like 'FVC'). (env: JAMA_PROJECT_ID)   │ │[env var: JAMA_PROJECT_ID]                        │ │--dry-runSimulate operations without making changes to Jama│ │--oauthUse OAuth authentication (required for API        │ │credentials)                                      │ │--no-ssl-verifyDisable SSL certificate verification (for         │ │self-signed certificates)                         │ │--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│ ╰───────────────────────────────────────────────────────────────────────────────────╯

list-types

list-types Usage: ubconnect jama list-types [OPTIONS] List available item types from Jama instance ╭─ Options ─────────────────────────────────────────────────────────────────────────╮ │--config-cFILEPath to the TOML configuration file│ │--urlTEXTJama Connect instance URL (env: JAMA_URL)│ │[env var: JAMA_URL]                      │ │--usernameTEXTJama Connect username or client ID (env:          │ │JAMA_USERNAME)                                    │ │[env var: JAMA_USERNAME]                          │ │--passwordTEXTJama Connect password or client secret (env:      │ │JAMA_PASSWORD)                                    │ │[env var: JAMA_PASSWORD]                          │ │--oauthUse OAuth authentication (required for API        │ │credentials)                                      │ │--no-ssl-verifyDisable SSL certificate verification (for         │ │self-signed certificates)                         │ │--format-fTEXTOutput format: table, json, or csv│ │[default: table]                  │ │--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│ ╰───────────────────────────────────────────────────────────────────────────────────╯

check

check Usage: ubconnect jama check [OPTIONS] Check if connection to Jama is possible with provided credentials ╭─ Options ─────────────────────────────────────────────────────────────────────────╮ │--config-cFILEPath to the TOML configuration file│ │--urlTEXTJama Connect instance URL (env: JAMA_URL)│ │[env var: JAMA_URL]                      │ │--usernameTEXTJama Connect username or client ID (env:          │ │JAMA_USERNAME)                                    │ │[env var: JAMA_USERNAME]                          │ │--passwordTEXTJama Connect password or client secret (env:      │ │JAMA_PASSWORD)                                    │ │[env var: JAMA_PASSWORD]                          │ │--oauthUse OAuth authentication (required for API        │ │credentials)                                      │ │--no-ssl-verifyDisable SSL certificate verification (for         │ │self-signed certificates)                         │ │--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│ ╰───────────────────────────────────────────────────────────────────────────────────╯

csv

csv Usage: ubconnect csv [OPTIONS] COMMAND [ARGS]... Data exchange with CSV files ╭─ Options ─────────────────────────────────────────────────────────────────────────╮ │--helpShow this message and exit.│ ╰───────────────────────────────────────────────────────────────────────────────────╯ ╭─ Commands ────────────────────────────────────────────────────────────────────────╮ │from-csv Import .csv file to needs.json                                        │ │to-csv   Export needs.json to CSV                                              │ ╰───────────────────────────────────────────────────────────────────────────────────╯

from-csv

from-csv Usage: ubconnect csv from-csv [OPTIONS] [CSV_PATH] Import .csv file to needs.json ╭─ Arguments ───────────────────────────────────────────────────────────────────────╮ │csv_path[CSV_PATH]Path to CSV file│ ╰───────────────────────────────────────────────────────────────────────────────────╯ ╭─ Options ─────────────────────────────────────────────────────────────────────────╮ │--config-cFILEPath to the TOML configuration file│ │--outdir-oPATHOutput directory for generated files│ │--id-prefix-pTEXTPrefix for need IDs│ │--delimiterTEXTDelimiter used in the CSV file│ │--encodingTEXTEncoding used in the CSV file│ │--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-csv

to-csv Usage: ubconnect csv to-csv [OPTIONS] [NEEDSJSON_PATH] Export needs.json to CSV ╭─ Arguments ───────────────────────────────────────────────────────────────────────╮ │needsjson_path[NEEDSJSON_PATH]Path to needs.json file│ ╰───────────────────────────────────────────────────────────────────────────────────╯ ╭─ Options ─────────────────────────────────────────────────────────────────────────╮ │--config-cFILEPath to the TOML configuration file│ │--outpath-oPATHOutput CSV file path│ │--delimiterTEXTDelimiter used in the CSV file│ │--encodingTEXTEncoding used in the CSV file│ │--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│ ╰───────────────────────────────────────────────────────────────────────────────────╯

doors-ng

doors-ng Usage: ubconnect doors-ng [OPTIONS] COMMAND [ARGS]... Data exchange with IBM DOORS Next Generation ╭─ Options ─────────────────────────────────────────────────────────────────────────╮ │--helpShow this message and exit.│ ╰───────────────────────────────────────────────────────────────────────────────────╯ ╭─ Commands ────────────────────────────────────────────────────────────────────────╮ │from-doors-ng Import requirements from IBM DOORS Next Generation               │ ╰───────────────────────────────────────────────────────────────────────────────────╯

from-doors-ng

from-doors-ng Usage: ubconnect doors-ng from-doors-ng [OPTIONS] Import requirements from IBM DOORS Next Generation ╭─ Options ─────────────────────────────────────────────────────────────────────────╮ │*--config-cFILEPath to the TOML configuration file[required]│ │--hostTEXTDOORS NG server URL (env: DOORS_NG_HOST)│ │[env var: DOORS_NG_HOST]                │ │--usernameTEXTDOORS NG username (env: DOORS_NG_USERNAME)│ │[env var: DOORS_NG_USERNAME]              │ │--passwordTEXTDOORS NG password (env: DOORS_NG_PASSWORD)│ │[env var: DOORS_NG_PASSWORD]              │ │--outdir-oPATHOutput directory for generated needs.json│ │--id-prefix-pTEXTPrefix for need IDs (default: DOORS_)│ │--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│ ╰───────────────────────────────────────────────────────────────────────────────────╯