AI and scripting for CLI
relman CLI command overview
Every command follows the same shape: relman [flags] <verb> <noun> [arguments...]. Required flags are --domain/-d (the server) and --cert/-i (a PKCS#12 client certificate for mutual TLS); optional flags are --cert-password/-p, --format/-f (yaml [default], json, xml, or plain), --verbose/-v, and --help/-h. Most tokens returned by a list/describe/add command are opaque identifiers, not real database ids, and are usually only unique within their immediate parent – pass the whole chain of tokens a command asks for, from the top down. Run relman completion bash or relman completion powershell to install shell tab-completion.
Organizations, project groups & projects
| Command | Aliases | Description |
|---|---|---|
list organizations | orgs | List every organization you have access to. |
list projectgroups <org> | pg, pgs | List an organization’s project groups. |
list projects <org> <pg> | project, p | List a project group’s projects. |
describe org <org> | organization, orgs, organizations | Print an organization’s detail. |
describe pg <org> <pg> | projectgroup, pgs, projectgroups | Print a project group’s detail. |
describe project <org> <pg> <project> | p, projects | Print a project’s detail (definitions of done, ticket phases, …). |
Tasks & bugs
| Command | Aliases | Description |
|---|---|---|
list tasks <org> <pg> <project> | task, t | List a project’s tasks, flatly. |
describe task <org> <pg> <project> <task> | tasks, t | Print a task’s detail (descriptions, phase, priority, user stories, custom fields, security requirements, pending translations). |
list bugs <org> <pg> <project> <task> | bug, b | List a task’s bugs. |
describe bug <org> <pg> <project> <task> <bug> | bugs, b | Print a bug’s detail. |
add bug <org> <pg> <project> <task> <name> <dod> [<phase>] | b | Create a new bug on a task. |
Databases & schema
| Command | Aliases | Description |
|---|---|---|
list databases <org> <pg> <project> | database, dbs, db | List a project’s databases. |
describe db <org> <pg> <project> <db> | database, dbs, databases | Print a database’s detail. |
list dbcatalog <org> <pg> <project> <db> | cat, dbcs, cats, dbcat, dbcats, dbcatalogs | List a database’s catalogs. |
list dbschema ... <catalog> | schema, schemas, dbschemas | List a catalog’s schemas. |
list table ... <schema> | tables, dbt, dbtab, dbtabs, dbtable, dbtables | List a schema’s tables. |
list column ... <table> | columns, dbcol, dbcols, col, cols | List a table’s columns. |
list foreignkey ... <table> | foreign key, foreignkeys, fk, fks, dbfk, dbfks | List a table’s foreign keys. |
Schema change actions (change bundles)
Schema changes are proposed into a change bundle, exactly like the web UI’s schema editor – nothing is applied until the bundle is sealed there. Create one with add changebundle <org> <pg> <project> <task> (aliases changebundles, cb, cbs), then add/edit/cancel any of the sixteen action types below against it – each follows the same <verb> <action> <org> <pg> <project> <db> <catalog> <schema> [<table>] <task> <changebundle> ... shape, with the exact trailing arguments depending on what the action changes. Use list actions ... <changebundle> (alias action) to find an existing action’s id for edit/cancel, since add only ever returns the id of the one it just created.
The sixteen action types (each usable with add/edit/cancel) | |||
|---|---|---|---|
table | renametable | removetable | column |
removecolumn | foreignkey | removeforeignkeyonetoone | removeforeignkey |
columnname | columndefault | columnnullability | columndimension |
columncomment | columnuniqueness | columnprimarykey | columnautoincrement |
Translations
| Command | Aliases | Description |
|---|---|---|
list translationstack <org> <pg> <project> | translationstacks, ts, tstack, tstacks | List a project’s translation stacks. |
describe translationstack ... <stack> | translationstacks, ts, tstack, tstacks | Print a translation stack’s detail, including its locales. |
add translationtext ... <stack> <locale> <keyword> <text> [<translate>] | translationstacktext, transl | Add a new translation keyword and its first value; auto-translates into the stack’s other locales unless <translate> is false. |
| Command | Aliases | Description |
|---|---|---|
list mailfolder | mailfolders, mf | List your own account’s mail folders. |
import mail <mailfolder> <path> | – | Import one .eml file, or every .eml file directly inside a directory, into a mail folder. |
Credential vaults
| Command | Aliases | Description |
|---|---|---|
list vaults <org> | vault | List an organization’s credential vaults. |
list vaultfolders ... <vault> | vaultfolder, vf | List a vault’s folders. |
list vaultentries ... <folder> | vaultentry, ve | List a folder’s entries. |
describe vaultentry <org> <vault> <folder> <entry> | vaultentries, ve | Print an entry’s full detail, including the plaintext password/URL/key filename if attached (refused with HTTP 403 if restricted to an account/group you’re not part of). |
VirtualBox click-tests
A full click-test tree, from discovering hardware down to running a test and pulling a screenshot: list vm → list build/list snapshot → add test → add testcase → add teststep + edit teststep → run test → describe testcase/describe teststep → download screenshot.
| Command | Aliases | Description |
|---|---|---|
list vm | vms | List every virtual machine. |
list build <org> <pg> <project> | builds | List a project’s builds (labelled by their configured Maven goals). |
list snapshot <vm> | snapshots | List a virtual machine’s snapshots. |
list test <vm> | tests | List a virtual machine’s existing test suites, newest first. |
add test <org> <pg> <project> <build> <snapshot> <name> | – | Create a new test suite bound to a build and a snapshot. |
list testcase <vm> | testcases | List every testcase across all of a virtual machine’s test suites. |
describe testcase <testcase> | – | Print a testcase’s detail, including every step’s short action summary. |
add testcase <test> <name> | – | Create a new, empty testcase under a test suite. |
list teststep <testcase> | teststeps | List a testcase’s steps in execution order, with a short action summary each. |
describe teststep <teststep> | – | Print a step’s exact raw property values. |
add teststep <testcase> | – | Create a new, entirely empty step – follow up with edit teststep. |
edit teststep <teststep> <field> <value> | – | Set (or, with value null, clear) one property: mousemovex, mousemovey, mousedownbutton, mouseupbutton, keydowncode, keyupcode, doubleclickms, stringwrite, waitcputimeoutus, or waitcpupercent. |
run test <testcase> | – | Queue a new run of the testcase’s whole test suite (every testcase in it), asynchronously. |
download screenshot <teststep> <output-file> | – | Save a step’s attached reference screenshot as a local PNG file. |
Utility
| Command | Description |
|---|---|
completion bash | Print a Bash completion function – source <(relman completion bash). |
completion powershell | Print a PowerShell argument completer – relman completion powershell | Out-String | Invoke-Expression. |
Übersicht über die relman-Befehlszeilenbefehle
Jeder Befehl hat denselben Aufbau: relman [Optionen] . Erforderliche Optionen sind --domain/-d (der Server) sowie --cert/-i (ein PKCS#12-Client-Zertifikat für gegenseitiges TLS); optionale Optionen sind --cert-password/-p, --format/-f (yaml [Standard], json, xmloder plain), --verbose/-vsowie --help/-h. Die meisten von einer Liste/beschreiben/hinzufügen Befehls sind undurchsichtige Bezeichner, keine echten Datenbank-IDs, und sind in der Regel nur innerhalb ihres unmittelbaren übergeordneten Elements eindeutig – übergeben Sie die gesamte Kette von Tokens, die ein Befehl anfordert, von oben nach unten. Führen Sie relman completion bash oder relman completion powershell aus, um die Tab-Vervollständigung in der Shell zu installieren.
Organisationen, Projektgruppen und Projekte
| Befehl | Aliase | Beschreibung |
|---|---|---|
Organisationen auflisten | orgs | Alle Organisationen auflisten, auf die Sie Zugriff haben. |
Projektgruppen auflisten | pg, pgs | Die Projektgruppen einer Organisation auflisten. |
Projekte auflisten | projekt, p | Die Projekte einer Projektgruppe auflisten. |
Organisation beschreiben | Organisation, Organisationen, Organisationen | Die Details einer Organisation ausgeben. |
Beschreibung der Projektgruppe | Projektgruppe, PGs, Projektgruppen | Details einer Projektgruppe ausgeben. |
projekt beschreiben | p, projekte | Details eines Projekts anzeigen (Definitionen von „Fertig“, Ticketphasen usw.). |
Aufgaben & Fehler
| Befehl | Aliase | Beschreibung |
|---|---|---|
Aufgaben auflisten | Aufgabe, t | Listen Sie die Aufgaben eines Projekts in einer flachen Struktur auf. |
Aufgabe beschreiben | Aufgaben, t | Die Details einer Aufgabe ausgeben (Beschreibungen, Phase, Priorität, User Stories, benutzerdefinierte Felder, Sicherheitsanforderungen, ausstehende Übersetzungen). |
Fehler auflisten | Fehler, b | Die Fehler einer Aufgabe auflisten. |
Fehler beschreiben | Fehler, b | Die Details eines Fehlers anzeigen. |
Fehler hinzufügen | b | Erstellen Sie einen neuen Fehler zu einer Aufgabe. |
Datenbanken und Schema
| Befehl | Aliase | Beschreibung | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Datenbanken auflisten | Datenbank, dbs, db | Listen Sie die Datenbanken eines Projekts auf. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
db beschreiben | Datenbank, dbs, Datenbanken | Details einer Datenbank anzeigen. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
dbcatalog auflisten | cat, dbcs, cats, dbcat, dbcats, dbcatalogs | Listen Sie die Kataloge einer Datenbank auf. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
list dbschema ... | Schema, Schemata, dbschemas | Die Schemata eines Katalogs auflisten. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Tabelle auflisten ... | Tabellen, dbt, dbtab, dbtabs, dbtable, dbtables | Listen Sie die Tabellen eines Schemas auf. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
list column ... | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Présentation des commandes de l’interface en ligne de commande (CLI) de relman
Chaque commande suit le même format : relman [options] . Les options obligatoires sont --domain/-d (le serveur) et --cert/-i (un certificat client PKCS#12 pour le protocole TLS mutuel) ; les options facultatives sont --cert-password/-p, --format/-f (yaml [par défaut], json, xml, ou plain), --verbose/-v, ainsi que --help/-h. La plupart des éléments renvoyés par une liste/décrivent/commande sont des identifiants opaques, et non de véritables identifiants de base de données ; ils ne sont généralement uniques qu’au sein de leur parent immédiat. Transmettez donc l’intégralité de la chaîne de tokens demandée par une commande, de haut en bas. Exécutez relman completion bash ou relman completion powershell pour installer la complétion par tabulation dans le shell.
Organisations, groupes de projets et projets
| Commande | Alias | Description |
|---|---|---|
lister les organisations | orgs | Répertorie toutes les organisations auxquelles vous avez accès. |
liste des groupes de projets | pg, pgs | Répertorier les groupes de projet d’une organisation. |
lister les projets | projet, p | Répertorier les projets d’un groupe de projet. |
décrire l'organisation | organisation, orgs, organisations | Afficher les détails d’une organisation. |
décrire pg | groupe de projets, pgs, groupes de projets | Afficher les détails d’un groupe de projets. |
décrire projet | p, projets | Afficher les détails d’un projet (définitions de « terminé », phases des tickets, etc.). |
Tâches et bogues
| Commande | Alias | Description |
|---|---|---|
lister les tâches | tâche, t | Répertorier les tâches d’un projet, sous forme de liste plate. |
Décrire une tâche | tâches, t | Afficher les détails d’une tâche (descriptions, phase, priorité, user stories, champs personnalisés, exigences de sécurité, traductions en attente). |
Liste des bogues | bug, b | Répertorier les bugs d’une tâche. |
décrire un bug | bogues, b | Afficher les détails d’un bug. |
Ajouter un bug | b | Créer un nouveau bug sur une tâche. |
Bases de données et schémas
| Commande | Alias | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
lister les bases de données | base de données, dbs, db | Répertorier les bases de données d’un projet. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
décrire une base de données | base de données, dbs, bases de données | Afficher les détails d’une base de données. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
lister le catalogue de bases de données | cat, dbcs, cats, dbcat, dbcats, dbcatalogs | Afficher la liste des catalogues d’une base de données. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
list dbschema ... | schéma, schémas, dbschemas | Répertorier les schémas d’un catalogue. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
list table ... | tables, dbt, dbtab, dbtabs, dbtable, dbtables | Répertorier les tables d’un schéma. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
liste colonne ... | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Descripción general de los comandos de la CLI de relman
Todos los comandos siguen el mismo formato: relman [opciones] . Los modificadores obligatorios son --domain/-d (el servidor) y --cert/-i (un certificado de cliente PKCS#12 para TLS recíproco); los parámetros opcionales son --cert-password/-p, --formato/-f (yaml [por defecto], json, xml, o plain), --verbose/-v, y --help/-h. La mayoría de los tokens devueltos por un lista/describen/el comando son identificadores opacos, no identificadores reales de la base de datos, y por lo general solo son únicos dentro de su elemento padre inmediato: pase toda la cadena de tokens que solicita un comando, de arriba abajo. Ejecute relman completion bash o relman completion powershell para instalar la función de autocompletado con la tecla Tab en el shell.
Organizaciones, grupos de proyectos y proyectos
| Comando | Alias | Descripción |
|---|---|---|
listar organizaciones | orgs | Mostrar todas las organizaciones a las que tiene acceso. |
listar grupos de proyectos | pg, pgs | Mostrar los grupos de proyectos de una organización. |
listar proyectos | proyecto, p | Mostrar los proyectos de un grupo de proyectos. |
describir organización | organización, organizaciones, organizaciones | Mostrar los detalles de una organización. |
describir pg | grupo de proyectos, pgs, grupos de proyectos | Imprima los detalles de un grupo de proyectos. |
describir proyecto | p, proyectos | Mostrar los detalles de un proyecto (definiciones de «completado», fases de los tickets, etc.). |
Tareas y incidencias
| Comando | Alias | Descripción |
|---|---|---|
listar tareas | tarea, t | Mostrar las tareas de un proyecto en formato plano. |
describir tarea | tareas, t | Mostrar los detalles de una tarea (descripciones, fase, prioridad, historias de usuario, campos personalizados, requisitos de seguridad, traducciones pendientes). |
enumerar errores | error, b | Mostrar los errores de una tarea. |
describir un error | errores, b | Mostrar los detalles de un error. |
Añadir error | b | Crear un nuevo error en una tarea. |
Bases de datos y esquemas
| Comando | Alias | Descripción | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
listar bases de datos | base de datos, dbs, db | Mostrar las bases de datos de un proyecto. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
describir base de datos | base de datos, dbs, bases de datos | Mostrar los detalles de una base de datos. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
listar dbcatalog | cat, dbcs, cats, dbcat, dbcats, dbcatalogs | Mostrar los catálogos de una base de datos. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
list dbschema ... | esquema, esquemas, dbschemas | Mostrar los esquemas de un catálogo. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
list table ... | tablas, dbt, dbtab, dbtabs, dbtable, dbtables | Mostrar las tablas de un esquema. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
list columna ... | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
relman 命令行界面 (CLI) 命令概述
每个命令的格式都相同: relman [选项] 必需的标志包括 --domain/-d (服务器)和 --cert/-i (用于双向 TLS 的 PKCS#12 客户端证书);可选参数包括 --cert-password/-p, --format/-f (yaml [默认], json, xml,或 plain), --详细/-v,以及 --help/-h。由 列表/描述/添加 命令返回的大多数令牌都是不透明标识符,而非真正的数据库ID,且通常仅在其直接父级范围内具有唯一性——请按自上而下的顺序传递命令所要求的完整令牌链。运行 relman 补全 bash 或 relman completion powershell 以安装 shell 标签补全功能。
组织、项目组和项目
| 命令 | 别名 | 描述 |
|---|---|---|
列出组织 | orgs | 列出您有权访问的所有组织。 |
列出项目组 | pg, pgs | 列出某个组织的项目组。 |
列出项目 | 项目, p | 列出某个项目组的项目。 |
描述组织 | 组织, orgs, 组织 | 打印一个组织的详细信息。 |
描述项目组 | 项目组, pgs, 项目组 | 打印项目组的详细信息。 |
描述项目 | p, 项目 | 打印项目的详细信息(“完成”的定义、工单阶段等)。 |
任务与缺陷
| 命令 | 别名 | 描述 |
|---|---|---|
列出任务 | 任务, t | 以扁平方式列出项目的任务。 |
描述任务 | 任务, t | 打印任务的详细信息(描述、阶段、优先级、用户故事、自定义字段、安全要求、待翻译内容)。 |
列出缺陷 | bug, b | 列出任务的缺陷。 |
描述缺陷 | 缺陷, b | 打印一个缺陷的详细信息。 |
添加缺陷 | b | 在任务上创建一个新缺陷。 |
数据库与模式
| 命令 | 别名 | 描述 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
列出数据库 | 数据库, dbs, 数据库 | 列出项目中的数据库。 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
描述数据库 | 数据库, dbs, 数据库 | 打印数据库的详细信息。 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
列出数据库目录 | cat, dbcs, cats, dbcat, dbcats, dbcatalogs | 列出数据库的目录。 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
list dbschema ... | schema, schemas, dbschemas | 列出一个目录中的模式。 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
列出表 ... | 表, dbt, dbtab, dbtabs, dbtable, dbtables | 列出一个模式中的表。 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
列出列... | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||