jiradc-cli 1.0.17 → 1.0.18

package/README.md

@@ -93,7 +93,7 @@ All commands output JSON. Add `--pretty` to pretty-print.
 
 ## 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.
+Search and list commands accept `--limit` to control page size (Jira DC caps at 50 for agile endpoints). Responses include `nextPage` — pass it back as `--start` to fetch the next page. When `nextPage` is `null`, there are no more results.
 
 ## Examples
 

package/dist/index.js

@@ -434,15 +434,15 @@ function transformIssueFields(fields) {
 
 // src/commands/board/issues.ts
 function issues(parent) {
-  parent.command("issues").description("Get issues for a board").addArgument(new Argument("<id>", "Board ID").argParser(positiveInt)).option("--max <number>", "Max results (1-50, Jira DC caps at 50)", intInRange(1, 50), 25).option("--start-at <number>", "Starting index for pagination", nonNegativeInt).option("--fields <fields>", "Comma-separated field names to return").option("--jql <jql>", "Additional JQL filter within the board").addHelpText(
+  parent.command("issues").description("Get issues for a board").addArgument(new Argument("<id>", "Board ID").argParser(positiveInt)).option("--limit <number>", "Max results (1-50, Jira DC caps at 50)", intInRange(1, 50), 25).option("--start <number>", "Starting index for pagination", nonNegativeInt).option("--fields <fields>", "Comma-separated field names to return").option("--jql <jql>", "Additional JQL filter within the board").addHelpText(
     "after",
-    '\nExamples:\n  jiradc board issues 42\n  jiradc board issues 42 --max 10\n  jiradc board issues 42 --jql "status = Open" --fields summary,status\n  jiradc board issues 42 --start-at 50 --max 25'
+    '\nExamples:\n  jiradc board issues 42\n  jiradc board issues 42 --limit 10\n  jiradc board issues 42 --jql "status = Open" --fields summary,status\n  jiradc board issues 42 --start 50 --limit 25'
   ).action(async (id, opts) => {
     const client = getClient();
     const result = await client.agile.getBoardIssues({
       boardId: id,
-      startAt: opts.startAt,
-      maxResults: opts.max,
+      startAt: opts.start,
+      maxResults: opts.limit,
       fields: opts.fields?.split(",").map((f) => f.trim()),
       jql: opts.jql
     });
@@ -454,13 +454,13 @@ function issues(parent) {
 import { Option } from "commander";
 var BOARD_TYPES = ["scrum", "kanban", "simple"];
 function list(parent) {
-  parent.command("list").description("List agile boards").option("--max <number>", "Max results (1-1000)", intInRange(1, 1e3), 25).option("--project <key>", "Filter boards by project key or ID").addOption(new Option("--type <type>", "Board type filter").choices(BOARD_TYPES)).option("--name <name>", "Filter boards by name").addHelpText(
+  parent.command("list").description("List agile boards").option("--limit <number>", "Max results (1-1000)", intInRange(1, 1e3), 25).option("--project <key>", "Filter boards by project key or ID").addOption(new Option("--type <type>", "Board type filter").choices(BOARD_TYPES)).option("--name <name>", "Filter boards by name").addHelpText(
     "after",
-    '\nExamples:\n  jiradc board list\n  jiradc board list --max 10\n  jiradc board list --project PROJ\n  jiradc board list --type scrum --name "Team Board"'
+    '\nExamples:\n  jiradc board list\n  jiradc board list --limit 10\n  jiradc board list --project PROJ\n  jiradc board list --type scrum --name "Team Board"'
   ).action(async (opts) => {
     const client = getClient();
     const result = await client.agile.getBoards({
-      maxResults: opts.max,
+      maxResults: opts.limit,
       projectKeyOrId: opts.project,
       type: opts.type,
       name: opts.name
@@ -477,7 +477,7 @@ function registerBoardCommands(program2) {
 Examples:
   $ jiradc board list
   $ jiradc board list --type scrum --project PROJ
-  $ jiradc board issues 42 --max 20
+  $ jiradc board issues 42 --limit 20
 `
   );
   list(board);
@@ -615,15 +615,15 @@ Examples:
 
 // 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(
+  parent.command("options <id>").description("Get available options for a custom field").option("--query <text>", "Filter options by text").option("--limit <number>", "Max results to return (1-1000)", intInRange(1, 1e3), 25).option("--page <number>", "Page number (1-indexed)", positiveInt).addHelpText(
     "after",
-    '\nExamples:\n  jiradc field options 10001\n  jiradc field options 10001 --query "High"\n  jiradc field options 10001 --max 20 --page 2'
+    '\nExamples:\n  jiradc field options 10001\n  jiradc field options 10001 --query "High"\n  jiradc field options 10001 --limit 20 --page 2'
   ).action(async (id, opts) => {
     const client = getClient();
     const result = await client.fields.getFieldOptions({
       fieldId: id,
       query: opts.query,
-      maxResults: opts.max,
+      maxResults: opts.limit,
       page: opts.page
     });
     output(transformPaged({ ...result, startAt: result.startAt ?? 0 }, transformCustomFieldOption));
@@ -842,16 +842,16 @@ function attachments(parent) {
 
 // src/commands/issue/batch-changelog.ts
 function batchChangelog(parent) {
-  parent.command("batch-changelog <keys>").description("Get changelogs for multiple issues at once").option("--max <number>", "Max changelog entries per issue (1-50, Jira DC caps at 50)", intInRange(1, 50), 25).addHelpText(
+  parent.command("batch-changelog <keys>").description("Get changelogs for multiple issues at once").option("--limit <number>", "Max changelog entries per issue (1-50, Jira DC caps at 50)", intInRange(1, 50), 25).addHelpText(
     "after",
-    "\nExamples:\n  jiradc issue batch-changelog PROJ-1,PROJ-2,PROJ-3\n  jiradc issue batch-changelog PROJ-123,PROJ-124 --max 10"
+    "\nExamples:\n  jiradc issue batch-changelog PROJ-1,PROJ-2,PROJ-3\n  jiradc issue batch-changelog PROJ-123,PROJ-124 --limit 10"
   ).action(async (keys, opts) => {
     const client = getClient();
     const keyList = keys.split(",").map((k) => k.trim());
     const entries = await Promise.all(
       keyList.map(async (key) => {
         try {
-          const data = await client.issues.getChangelog({ issueKeyOrId: key, maxResults: opts.max });
+          const data = await client.issues.getChangelog({ issueKeyOrId: key, maxResults: opts.limit });
           return [key, data];
         } catch (error) {
           return [key, { error: error instanceof Error ? error.message : "Unknown error" }];
@@ -887,9 +887,12 @@ Examples:
 
 // src/commands/issue/changelog.ts
 function changelog(parent) {
-  parent.command("changelog <key>").description("Get changelog for an issue").option("--max <number>", "Max changelog entries (1-50, Jira DC caps at 50)", intInRange(1, 50), 25).addHelpText("after", "\nExamples:\n  jiradc issue changelog PROJ-123\n  jiradc issue changelog PROJ-123 --max 10").action(async (key, opts) => {
+  parent.command("changelog <key>").description("Get changelog for an issue").option("--limit <number>", "Max changelog entries (1-50, Jira DC caps at 50)", intInRange(1, 50), 25).addHelpText(
+    "after",
+    "\nExamples:\n  jiradc issue changelog PROJ-123\n  jiradc issue changelog PROJ-123 --limit 10"
+  ).action(async (key, opts) => {
     const client = getClient();
-    const result = await client.issues.getChangelog({ issueKeyOrId: key, maxResults: opts.max });
+    const result = await client.issues.getChangelog({ issueKeyOrId: key, maxResults: opts.limit });
     output(result);
   });
 }
@@ -1133,15 +1136,15 @@ function devStatus(parent) {
 
 // src/commands/issue/get-worklog.ts
 function getWorklog(parent) {
-  parent.command("get-worklog <key>").description("Get worklogs for an issue").option("--start-at <number>", "Starting index for pagination", nonNegativeInt).option("--max <number>", "Max results per page (1-1000)", intInRange(1, 1e3), 25).addHelpText(
+  parent.command("get-worklog <key>").description("Get worklogs for an issue").option("--start <number>", "Starting index for pagination", nonNegativeInt).option("--limit <number>", "Max results per page (1-1000)", intInRange(1, 1e3), 25).addHelpText(
     "after",
-    "\nExamples:\n  jiradc issue get-worklog PROJ-123\n  jiradc issue get-worklog PROJ-123 --max 10\n  jiradc issue get-worklog PROJ-123 --start-at 10 --max 5"
+    "\nExamples:\n  jiradc issue get-worklog PROJ-123\n  jiradc issue get-worklog PROJ-123 --limit 10\n  jiradc issue get-worklog PROJ-123 --start 10 --limit 5"
   ).action(async (key, opts) => {
     const client = getClient();
     const result = await client.issues.getWorklogs({
       issueKeyOrId: key,
-      startAt: opts.startAt,
-      maxResults: opts.max
+      startAt: opts.start,
+      maxResults: opts.limit
     });
     output(transformPaged(result, transformWorklog));
   });
@@ -1229,16 +1232,16 @@ function link(parent) {
 
 // src/commands/issue/search.ts
 function search2(parent) {
-  parent.command("search <jql>").description("Search issues using JQL").option("--max <number>", "Max results (1-50, Jira DC caps at 50)", intInRange(1, 50), 25).option("--start-at <number>", "Starting index for pagination", nonNegativeInt).option("--fields <fields>", "Comma-separated fields to return (defaults to essential fields)").option("--all-fields", "Return all fields instead of defaults").addHelpText(
+  parent.command("search <jql>").description("Search issues using JQL").option("--limit <number>", "Max results (1-50, Jira DC caps at 50)", intInRange(1, 50), 25).option("--start <number>", "Starting index for pagination", nonNegativeInt).option("--fields <fields>", "Comma-separated fields to return (defaults to essential fields)").option("--all-fields", "Return all fields instead of defaults").addHelpText(
     "after",
-    '\nExamples:\n  jiradc issue search "project = PROJ AND status = Open"\n  jiradc issue search "assignee = currentUser()" --max 10 --fields summary,status\n  jiradc issue search "project = PROJ" --start-at 50 --max 50'
+    '\nExamples:\n  jiradc issue search "project = PROJ AND status = Open"\n  jiradc issue search "assignee = currentUser()" --limit 10 --fields summary,status\n  jiradc issue search "project = PROJ" --start 50 --limit 50'
   ).action(async (jql, opts) => {
     const client = getClient();
     const fields = opts.allFields ? void 0 : opts.fields?.split(",").map((f) => f.trim()) ?? DEFAULT_FIELDS;
     const result = await client.issues.search({
       jql,
-      startAt: opts.startAt,
-      maxResults: opts.max,
+      startAt: opts.start,
+      maxResults: opts.limit,
       fields
     });
     output(transformPaged(result, transformIssue));
@@ -1336,7 +1339,7 @@ function registerIssueCommands(program2) {
     `
 Examples:
   $ jiradc issue get PROJ-123
-  $ jiradc issue search "project = PROJ AND status = Open" --max 10
+  $ jiradc issue search "project = PROJ AND status = Open" --limit 10
   $ jiradc issue create --project PROJ --type Task --summary "Fix the bug" --priority High
   $ jiradc issue update PROJ-123 --fields '{"summary": "New title"}'
   $ jiradc issue transition PROJ-123 --to 11
@@ -1426,15 +1429,15 @@ function create3(parent) {
 // src/commands/sprint/issues.ts
 import { Argument as Argument2 } from "commander";
 function issues2(parent) {
-  parent.command("issues").description("Get issues in a sprint").addArgument(new Argument2("<id>", "Sprint ID").argParser(positiveInt)).option("--max <number>", "Max results (1-50, Jira DC caps at 50)", intInRange(1, 50), 25).option("--start-at <number>", "Starting index for pagination", nonNegativeInt).option("--fields <fields>", "Comma-separated field names to return").option("--jql <jql>", "Additional JQL filter within the sprint").addHelpText(
+  parent.command("issues").description("Get issues in a sprint").addArgument(new Argument2("<id>", "Sprint ID").argParser(positiveInt)).option("--limit <number>", "Max results (1-50, Jira DC caps at 50)", intInRange(1, 50), 25).option("--start <number>", "Starting index for pagination", nonNegativeInt).option("--fields <fields>", "Comma-separated field names to return").option("--jql <jql>", "Additional JQL filter within the sprint").addHelpText(
     "after",
-    '\nExamples:\n  jiradc sprint issues 100\n  jiradc sprint issues 100 --max 20\n  jiradc sprint issues 100 --jql "status = Done" --fields summary,status\n  jiradc sprint issues 100 --start-at 50 --max 25'
+    '\nExamples:\n  jiradc sprint issues 100\n  jiradc sprint issues 100 --limit 20\n  jiradc sprint issues 100 --jql "status = Done" --fields summary,status\n  jiradc sprint issues 100 --start 50 --limit 25'
   ).action(async (id, opts) => {
     const client = getClient();
     const result = await client.agile.getSprintIssues({
       sprintId: id,
-      startAt: opts.startAt,
-      maxResults: opts.max,
+      startAt: opts.start,
+      maxResults: opts.limit,
       fields: opts.fields?.split(",").map((f) => f.trim()),
       jql: opts.jql
     });
@@ -1490,7 +1493,7 @@ function registerSprintCommands(program2) {
 Examples:
   $ jiradc sprint list --board 42
   $ jiradc sprint list --board 42 --state active
-  $ jiradc sprint issues 123 --max 20
+  $ jiradc sprint issues 123 --limit 20
   $ jiradc sprint create --board 42 --name "Sprint 10" --start-date 2026-04-01 --end-date 2026-04-14
 `
   );
@@ -1625,15 +1628,15 @@ function me(parent) {
 
 // src/commands/user/search.ts
 function search3(parent) {
-  parent.command("search <query>").description("Search users by partial username, display name or email").option("--max <n>", "Maximum results (1-50)", intInRange(1, 50), 25).option("--start <n>", "Starting index (pagination offset)", nonNegativeInt, 0).option("--include-inactive", "Include inactive users in results", false).addHelpText(
+  parent.command("search <query>").description("Search users by partial username, display name or email").option("--limit <n>", "Maximum results (1-50)", intInRange(1, 50), 25).option("--start <n>", "Starting index (pagination offset)", nonNegativeInt, 0).option("--include-inactive", "Include inactive users in results", false).addHelpText(
     "after",
-    '\nExamples:\n  jiradc user search Drago\n  jiradc user search "John Smith"\n  jiradc user search dragomir@first.bet --max 5'
+    '\nExamples:\n  jiradc user search Drago\n  jiradc user search "John Smith"\n  jiradc user search dragomir@first.bet --limit 5'
   ).action(async (query, opts) => {
     const client = getClient();
     const result = await client.users.searchUsers({
       username: query,
       startAt: opts.start,
-      maxResults: opts.max,
+      maxResults: opts.limit,
       includeActive: true,
       includeInactive: opts.includeInactive
     });
@@ -1688,7 +1691,7 @@ ${styleText("bold", "Environment:")}
 
 ${styleText("bold", "Examples:")}
   ${DIM}$${RESET} jiradc user me
-  ${DIM}$${RESET} jiradc issue search "project = PROJ AND status = Open" --max 10
+  ${DIM}$${RESET} jiradc issue search "project = PROJ AND status = Open" --limit 10
   ${DIM}$${RESET} jiradc issue get PROJ-123 --fields summary,status
   ${DIM}$${RESET} jiradc issue create --project PROJ --type Task --summary "Fix the bug"
   ${DIM}$${RESET} jiradc issue transition PROJ-123 --to 11

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "jiradc-cli",
-  "version": "1.0.17",
+  "version": "1.0.18",
   "publish": true,
   "type": "module",
   "main": "dist/index.js",