jiradc-cli 1.0.10 → 1.0.12

package/README.md

@@ -0,0 +1,143 @@
+# jiradc-cli
+
+Command-line interface for [Jira Data Center](https://developer.atlassian.com/server/jira/platform/rest-apis/). 35 commands across 6 domains — issues, projects, boards, sprints, fields, and users.
+
+## Install
+
+```bash
+npm install -g jiradc-cli
+```
+
+## Setup
+
+```bash
+export JIRA_URL="https://jira.example.com"   # Base URL of your Jira instance
+export JIRA_TOKEN="your-personal-access-token" # HTTP Access Token from Jira
+```
+
+## Commands
+
+All commands output JSON. Add `--pretty` to pretty-print.
+
+### issue
+
+| Command | Description |
+|---------|-------------|
+| `jiradc issue get <key>` | Get issue details (`--fields` to select, `--expand` for changelog/transitions) |
+| `jiradc issue search <jql>` | Search issues with JQL |
+| `jiradc issue create` | Create an issue (`--project`, `--type`, `--summary`, `--description`, `--custom-fields`) |
+| `jiradc issue update <key>` | Update an issue |
+| `jiradc issue delete <key>` | Delete an issue |
+| `jiradc issue transition <key> <transitionId>` | Transition issue to a new status |
+| `jiradc issue transitions <key>` | List available transitions |
+| `jiradc issue comment <key>` | Add a comment |
+| `jiradc issue comment-edit <key> <commentId>` | Edit a comment |
+| `jiradc issue link <key> <targetKey>` | Link two issues (`--type` link type name) |
+| `jiradc issue unlink <linkId>` | Remove a link |
+| `jiradc issue link-types` | List available link types |
+| `jiradc issue link-epic <epicKey> <issueKey>` | Link an issue to an epic |
+| `jiradc issue worklog <key>` | Add a work log entry |
+| `jiradc issue get-worklog <key>` | Get work log entries |
+| `jiradc issue changelog <key>` | Get issue changelog |
+| `jiradc issue batch-changelog` | Get changelog for multiple issues (`--keys`) |
+| `jiradc issue clone <key>` | Clone an issue with subtasks |
+| `jiradc issue batch-create` | Create multiple issues from JSON |
+| `jiradc issue dev-status <key>` | Get development status (branches, PRs, commits) |
+
+#### issue attachment
+
+| Command | Description |
+|---------|-------------|
+| `jiradc issue attachment list <key>` | List attachments |
+| `jiradc issue attachment download <key> <attachmentId>` | Download a specific attachment |
+| `jiradc issue attachment download-all <key>` | Download all attachments |
+| `jiradc issue attachment upload <key> <files...>` | Upload files |
+| `jiradc issue attachment delete <attachmentId>` | Delete an attachment |
+
+### project
+
+| Command | Description |
+|---------|-------------|
+| `jiradc project list` | List projects |
+| `jiradc project versions <key>` | List versions for a project |
+| `jiradc project components <key>` | List components for a project |
+
+### board
+
+| Command | Description |
+|---------|-------------|
+| `jiradc board list` | List boards (`--project`, `--type`: scrum/kanban/simple, `--name`) |
+| `jiradc board issues <boardId>` | Get issues on a board |
+
+### sprint
+
+| Command | Description |
+|---------|-------------|
+| `jiradc sprint list <boardId>` | List sprints (`--state`: future/active/closed) |
+| `jiradc sprint issues <boardId> <sprintId>` | Get issues in a sprint |
+| `jiradc sprint create <boardId>` | Create a sprint |
+| `jiradc sprint update <sprintId>` | Update a sprint |
+
+### field
+
+| Command | Description |
+|---------|-------------|
+| `jiradc field search` | Search for fields (`--query`, `--type`: custom/system) |
+| `jiradc field options <fieldKey>` | Get allowed values for a field (`--project`, `--issue-type`) |
+
+### user
+
+| Command | Description |
+|---------|-------------|
+| `jiradc user me` | Get current user info |
+
+## Pagination
+
+Search and list commands accept `--max` to control page size (Jira DC caps at 50 for agile endpoints). Responses include `nextPage` — pass it back as `--start-at` to fetch the next page. When `nextPage` is `null`, there are no more results.
+
+## Examples
+
+```bash
+# Get an issue with default fields
+jiradc issue get AI-123
+
+# Get an issue with specific fields
+jiradc issue get AI-123 --fields summary,status,assignee,customfield_10100
+
+# Search with JQL
+jiradc issue search 'project = AI AND status = "In Development" ORDER BY updated DESC'
+
+# Create an issue
+jiradc issue create --project AI --type Task --summary "Implement feature X" --description "Details here"
+
+# Create with custom fields
+jiradc issue create --project AI --type Story --summary "User login" --custom-fields '{"customfield_10100": "value"}'
+
+# Transition an issue (find transition ID first)
+jiradc issue transitions AI-123
+jiradc issue transition AI-123 31
+
+# Add a comment
+jiradc issue comment AI-123 --body "Fixed in commit abc123"
+
+# Link two issues
+jiradc issue link AI-123 AI-456 --type "blocks"
+
+# Log work
+jiradc issue worklog AI-123 --time "2h 30m" --comment "Code review"
+
+# List active sprints
+jiradc sprint list 42 --state active
+
+# Get sprint issues
+jiradc sprint issues 42 100
+
+# Find a custom field key
+jiradc field search --query "story points"
+
+# Clone an issue with subtasks
+jiradc issue clone AI-123
+
+# Get dev status (linked branches, PRs)
+jiradc issue dev-status AI-123
+```

package/dist/index.js

@@ -5,7 +5,7 @@ import { readFileSync } from "fs";
 import { dirname, join as join4 } from "path";
 import { fileURLToPath } from "url";
 import { styleText } from "util";
-import { Command as Command6 } from "commander";
+import { Command as Command8 } from "commander";
 
 // src/commands/board/issues.ts
 import { Argument } from "commander";
@@ -226,6 +226,135 @@ Examples:
   issues(board);
 }
 
+// src/commands/component/create.ts
+import { Option as Option2 } from "commander";
+var ASSIGNEE_TYPES = [
+  "PROJECT_DEFAULT",
+  "COMPONENT_LEAD",
+  "PROJECT_LEAD",
+  "UNASSIGNED"
+];
+function create(parent) {
+  parent.command("create").description("Create a new component in a project").requiredOption("--project <key>", "Project key (e.g., AI)").requiredOption("--name <name>", "Component name").option("--description <text>", "Component description").option("--lead <username>", "Username of the component lead").addOption(new Option2("--assignee-type <type>", "Assignee strategy").choices(ASSIGNEE_TYPES)).addHelpText(
+    "after",
+    `
+Examples:
+  jiradc component create --project AI --name Backend
+  jiradc component create --project AI --name Frontend --description "UI work" --lead jsmith
+  jiradc component create --project AI --name Infra --assignee-type COMPONENT_LEAD --lead jsmith`
+  ).action(
+    async (opts) => {
+      const client = getClient();
+      const result = await client.components.create({
+        project: opts.project,
+        name: opts.name,
+        description: opts.description,
+        leadUserName: opts.lead,
+        assigneeType: opts.assigneeType
+      });
+      output(result);
+    }
+  );
+}
+
+// src/commands/component/delete.ts
+function deleteComponent(parent) {
+  parent.command("delete <id>").description("Delete a component, optionally reassigning its issues to another component").option("--move-issues-to <id>", "Reassign existing issues to this component ID before deletion").addHelpText(
+    "after",
+    `
+Examples:
+  jiradc component delete 11289
+  jiradc component delete 11289 --move-issues-to 11290`
+  ).action(async (id, opts) => {
+    const client = getClient();
+    await client.components.delete({ id, moveIssuesTo: opts.moveIssuesTo });
+    output({ deleted: true, componentId: id, ...opts.moveIssuesTo && { movedIssuesTo: opts.moveIssuesTo } });
+  });
+}
+
+// src/commands/component/get.ts
+function get(parent) {
+  parent.command("get <id>").description("Get a component by ID").addHelpText("after", "\nExamples:\n  jiradc component get 11289").action(async (id) => {
+    const client = getClient();
+    const result = await client.components.get({ id });
+    output(result);
+  });
+}
+
+// src/commands/component/issue-count.ts
+function issueCount(parent) {
+  parent.command("issue-count <id>").description("Get the number of issues currently using this component").addHelpText("after", "\nExamples:\n  jiradc component issue-count 11289").action(async (id) => {
+    const client = getClient();
+    const result = await client.components.getRelatedIssueCounts({ id });
+    output(result);
+  });
+}
+
+// src/commands/component/list.ts
+function list2(parent) {
+  parent.command("list <projectKey>").description("List all components for a project").addHelpText("after", "\nExamples:\n  jiradc component list AI").action(async (projectKey) => {
+    const client = getClient();
+    const result = await client.components.list({ projectKeyOrId: projectKey });
+    output(result);
+  });
+}
+
+// src/commands/component/update.ts
+import { Option as Option3 } from "commander";
+var ASSIGNEE_TYPES2 = [
+  "PROJECT_DEFAULT",
+  "COMPONENT_LEAD",
+  "PROJECT_LEAD",
+  "UNASSIGNED"
+];
+function update(parent) {
+  parent.command("update <id>").description("Update an existing component (only provided fields are changed)").option("--name <name>", "New component name").option("--description <text>", "New component description").option("--lead <username>", "Username of the component lead (empty string clears it)").addOption(new Option3("--assignee-type <type>", "New assignee strategy").choices(ASSIGNEE_TYPES2)).addHelpText(
+    "after",
+    `
+Examples:
+  jiradc component update 11289 --name Backend
+  jiradc component update 11289 --description "Server-side code"
+  jiradc component update 11289 --lead jsmith --assignee-type COMPONENT_LEAD`
+  ).action(
+    async (id, opts) => {
+      if (opts.name === void 0 && opts.description === void 0 && opts.lead === void 0 && opts.assigneeType === void 0) {
+        throw new Error("Provide at least one of --name, --description, --lead, --assignee-type");
+      }
+      const client = getClient();
+      const result = await client.components.update({
+        id,
+        name: opts.name,
+        description: opts.description,
+        leadUserName: opts.lead,
+        assigneeType: opts.assigneeType
+      });
+      output(result);
+    }
+  );
+}
+
+// src/commands/component/index.ts
+function registerComponentCommands(program2) {
+  const component = program2.command("component").description("Project component operations").addHelpText(
+    "after",
+    `
+Examples:
+  $ jiradc component list AI
+  $ jiradc component get 11289
+  $ jiradc component create --project AI --name Backend
+  $ jiradc component update 11289 --name Backend
+  $ jiradc component delete 11289 --move-issues-to 11290
+  $ jiradc component issue-count 11289
+`
+  );
+  list2(component);
+  get(component);
+  create(component);
+  update(component);
+  deleteComponent(component);
+  issueCount(component);
+}
+
 // src/commands/field/options.ts
 function options(parent) {
   parent.command("options <id>").description("Get available options for a custom field").option("--query <text>", "Filter options by text").option("--max <number>", "Max results to return (1-1000)", intInRange(1, 1e3), 25).option("--page <number>", "Page number (1-indexed)", positiveInt).addHelpText(
@@ -343,7 +472,7 @@ function download(parent) {
 }
 
 // src/commands/issue/attachment/list.ts
-function list2(parent) {
+function list3(parent) {
   parent.command("list <key>").description("List attachments on an issue").addHelpText("after", "\nExamples:\n  jiradc issue attachment list PROJ-123").action(async (key) => {
     const client = getClient();
     const issue = await client.issues.get({
@@ -406,7 +535,7 @@ Examples:
 `
   );
   upload(attachment);
-  list2(attachment);
+  list3(attachment);
   download(attachment);
   downloadAll(attachment);
   deleteAttachment(attachment);
@@ -621,7 +750,7 @@ function comment(parent) {
 }
 
 // src/commands/issue/create.ts
-function create(parent) {
+function create2(parent) {
   parent.command("create").description("Create a new issue").requiredOption("--project <key>", "Project key or ID").requiredOption("--type <name>", "Issue type name (e.g., Task, Bug, Story)").requiredOption("--summary <text>", "Issue summary/title").option("--description <text>", "Issue description in wiki markup").option("--assignee <username>", "Assignee username").option("--reporter <username>", "Reporter username").option("--priority <name>", "Priority name (e.g., High, Medium, Low)").option("--labels <labels>", "Comma-separated labels").option("--components <names>", "Comma-separated component names").option("--fix-versions <versions>", "Comma-separated fix version names").option("--due-date <date>", "Due date in YYYY-MM-DD format").option("--parent <key>", "Parent issue key (for subtasks)").option("--custom-fields <json>", `Additional custom fields as JSON (e.g., '{"customfield_10100": "EPIC-1"}')`).addHelpText(
     "after",
     `
@@ -777,7 +906,7 @@ var DEFAULT_FIELDS = [
 ];
 
 // src/commands/issue/get.ts
-function get(parent) {
+function get2(parent) {
   parent.command("get <key>").description("Get issue details").option("--fields <fields>", "Comma-separated fields to return (defaults to essential fields)").option("--all-fields", "Return all fields instead of defaults").option("--expand <expand>", 'Expand options (e.g., "transitions", "changelog")').addHelpText(
     "after",
     "\nExamples:\n  jiradc issue get PROJ-123\n  jiradc issue get PROJ-123 --fields summary,status,assignee\n  jiradc issue get PROJ-123 --all-fields\n  jiradc issue get PROJ-123 --expand changelog,transitions"
@@ -880,7 +1009,7 @@ function unlink2(parent) {
 }
 
 // src/commands/issue/update.ts
-function update(parent) {
+function update2(parent) {
   parent.command("update <key>").description("Update issue fields").option("--fields <json>", "JSON string of fields to update").option("--notify-users", "Notify users about the update (default: true)").option("--attachments <paths>", "Comma-separated local file paths to attach").addHelpText(
     "after",
     `
@@ -891,8 +1020,7 @@ Examples:
   jiradc issue update PROJ-123 --fields '{"summary": "With attachment"}' --attachments ./report.pdf`
   ).action(async (key, opts) => {
     if (!opts.fields && !opts.attachments) {
-      console.error(JSON.stringify({ error: "Provide --fields and/or --attachments" }));
-      process.exit(1);
+      throw new Error("Provide --fields and/or --attachments");
     }
     const client = getClient();
     if (opts.fields) {
@@ -944,10 +1072,10 @@ Examples:
   $ jiradc issue attachment list PROJ-123
 `
   );
-  get(issue);
+  get2(issue);
   search2(issue);
-  create(issue);
-  update(issue);
+  create2(issue);
+  update2(issue);
   deleteIssue(issue);
   transition(issue);
   transitions(issue);
@@ -968,17 +1096,8 @@ Examples:
   devStatus(issue);
 }
 
-// src/commands/project/components.ts
-function components(parent) {
-  parent.command("components <key>").description("Get all components for a project").addHelpText("after", "\nExamples:\n  jiradc project components PROJ").action(async (key) => {
-    const client = getClient();
-    const result = await client.projects.getComponents({ projectKeyOrId: key });
-    output(result);
-  });
-}
-
 // src/commands/project/list.ts
-function list3(parent) {
+function list4(parent) {
   parent.command("list").description("List all projects").option("--expand <expand>", 'Expand options (e.g., "description,lead")').option("--include-archived", "Include archived projects (default: false)").addHelpText(
     "after",
     "\nExamples:\n  jiradc project list\n  jiradc project list --expand description,lead\n  jiradc project list --include-archived"
@@ -1009,16 +1128,14 @@ function registerProjectCommands(program2) {
 Examples:
   $ jiradc project list
   $ jiradc project versions PROJ
-  $ jiradc project components PROJ
 `
   );
-  list3(project);
+  list4(project);
   versions(project);
-  components(project);
 }
 
 // src/commands/sprint/create.ts
-function create2(parent) {
+function create3(parent) {
   parent.command("create").description("Create a new sprint").requiredOption("--board <id>", "Board ID to create sprint in", positiveInt).requiredOption("--name <name>", "Sprint name").option("--start-date <date>", "Start date in ISO 8601 format").option("--end-date <date>", "End date in ISO 8601 format").option("--goal <goal>", "Sprint goal").addHelpText(
     "after",
     '\nExamples:\n  jiradc sprint create --board 42 --name "Sprint 10"\n  jiradc sprint create --board 42 --name "Sprint 10" --start-date 2026-03-20 --end-date 2026-04-03 --goal "Complete auth module"'
@@ -1055,10 +1172,10 @@ function issues2(parent) {
 }
 
 // src/commands/sprint/list.ts
-import { Option as Option2 } from "commander";
+import { Option as Option4 } from "commander";
 var SPRINT_STATES = ["future", "active", "closed"];
-function list4(parent) {
-  parent.command("list").description("List sprints for a board").requiredOption("--board <id>", "Board ID", positiveInt).addOption(new Option2("--state <state>", "Filter by sprint state").choices(SPRINT_STATES)).addHelpText(
+function list5(parent) {
+  parent.command("list").description("List sprints for a board").requiredOption("--board <id>", "Board ID", positiveInt).addOption(new Option4("--state <state>", "Filter by sprint state").choices(SPRINT_STATES)).addHelpText(
     "after",
     "\nExamples:\n  jiradc sprint list --board 42\n  jiradc sprint list --board 42 --state active"
   ).action(async (opts) => {
@@ -1072,10 +1189,10 @@ function list4(parent) {
 }
 
 // src/commands/sprint/update.ts
-import { Argument as Argument3, Option as Option3 } from "commander";
+import { Argument as Argument3, Option as Option5 } from "commander";
 var SPRINT_STATES2 = ["future", "active", "closed"];
-function update2(parent) {
-  parent.command("update").description("Update an existing sprint").addArgument(new Argument3("<id>", "Sprint ID").argParser(positiveInt)).option("--name <name>", "New sprint name").addOption(new Option3("--state <state>", "New sprint state").choices(SPRINT_STATES2)).option("--start-date <date>", "New start date in ISO 8601 format").option("--end-date <date>", "New end date in ISO 8601 format").option("--goal <goal>", "New sprint goal").addHelpText(
+function update3(parent) {
+  parent.command("update").description("Update an existing sprint").addArgument(new Argument3("<id>", "Sprint ID").argParser(positiveInt)).option("--name <name>", "New sprint name").addOption(new Option5("--state <state>", "New sprint state").choices(SPRINT_STATES2)).option("--start-date <date>", "New start date in ISO 8601 format").option("--end-date <date>", "New end date in ISO 8601 format").option("--goal <goal>", "New sprint goal").addHelpText(
     "after",
     '\nExamples:\n  jiradc sprint update 100 --name "Sprint 10 - Extended"\n  jiradc sprint update 100 --state active\n  jiradc sprint update 100 --end-date 2026-04-10 --goal "Updated goal"'
   ).action(
@@ -1106,10 +1223,10 @@ Examples:
   $ jiradc sprint create --board 42 --name "Sprint 10" --start-date 2026-04-01 --end-date 2026-04-14
 `
   );
-  list4(sprint);
+  list5(sprint);
   issues2(sprint);
-  create2(sprint);
-  update2(sprint);
+  create3(sprint);
+  update3(sprint);
 }
 
 // src/commands/user/me.ts
@@ -1147,7 +1264,7 @@ function readPackageVersion() {
 }
 var DIM = "\x1B[2m";
 var RESET = "\x1B[0m";
-var program = new Command6();
+var program = new Command8();
 program.name("jiradc").description("Jira Data Center CLI").version(readPackageVersion()).configureHelp({
   styleTitle: (str) => styleText("bold", str),
   styleUsage: (str) => styleText("dim", str),
@@ -1179,6 +1296,7 @@ program.hook("preAction", (thisCommand) => {
 });
 registerIssueCommands(program);
 registerProjectCommands(program);
+registerComponentCommands(program);
 registerBoardCommands(program);
 registerSprintCommands(program);
 registerFieldCommands(program);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "jiradc-cli",
-  "version": "1.0.10",
+  "version": "1.0.12",
   "publish": true,
   "type": "module",
   "main": "dist/index.js",
@@ -12,7 +12,7 @@
   ],
   "dependencies": {
     "commander": "^13.1.0",
-    "jira-data-center-client": "1.0.29"
+    "jira-data-center-client": "1.0.31"
   },
   "devDependencies": {
     "@types/node": "24.10.4",
@@ -22,8 +22,8 @@
     "tsx": "^4.19.2",
     "typescript": "^5.7.2",
     "vitest": "^4.0.16",
-    "config-typescript": "0.0.0",
-    "config-eslint": "0.0.0"
+    "config-eslint": "0.0.0",
+    "config-typescript": "0.0.0"
   },
   "engines": {
     "node": ">=22.0.0"