jiradc-cli 1.0.39 → 1.0.41

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -253,6 +253,30 @@ The test repository tree. Every folder command is scoped by `--project <key>`.
253
253
  | `jiradc xray status list` | The run statuses configured on this instance; `--step` for step statuses |
254
254
  | `jiradc xray field list` | The Xray custom fields present on this instance |
255
255
 
256
+ ### structure
257
+
258
+ [Structure](https://help.tempo.io/structure-dc/latest/structure-rest-api-reference) is a Jira plugin that files issues into named hierarchies. Two ideas are worth holding before using these commands:
259
+
260
+ - A **row** is one appearance of an item in one structure, and an **item** is the thing itself. The same issue can occupy several rows, so `row add` takes an issue key while `row move` and `row remove` take a `<rowId>`.
261
+ - `--structure` accepts an id **or** a name, so a caller who was told the name does not need a lookup first.
262
+
263
+ `structure search` answers "what is in this folder" server-side with one Jira search and is much cheaper than reading a forest — prefer it. The `folder` and `row` commands read the whole tree, which on a large structure is hundreds of KB, so their defaults are deliberately narrow (top level, one level deep).
264
+
265
+ | Command | Description |
266
+ | --------------------------------------- | ---------------------------------------------------------------------------------------------- |
267
+ | `jiradc structure list` | Structures you can see; `--permissions` for their access rules |
268
+ | `jiradc structure get <structureId>` | One structure; `--permissions` for its access rules |
269
+ | `jiradc structure create` | Creates an empty structure named `--name` |
270
+ | `jiradc structure delete <structureId>` | Deletes a structure and its rows. The underlying Jira issues are untouched |
271
+ | `jiradc structure search <sjql>` | Issues by their place in `--structure`, via S-JQL, e.g. `"child of folder('Billing')"` |
272
+ | `jiradc structure folder list` | Folders in `--structure`; `--query` matches a name at any depth, `--parent`/`--depth` scope it |
273
+ | `jiradc structure folder get <rowId>` | One folder with its path, child count and descendant count |
274
+ | `jiradc structure folder create` | Creates a folder named `--name`, optionally `--under <rowId>` |
275
+ | `jiradc structure row list` | Rows under `--parent` in `--structure`, to `--depth` |
276
+ | `jiradc structure row add` | Places `--issue` under `--under`. Idempotent — re-running reports the existing row |
277
+ | `jiradc structure row move <rowId>` | Moves a row to a new `--under` parent |
278
+ | `jiradc structure row remove <rowId>` | Removes a row. The row goes; the Jira issue does not |
279
+
256
280
  ## Pagination
257
281
 
258
282
  List and search commands take `--limit <n>` (default 25; Jira DC caps agile endpoints at 50). Responses carry `nextPage` — pass it back as `--start` for the next page. When `nextPage` is `null`, there are no more results. `issue search --all` collects every match in one call instead, capping at 1,000 and failing rather than truncating above it.