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. |