diff --git a/apps/cli/src/commands/api.ts b/apps/cli/src/commands/api.ts index fbc717c9..a242e67b 100644 --- a/apps/cli/src/commands/api.ts +++ b/apps/cli/src/commands/api.ts @@ -9,24 +9,11 @@ type Params = Record; const api = new BeeCommand("api") .summary("Make an authenticated API request") .description( - `Make an authenticated Backlog API request. - -The endpoint argument should be a path of the Backlog API -(e.g. \`users/myself\`). If the path includes the \`/api/v2/\` prefix -it is stripped automatically — both \`users/myself\` and -\`/api/v2/users/myself\` work the same way. - -Use \`--field\` / \`-f\` to pass parameters with automatic type inference: -numeric strings become numbers, \`true\`/\`false\` become booleans, and -everything else stays a string. Use \`--raw-field\` / \`-F\` to force a -value to remain a string. Both flags can be specified multiple times. -When the same key is repeated, values are collected into an array -(e.g. \`-f statusId=1 -f statusId=2 -f statusId=3\`). -To send a single-element array, append \`[]\` to the key name -(e.g. \`-f projectId[]=12345\`). - -For GET requests, fields are sent as query parameters. For POST, PUT, -PATCH, and DELETE requests, fields are sent as the request body.`, + `The endpoint is a Backlog API path (e.g. \`users/myself\`). A leading \`/api/v2/\` prefix is stripped automatically. + +\`-f\` infers types (number, boolean, string); \`-F\` always sends strings. Repeated keys become arrays. Append \`[]\` for a single-element array (e.g. \`-f projectId[]=12345\`). + +For GET, fields are query parameters. For POST/PUT/PATCH/DELETE, fields are the request body.`, ) .argument("", "API endpoint path") .option("-X, --method ", "HTTP method", "GET") diff --git a/apps/cli/src/commands/auth/login.ts b/apps/cli/src/commands/auth/login.ts index a4094fab..6596e279 100644 --- a/apps/cli/src/commands/auth/login.ts +++ b/apps/cli/src/commands/auth/login.ts @@ -8,14 +8,10 @@ import { BeeCommand } from "../../lib/bee-command"; const login = new BeeCommand("login") .summary("Authenticate with a Backlog space") .description( - `Authenticate with a Backlog space. + `The default mode is API key with interactive prompts. -The default authentication mode is API key. You will be prompted to enter -the space hostname and API key interactively. - -Alternatively, use \`--with-token\` to pass an API key on standard input. -For OAuth authentication, use \`--method oauth\`. You will need to provide -an OAuth Client ID and Client Secret, then authorize in the browser.`, +Use \`--with-token\` to pass an API key on standard input. +Use \`--method oauth\` for OAuth authentication via the browser.`, ) .option("-m, --method ", "The authentication method to use", "api-key") .option("--with-token", "Read token from standard input") diff --git a/apps/cli/src/commands/auth/logout.ts b/apps/cli/src/commands/auth/logout.ts index 1b50c1df..550ddd83 100644 --- a/apps/cli/src/commands/auth/logout.ts +++ b/apps/cli/src/commands/auth/logout.ts @@ -6,11 +6,7 @@ import { BeeCommand } from "../../lib/bee-command"; const logout = new BeeCommand("logout") .summary("Remove authentication for a Backlog space") .description( - `Remove authentication for a Backlog space. - -The stored credentials are removed locally. This does not revoke API keys or OAuth tokens on the Backlog server. - -If only one space is configured, it will be selected automatically. If multiple spaces are configured, you will be prompted to select one.`, + `Removes stored credentials locally. Does not revoke API keys or OAuth tokens on the server.`, ) .option("-s, --space ", "The hostname of the Backlog space") .envVars([["BACKLOG_SPACE", "Space hostname to log out from"]]) diff --git a/apps/cli/src/commands/auth/refresh.ts b/apps/cli/src/commands/auth/refresh.ts index efd5c4fb..1fabcef9 100644 --- a/apps/cli/src/commands/auth/refresh.ts +++ b/apps/cli/src/commands/auth/refresh.ts @@ -8,11 +8,7 @@ import { BeeCommand } from "../../lib/bee-command"; const refresh = new BeeCommand("refresh") .summary("Refresh OAuth token") .description( - `Refresh the OAuth access token for a Backlog space. - -Uses the stored refresh token to obtain a new access token. Only available for spaces authenticated with OAuth. - -If the refresh token is expired or invalid, re-authenticate with \`bee auth login -m oauth\`.`, + `Only available for spaces authenticated with OAuth. If the refresh token is expired, re-authenticate with \`bee auth login -m oauth\`.`, ) .option("-s, --space ", "The hostname of the Backlog space") .envVars([["BACKLOG_SPACE", "Default space hostname"]]) diff --git a/apps/cli/src/commands/auth/status.ts b/apps/cli/src/commands/auth/status.ts index cb7779a3..93cbf800 100644 --- a/apps/cli/src/commands/auth/status.ts +++ b/apps/cli/src/commands/auth/status.ts @@ -10,11 +10,7 @@ const getToken = (auth: RcAuth): string => const status = new BeeCommand("status") .summary("Show authentication status") .description( - `Display authentication status for configured Backlog spaces. - -For each space, the authentication method and credential validity are -verified by calling the Backlog API. The active (default) space is indicated -so you can see which space is used when \`--space\` is not provided.`, + `Verifies credential validity for each configured space via the Backlog API. The active (default) space is indicated.`, ) .option("-s, --space ", "The hostname of the Backlog space") .option("--show-token", "Display the auth token") diff --git a/apps/cli/src/commands/auth/switch.ts b/apps/cli/src/commands/auth/switch.ts index e3781a23..9e8377ba 100644 --- a/apps/cli/src/commands/auth/switch.ts +++ b/apps/cli/src/commands/auth/switch.ts @@ -5,17 +5,7 @@ import { BeeCommand } from "../../lib/bee-command"; const switchSpace = new BeeCommand("switch") .summary("Switch active space") - .description( - `Switch the active (default) Backlog space. - -Changes which space is used by default when running commands without -\`--space\`. - -If multiple spaces are configured, you will be prompted to select one -interactively. Use \`--space\` to switch directly without a prompt. - -For a list of configured spaces, see \`bee auth status\`.`, - ) + .description(`Changes which space is used by default when \`--space\` is not provided.`) .option("-s, --space ", "The hostname of the Backlog space") .envVars([["BACKLOG_SPACE", "Space hostname to switch to"]]) .examples([ diff --git a/apps/cli/src/commands/auth/token.ts b/apps/cli/src/commands/auth/token.ts index b34eac8c..202dfae4 100644 --- a/apps/cli/src/commands/auth/token.ts +++ b/apps/cli/src/commands/auth/token.ts @@ -5,11 +5,7 @@ import { BeeCommand } from "../../lib/bee-command"; const tokenCommand = new BeeCommand("token") .summary("Print the auth token to stdout") .description( - `Print the auth token for a Backlog space to standard output. - -Without \`--space\`, the default space is used. - -The token output can be used with \`BACKLOG_API_KEY\` or piped to other commands.`, + `Prints the token for the default space, or the space given by \`--space\`. Useful for piping to other commands.`, ) .option("-s, --space ", "The hostname of the Backlog space") .envVars([["BACKLOG_SPACE", "Default space hostname"]]) diff --git a/apps/cli/src/commands/browse.ts b/apps/cli/src/commands/browse.ts index df862ea5..e9d02f92 100644 --- a/apps/cli/src/commands/browse.ts +++ b/apps/cli/src/commands/browse.ts @@ -15,19 +15,9 @@ import { resolveUrl } from "./browse-url"; const browse = new BeeCommand("browse") .summary("Open a Backlog page in the browser") .description( - `Open a Backlog page in the browser. + `With no arguments, opens the repository page (inside a Backlog repo) or the dashboard. -With no arguments, the behavior depends on context. Inside a Backlog Git -repository it opens the repository page; otherwise it opens the dashboard. - -When given an issue key (e.g. \`PROJECT-123\`), opens that issue. A bare -number like \`123\` is also accepted when the project can be inferred from -the Git remote. Use \`--project\` with section flags to navigate directly -to a specific project page. - -A file path opens the file in the Backlog Git viewer (e.g. \`src/main.ts\`). -Append \`:\` to jump to a specific line (e.g. \`src/main.ts:42\`). -Paths ending with \`/\` open the directory tree view.`, +Accepts an issue key (\`PROJECT-123\`), bare number (\`123\`, project inferred from Git remote), file path (\`src/main.ts\`), or path with line (\`src/main.ts:42\`). Paths ending with \`/\` open the directory tree. Use \`--project\` with section flags (e.g. \`--issues\`, \`--board\`) for project pages.`, ) .argument("[target]", "Issue key, issue number, file path, or project key") .addOption(opt.project().makeOptionMandatory(false).default(undefined)) diff --git a/apps/cli/src/commands/category/create.ts b/apps/cli/src/commands/category/create.ts index cf2ea2af..01a98354 100644 --- a/apps/cli/src/commands/category/create.ts +++ b/apps/cli/src/commands/category/create.ts @@ -7,11 +7,7 @@ import { resolveOptions } from "../../lib/required-option"; const create = new BeeCommand("create") .summary("Create a category") - .description( - `Create a new category in a Backlog project. - -If \`--name\` is not provided, you will be prompted interactively.`, - ) + .description(`Omitted fields will be prompted interactively.`) .addOption(opt.project()) .option("-n, --name ", "Category name") .addOption(opt.json()) diff --git a/apps/cli/src/commands/category/delete.ts b/apps/cli/src/commands/category/delete.ts index e4ca25e3..b8d98d1e 100644 --- a/apps/cli/src/commands/category/delete.ts +++ b/apps/cli/src/commands/category/delete.ts @@ -7,12 +7,7 @@ import { resolveOptions } from "../../lib/required-option"; const deleteCategory = new BeeCommand("delete") .summary("Delete a category") - .description( - `Delete a category from a Backlog project. - -This action is irreversible. You will be prompted for confirmation unless -\`--yes\` is provided.`, - ) + .description(`This action is irreversible.`) .argument("", "Category ID") .addOption(opt.project()) .option("-y, --yes", "Skip confirmation prompt") diff --git a/apps/cli/src/commands/category/edit.ts b/apps/cli/src/commands/category/edit.ts index 9452e022..10cf9beb 100644 --- a/apps/cli/src/commands/category/edit.ts +++ b/apps/cli/src/commands/category/edit.ts @@ -7,11 +7,7 @@ import { resolveOptions } from "../../lib/required-option"; const edit = new BeeCommand("edit") .summary("Edit a category") - .description( - `Update an existing category in a Backlog project. - -Renames the specified category.`, - ) + .description(`Renames the specified category.`) .argument("", "Category ID") .addOption(opt.project()) .option("-n, --name ", "New name of the category") diff --git a/apps/cli/src/commands/category/list.ts b/apps/cli/src/commands/category/list.ts index fabe9704..bb71d3b1 100644 --- a/apps/cli/src/commands/category/list.ts +++ b/apps/cli/src/commands/category/list.ts @@ -6,11 +6,7 @@ import * as opt from "../../lib/common-options"; const list = new BeeCommand("list") .summary("List categories") - .description( - `List categories in a Backlog project. - -Categories help organize issues by grouping them into logical areas.`, - ) + .description(`Categories help organize issues by grouping them into logical areas.`) .argument("[project]", "Project ID or project key") .addOption(opt.json()) .envVars([...ENV_AUTH, ENV_PROJECT]) diff --git a/apps/cli/src/commands/completion.ts b/apps/cli/src/commands/completion.ts index d71bcbc1..c7befe42 100644 --- a/apps/cli/src/commands/completion.ts +++ b/apps/cli/src/commands/completion.ts @@ -90,12 +90,7 @@ complete -c bee -n "__fish_use_subcommand" -a "completion" -d "completion comman const completion = new BeeCommand("completion") .summary("Generate shell completion scripts") - .description( - `Generate shell completion scripts for bee. - -The generated script should be sourced in your shell's configuration file. -Follow the instructions in the output for your specific shell.`, - ) + .description(`Supported shells: bash, zsh, fish. Source the output in your shell configuration.`) .argument("", "Shell to generate completions for") .examples([ { diff --git a/apps/cli/src/commands/dashboard.ts b/apps/cli/src/commands/dashboard.ts index f75d88ee..732c6d41 100644 --- a/apps/cli/src/commands/dashboard.ts +++ b/apps/cli/src/commands/dashboard.ts @@ -7,12 +7,7 @@ import * as opt from "../lib/common-options"; const dashboard = new BeeCommand("dashboard") .summary("Show a summary of your Backlog activity") .description( - `Show a summary of your Backlog activity. - -Displays your assigned issues sorted by due date, unread notification count, -and your projects. The layout is modeled after the Backlog web dashboard. - -Use \`--web\` to open the Backlog dashboard in your browser instead.`, + `Displays assigned issues, unread notifications, and projects. Use \`--web\` to open in the browser.`, ) .addOption(opt.json()) .addOption(opt.web("dashboard")) diff --git a/apps/cli/src/commands/document/attachments.ts b/apps/cli/src/commands/document/attachments.ts index 5c7d1935..526f542b 100644 --- a/apps/cli/src/commands/document/attachments.ts +++ b/apps/cli/src/commands/document/attachments.ts @@ -6,11 +6,7 @@ import * as opt from "../../lib/common-options"; const attachments = new BeeCommand("attachments") .summary("List document attachments") - .description( - `List attachments of a Backlog document. - -Shows file name, size, creator, and creation date.`, - ) + .description(`Shows file name, size, creator, and creation date.`) .argument("", "Document ID") .addOption(opt.json()) .envVars([...ENV_AUTH]) diff --git a/apps/cli/src/commands/document/create.ts b/apps/cli/src/commands/document/create.ts index 735dfad5..a05a255a 100644 --- a/apps/cli/src/commands/document/create.ts +++ b/apps/cli/src/commands/document/create.ts @@ -7,12 +7,7 @@ import * as opt from "../../lib/common-options"; const create = new BeeCommand("create") .summary("Create a document") .description( - `Create a new Backlog document. - -Requires a project and title. When run interactively, omitted required -fields will be prompted. - -When input is piped, it is used as the body automatically.`, + `Omitted required fields will be prompted interactively. When input is piped, it is used as the body automatically.`, ) .option("-p, --project ", "Project ID or project key") .option("-t, --title ", "Document title") diff --git a/apps/cli/src/commands/document/delete.ts b/apps/cli/src/commands/document/delete.ts index 1c7f9b49..c91b08d9 100644 --- a/apps/cli/src/commands/document/delete.ts +++ b/apps/cli/src/commands/document/delete.ts @@ -6,12 +6,7 @@ import * as opt from "../../lib/common-options"; const deleteDocument = new BeeCommand("delete") .summary("Delete a document") - .description( - `Delete a Backlog document. - -This action is irreversible. You will be prompted for confirmation unless -\`--yes\` is provided.`, - ) + .description(`This action is irreversible.`) .argument("", "Document ID") .option("-y, --yes", "Skip confirmation prompt") .addOption(opt.json()) diff --git a/apps/cli/src/commands/document/list.ts b/apps/cli/src/commands/document/list.ts index 944b0d35..6b255478 100644 --- a/apps/cli/src/commands/document/list.ts +++ b/apps/cli/src/commands/document/list.ts @@ -8,12 +8,7 @@ import { resolveOptions } from "../../lib/required-option"; const list = new BeeCommand("list") .summary("List documents") - .description( - `List documents from a Backlog project. - -Use \`--sort\` to change the sort field and \`--keyword\` to search within -document titles and content.`, - ) + .description(`Use \`--keyword\` to search within document titles and content.`) .addOption(opt.project()) .addOption(opt.keyword()) .option("--sort ", "Sort field {created|updated}") diff --git a/apps/cli/src/commands/document/tree.ts b/apps/cli/src/commands/document/tree.ts index 40f2a083..e963b9b9 100644 --- a/apps/cli/src/commands/document/tree.ts +++ b/apps/cli/src/commands/document/tree.ts @@ -35,11 +35,7 @@ const renderTree = (children: Entity.Document.DocumentTreeNode[]): string[] => { const tree = new BeeCommand("tree") .summary("Display document tree") - .description( - `Display the document tree structure of a Backlog project. - -Shows the hierarchical structure of documents with tree-style indentation.`, - ) + .description(`Shows the hierarchical structure of documents with tree-style indentation.`) .argument("[project]", "Project ID or project key", process.env.BACKLOG_PROJECT) .addOption(opt.json()) .envVars([...ENV_AUTH, ENV_PROJECT]) diff --git a/apps/cli/src/commands/document/view.ts b/apps/cli/src/commands/document/view.ts index a86aee77..587f1048 100644 --- a/apps/cli/src/commands/document/view.ts +++ b/apps/cli/src/commands/document/view.ts @@ -6,14 +6,7 @@ import * as opt from "../../lib/common-options"; const view = new BeeCommand("view") .summary("View a document") - .description( - `Display details of a Backlog document. - -Shows the document title, metadata, and body content. - -Use \`--web\` to open the document in your default browser instead. The -\`--project\` flag is required when using \`--web\`.`, - ) + .description(`Use \`--web\` to open in the browser (\`--project\` is required for \`--web\`).`) .argument("", "Document ID") .option("-p, --project ", "Project ID or project key (required for --web)") .addOption(opt.web("document")) diff --git a/apps/cli/src/commands/issue-type/create.ts b/apps/cli/src/commands/issue-type/create.ts index d2daf9f0..88c49974 100644 --- a/apps/cli/src/commands/issue-type/create.ts +++ b/apps/cli/src/commands/issue-type/create.ts @@ -7,12 +7,7 @@ import { resolveOptions } from "../../lib/required-option"; const create = new BeeCommand("create") .summary("Create an issue type") - .description( - `Create a new issue type in a Backlog project. - -If \`--name\` is not provided, you will be prompted interactively. -The \`--color\` flag must be one of the predefined Backlog colors.`, - ) + .description(`Omitted fields will be prompted interactively.`) .addOption(opt.project()) .option("-n, --name ", "Issue type name") .requiredOption( diff --git a/apps/cli/src/commands/issue-type/delete.ts b/apps/cli/src/commands/issue-type/delete.ts index d8568067..252481c0 100644 --- a/apps/cli/src/commands/issue-type/delete.ts +++ b/apps/cli/src/commands/issue-type/delete.ts @@ -8,14 +8,7 @@ import { resolveOptions } from "../../lib/required-option"; const deleteIssueType = new BeeCommand("delete") .summary("Delete an issue type") .description( - `Delete an issue type from a Backlog project. - -When deleting an issue type, all issues of that type must be reassigned -to another issue type. Use \`--substitute-issue-type-id\` to specify -the replacement. - -This action is irreversible. You will be prompted for confirmation unless -\`--yes\` is provided.`, + `All issues of this type are reassigned to the substitute issue type. This action is irreversible.`, ) .argument("", "Issue type ID") .addOption(opt.project()) diff --git a/apps/cli/src/commands/issue-type/edit.ts b/apps/cli/src/commands/issue-type/edit.ts index b9c70ddf..9f16190e 100644 --- a/apps/cli/src/commands/issue-type/edit.ts +++ b/apps/cli/src/commands/issue-type/edit.ts @@ -7,12 +7,7 @@ import { resolveOptions } from "../../lib/required-option"; const edit = new BeeCommand("edit") .summary("Edit an issue type") - .description( - `Update an existing issue type in a Backlog project. - -Only the specified fields will be updated. Fields that are not provided -will remain unchanged.`, - ) + .description(`Only specified fields are updated; others remain unchanged.`) .argument("", "Issue type ID") .addOption(opt.project()) .option("-n, --name ", "New name of the issue type") diff --git a/apps/cli/src/commands/issue-type/list.ts b/apps/cli/src/commands/issue-type/list.ts index c21e1144..d47ddf57 100644 --- a/apps/cli/src/commands/issue-type/list.ts +++ b/apps/cli/src/commands/issue-type/list.ts @@ -6,11 +6,7 @@ import * as opt from "../../lib/common-options"; const list = new BeeCommand("list") .summary("List issue types") - .description( - `List issue types in a Backlog project. - -Issue types categorize issues and are displayed with their associated color.`, - ) + .description(`Issue types categorize issues and are displayed with their associated color.`) .argument("[project]", "Project ID or project key") .addOption(opt.json()) .envVars([...ENV_AUTH, ENV_PROJECT]) diff --git a/apps/cli/src/commands/issue/attachments.ts b/apps/cli/src/commands/issue/attachments.ts index 83e4c3e4..048ab2af 100644 --- a/apps/cli/src/commands/issue/attachments.ts +++ b/apps/cli/src/commands/issue/attachments.ts @@ -6,11 +6,7 @@ import * as opt from "../../lib/common-options"; const attachments = new BeeCommand("attachments") .summary("List issue attachments") - .description( - `List attachments of a Backlog issue. - -Shows file name, size, creator, and creation date.`, - ) + .description(`Shows file name, size, creator, and creation date.`) .argument("", "Issue ID or issue key") .addOption(opt.json()) .envVars([...ENV_AUTH]) diff --git a/apps/cli/src/commands/issue/close.ts b/apps/cli/src/commands/issue/close.ts index 0c6abd4c..2978ca85 100644 --- a/apps/cli/src/commands/issue/close.ts +++ b/apps/cli/src/commands/issue/close.ts @@ -7,12 +7,7 @@ import * as opt from "../../lib/common-options"; const close = new BeeCommand("close") .summary("Close an issue") .description( - `Close a Backlog issue by setting its status to \`Closed\`. - -By default the resolution is set to \`Fixed\`. Use \`--resolution\` to -specify a different resolution. - -Optionally add a comment with \`--comment\`.`, + `Sets the status to Closed with resolution \`Fixed\` by default. Use \`--resolution\` for a different resolution.`, ) .argument("", "Issue ID or issue key") .option("-c, --comment ", "Comment to add when closing") diff --git a/apps/cli/src/commands/issue/comment.ts b/apps/cli/src/commands/issue/comment.ts index 83895014..3804615e 100644 --- a/apps/cli/src/commands/issue/comment.ts +++ b/apps/cli/src/commands/issue/comment.ts @@ -14,14 +14,9 @@ import * as opt from "../../lib/common-options"; const comment = new BeeCommand("comment") .summary("Add a comment to an issue") .description( - `Add a comment to a Backlog issue. + `When input is piped, it is used as the body automatically. -The comment body is required when adding a comment. When input is piped, -it is used as the body automatically. - -Use \`--list\` to list all comments on an issue. -Use \`--edit-last\` to edit your most recent comment. -Use \`--delete-last\` to delete your most recent comment.`, +Use \`--list\`, \`--edit-last\`, or \`--delete-last\` for other comment operations.`, ) .argument("", "Issue ID or issue key") .option("-b, --body ", "Comment body") diff --git a/apps/cli/src/commands/issue/count.ts b/apps/cli/src/commands/issue/count.ts index d679d1d3..b14b8cca 100644 --- a/apps/cli/src/commands/issue/count.ts +++ b/apps/cli/src/commands/issue/count.ts @@ -23,12 +23,7 @@ const resolvePriorityIds = (priorities: string[]): number[] => const count = new BeeCommand("count") .summary("Count issues") - .description( - `Count issues matching the given filter criteria. - -Accepts the same filter flags as \`bee issue list\`. Outputs a plain number -by default, or a JSON object with \`--json\`.`, - ) + .description(`Accepts the same filter flags as \`bee issue list\`.`) .addOption( new Option( "-p, --project ", diff --git a/apps/cli/src/commands/issue/create.ts b/apps/cli/src/commands/issue/create.ts index 0780ce8a..f9bdb73c 100644 --- a/apps/cli/src/commands/issue/create.ts +++ b/apps/cli/src/commands/issue/create.ts @@ -15,13 +15,7 @@ import * as opt from "../../lib/common-options"; const create = new BeeCommand("create") .summary("Create an issue") .description( - `Create a new Backlog issue. - -Requires a project, title, issue type, and priority. When run -interactively, omitted required fields will be prompted. - -Issue type accepts a numeric ID. Priority accepts a name: \`high\`, \`normal\`, -or \`low\`.`, + `Omitted required fields will be prompted interactively. Priority accepts a name: \`high\`, \`normal\`, or \`low\`.`, ) .addOption(new Option("-p, --project ", "Project ID or project key").env("BACKLOG_PROJECT")) .option("-t, --title ", "Issue title") diff --git a/apps/cli/src/commands/issue/delete.ts b/apps/cli/src/commands/issue/delete.ts index ca84b13b..3fb8148a 100644 --- a/apps/cli/src/commands/issue/delete.ts +++ b/apps/cli/src/commands/issue/delete.ts @@ -6,12 +6,7 @@ import * as opt from "../../lib/common-options"; const deleteIssue = new BeeCommand("delete") .summary("Delete an issue") - .description( - `Delete a Backlog issue. - -This action is irreversible. You will be prompted for confirmation unless -\`--yes\` is provided.`, - ) + .description(`This action is irreversible.`) .argument("", "Issue ID or issue key") .option("-y, --yes", "Skip confirmation prompt") .addOption(opt.json()) diff --git a/apps/cli/src/commands/issue/edit.ts b/apps/cli/src/commands/issue/edit.ts index a39ff77f..ec1100a1 100644 --- a/apps/cli/src/commands/issue/edit.ts +++ b/apps/cli/src/commands/issue/edit.ts @@ -6,12 +6,7 @@ import * as opt from "../../lib/common-options"; const edit = new BeeCommand("edit") .summary("Edit an issue") - .description( - `Update an existing Backlog issue. - -Only the specified fields will be updated. Fields that are not provided -will remain unchanged.`, - ) + .description(`Only specified fields are updated; others remain unchanged.`) .argument("", "Issue ID or issue key") .option("-t, --title ", "New title of the issue") .option("-d, --description ", "New description of the issue") diff --git a/apps/cli/src/commands/issue/list.ts b/apps/cli/src/commands/issue/list.ts index bf839b62..b9c91edb 100644 --- a/apps/cli/src/commands/issue/list.ts +++ b/apps/cli/src/commands/issue/list.ts @@ -24,12 +24,7 @@ const resolvePriorityIds = (priorities: string[]): number[] => const list = new BeeCommand("list") .summary("List issues") .description( - `List issues from one or more Backlog projects. - -By default, issues are sorted by last updated date in descending order. -Use filtering flags to narrow results by assignee, status, priority, and more. - -Multiple project keys can be specified as a comma-separated list.`, + `By default, sorted by last updated date in descending order. Multiple project keys can be comma-separated.`, ) .addOption( new Option( diff --git a/apps/cli/src/commands/issue/reopen.ts b/apps/cli/src/commands/issue/reopen.ts index 350ae756..fa051283 100644 --- a/apps/cli/src/commands/issue/reopen.ts +++ b/apps/cli/src/commands/issue/reopen.ts @@ -6,11 +6,7 @@ import * as opt from "../../lib/common-options"; const reopen = new BeeCommand("reopen") .summary("Reopen an issue") - .description( - `Reopen a closed Backlog issue by setting its status back to \`Open\`. - -Optionally add a comment with \`--comment\`.`, - ) + .description(`Sets the status back to Open.`) .argument("", "Issue ID or issue key") .option("-c, --comment ", "Comment to add when reopening") .addOption(opt.notify()) diff --git a/apps/cli/src/commands/issue/status.ts b/apps/cli/src/commands/issue/status.ts index 7f5a43f1..ec13ee6b 100644 --- a/apps/cli/src/commands/issue/status.ts +++ b/apps/cli/src/commands/issue/status.ts @@ -7,10 +7,7 @@ import * as opt from "../../lib/common-options"; const status = new BeeCommand("status") .summary("Show issue status summary for yourself") .description( - `Show a summary of issues assigned to you, grouped by status. - -Fetches issues where you are the assignee and displays them organized by -their current status (e.g., Open, In Progress, Resolved).`, + `Displays your assigned issues grouped by status (e.g., Open, In Progress, Resolved).`, ) .addOption(opt.json()) .envVars([...ENV_AUTH]) diff --git a/apps/cli/src/commands/issue/view.ts b/apps/cli/src/commands/issue/view.ts index 2c1d208f..44a6c76e 100644 --- a/apps/cli/src/commands/issue/view.ts +++ b/apps/cli/src/commands/issue/view.ts @@ -6,14 +6,7 @@ import * as opt from "../../lib/common-options"; const view = new BeeCommand("view") .summary("View an issue") - .description( - `Display details of a Backlog issue. - -Shows the issue summary, status, type, priority, assignee, dates, and -description. Use \`--comments\` to also fetch and display comments. - -Use \`--web\` to open the issue in your default browser instead.`, - ) + .description(`Use \`--comments\` to include comments. Use \`--web\` to open in the browser.`) .argument("", "Issue ID or issue key") .option("--comments", "Include comments") .addOption(opt.web("issue")) diff --git a/apps/cli/src/commands/milestone/create.ts b/apps/cli/src/commands/milestone/create.ts index 998a5beb..1d69b47c 100644 --- a/apps/cli/src/commands/milestone/create.ts +++ b/apps/cli/src/commands/milestone/create.ts @@ -7,12 +7,7 @@ import { resolveOptions } from "../../lib/required-option"; const create = new BeeCommand("create") .summary("Create a milestone") - .description( - `Create a new milestone in a Backlog project. - -If \`--name\` is not provided, you will be prompted interactively. -Use \`--start-date\` and \`--release-due-date\` to set the milestone schedule.`, - ) + .description(`Omitted fields will be prompted interactively.`) .addOption(opt.project()) .option("-n, --name ", "Milestone name") .option("-d, --description ", "Milestone description") diff --git a/apps/cli/src/commands/milestone/delete.ts b/apps/cli/src/commands/milestone/delete.ts index 2ee6d8fb..ffd131cf 100644 --- a/apps/cli/src/commands/milestone/delete.ts +++ b/apps/cli/src/commands/milestone/delete.ts @@ -7,12 +7,7 @@ import { resolveOptions } from "../../lib/required-option"; const deleteMilestone = new BeeCommand("delete") .summary("Delete a milestone") - .description( - `Delete a milestone from a Backlog project. - -This action is irreversible. You will be prompted for confirmation unless -\`--yes\` is provided.`, - ) + .description(`This action is irreversible.`) .argument("", "Milestone ID") .addOption(opt.project()) .option("-y, --yes", "Skip confirmation prompt") diff --git a/apps/cli/src/commands/milestone/edit.ts b/apps/cli/src/commands/milestone/edit.ts index 91f5984c..6aec90a7 100644 --- a/apps/cli/src/commands/milestone/edit.ts +++ b/apps/cli/src/commands/milestone/edit.ts @@ -7,13 +7,7 @@ import { resolveOptions } from "../../lib/required-option"; const edit = new BeeCommand("edit") .summary("Edit a milestone") - .description( - `Update an existing milestone in a Backlog project. - -Only the specified fields will be updated. Fields that are not provided -will remain unchanged. Use \`--archived\` to archive or \`--no-archived\` to -unarchive a milestone.`, - ) + .description(`Only specified fields are updated; others remain unchanged.`) .argument("", "Milestone ID") .addOption(opt.project()) .requiredOption("-n, --name ", "New name of the milestone") diff --git a/apps/cli/src/commands/milestone/list.ts b/apps/cli/src/commands/milestone/list.ts index 19a0fc61..05b138c7 100644 --- a/apps/cli/src/commands/milestone/list.ts +++ b/apps/cli/src/commands/milestone/list.ts @@ -7,10 +7,7 @@ import * as opt from "../../lib/common-options"; const list = new BeeCommand("list") .summary("List milestones") .description( - `List milestones in a Backlog project. - -Milestones (also known as versions) help track release schedules and -group issues by development cycle.`, + `Milestones (versions) track release schedules and group issues by development cycle.`, ) .argument("[project]", "Project ID or project key") .addOption(opt.json()) diff --git a/apps/cli/src/commands/notification/count.ts b/apps/cli/src/commands/notification/count.ts index 0bd17331..8b415bfc 100644 --- a/apps/cli/src/commands/notification/count.ts +++ b/apps/cli/src/commands/notification/count.ts @@ -14,13 +14,10 @@ const parseReadFilter = (value: string | undefined): boolean | undefined => { const count = new BeeCommand("count") .summary("Count notifications") .description( - `Display the count of notifications for the authenticated user. + `By default, counts all notifications regardless of read status. -By default, returns the count of all notifications regardless of read status. -Use \`--already-read\` and \`--resource-already-read\` to filter by read status. - -For details, see: -https://developer.nulab.com/docs/backlog/api/2/count-notifications/`, +For details, see: +https://developer.nulab.com/docs/backlog/api/2/count-notification/`, ) .option( "--already-read ", diff --git a/apps/cli/src/commands/notification/list.ts b/apps/cli/src/commands/notification/list.ts index decb00ac..b36c736a 100644 --- a/apps/cli/src/commands/notification/list.ts +++ b/apps/cli/src/commands/notification/list.ts @@ -7,11 +7,7 @@ import * as opt from "../../lib/common-options"; const list = new BeeCommand("list") .summary("List notifications") .description( - `List notifications for the authenticated user. - -Unread notifications are marked with an asterisk (\`*\`). Use \`--count\` to -control the number of notifications returned, and \`--min-id\` / \`--max-id\` -for cursor-based pagination.`, + `Unread notifications are marked with \`*\`. Use \`--min-id\` / \`--max-id\` for cursor-based pagination.`, ) .addOption(opt.count()) .addOption(opt.minId()) diff --git a/apps/cli/src/commands/notification/read-all.ts b/apps/cli/src/commands/notification/read-all.ts index 09f88db7..c2974f68 100644 --- a/apps/cli/src/commands/notification/read-all.ts +++ b/apps/cli/src/commands/notification/read-all.ts @@ -4,9 +4,7 @@ import { BeeCommand, ENV_AUTH } from "../../lib/bee-command"; const readAll = new BeeCommand("read-all") .summary("Mark all notifications as read") - .description(`Mark all notifications as read. - -This resets the unread notification count to zero.`) + .description(`Resets the unread notification count to zero.`) .envVars([...ENV_AUTH]) .examples([ { description: "Mark all notifications as read", command: "bee notification read-all" }, diff --git a/apps/cli/src/commands/notification/read.ts b/apps/cli/src/commands/notification/read.ts index 88ce959a..7ac0e6af 100644 --- a/apps/cli/src/commands/notification/read.ts +++ b/apps/cli/src/commands/notification/read.ts @@ -4,12 +4,7 @@ import { BeeCommand, ENV_AUTH } from "../../lib/bee-command"; const read = new BeeCommand("read") .summary("Mark a notification as read") - .description( - `Mark a notification as read. - -Specify the notification ID to mark as read. Use \`bee notification list\` -to find notification IDs.`, - ) + .description(`Use \`bee notification list\` to find notification IDs.`) .argument("", "Notification ID") .envVars([...ENV_AUTH]) .examples([ diff --git a/apps/cli/src/commands/pr/comment.ts b/apps/cli/src/commands/pr/comment.ts index 463f1462..72bc586f 100644 --- a/apps/cli/src/commands/pr/comment.ts +++ b/apps/cli/src/commands/pr/comment.ts @@ -8,13 +8,9 @@ import { resolveOptions } from "../../lib/required-option"; const comment = new BeeCommand("comment") .summary("Add a comment to a pull request") .description( - `Add a comment to a Backlog pull request. + `When input is piped, it is used as the body automatically. -The comment body is required when adding a comment. When input is piped, -it is used as the body automatically. - -Use \`--list\` to list all comments on a pull request. -Use \`--edit-last\` to edit your most recent comment.`, +Use \`--list\` or \`--edit-last\` for other comment operations.`, ) .argument("", "Pull request number") .addOption(opt.project()) diff --git a/apps/cli/src/commands/pr/comments.ts b/apps/cli/src/commands/pr/comments.ts index 5f25a910..4237403d 100644 --- a/apps/cli/src/commands/pr/comments.ts +++ b/apps/cli/src/commands/pr/comments.ts @@ -7,11 +7,7 @@ import { resolveOptions } from "../../lib/required-option"; const comments = new BeeCommand("comments") .summary("List comments on a pull request") - .description( - `List comments on a Backlog pull request. - -Displays all comments in chronological order with the author and date.`, - ) + .description(`Displays all comments in chronological order.`) .argument("", "Pull request number") .addOption(opt.project()) .addOption(opt.repo()) diff --git a/apps/cli/src/commands/pr/count.ts b/apps/cli/src/commands/pr/count.ts index eb16e337..0f54c9b9 100644 --- a/apps/cli/src/commands/pr/count.ts +++ b/apps/cli/src/commands/pr/count.ts @@ -17,12 +17,7 @@ const resolveStatusIds = (statuses: string[]): number[] => const count = new BeeCommand("count") .summary("Count pull requests") - .description( - `Count pull requests in a Backlog repository. - -Accepts the same status filter as \`bee pr list\`. Outputs a plain number -by default, or a JSON object with \`--json\`.`, - ) + .description(`Accepts the same filter flags as \`bee pr list\`.`) .addOption(opt.project()) .addOption(opt.repo()) .option("-S, --status ", "Status name (repeatable)", collect, [] satisfies string[]) diff --git a/apps/cli/src/commands/pr/create.ts b/apps/cli/src/commands/pr/create.ts index c255c622..a10d68da 100644 --- a/apps/cli/src/commands/pr/create.ts +++ b/apps/cli/src/commands/pr/create.ts @@ -7,12 +7,7 @@ import { resolveOptions } from "../../lib/required-option"; const create = new BeeCommand("create") .summary("Create a pull request") - .description( - `Create a new pull request in a Backlog repository. - -Requires a base branch, head branch, title, and description. When run -interactively, omitted required fields will be prompted.`, - ) + .description(`Omitted required fields will be prompted interactively.`) .addOption(opt.project()) .addOption(opt.repo()) .option("--base ", "Base branch name") diff --git a/apps/cli/src/commands/pr/edit.ts b/apps/cli/src/commands/pr/edit.ts index dd05a943..55721ecb 100644 --- a/apps/cli/src/commands/pr/edit.ts +++ b/apps/cli/src/commands/pr/edit.ts @@ -7,12 +7,7 @@ import { resolveOptions } from "../../lib/required-option"; const edit = new BeeCommand("edit") .summary("Edit a pull request") - .description( - `Update an existing Backlog pull request. - -Only the specified fields will be updated. Fields that are not provided -will remain unchanged.`, - ) + .description(`Only specified fields are updated; others remain unchanged.`) .argument("", "Pull request number") .addOption(opt.project()) .addOption(opt.repo()) diff --git a/apps/cli/src/commands/pr/list.ts b/apps/cli/src/commands/pr/list.ts index ad5519d8..f9e39f0e 100644 --- a/apps/cli/src/commands/pr/list.ts +++ b/apps/cli/src/commands/pr/list.ts @@ -17,12 +17,7 @@ const resolveStatusIds = (statuses: string[]): number[] => const list = new BeeCommand("list") .summary("List pull requests") - .description( - `List pull requests in a Backlog repository. - -By default, all pull requests are returned. Use \`--status\` to filter by -status (open, closed, merged).`, - ) + .description(`Use \`--status\` to filter by status (open, closed, merged).`) .addOption(opt.project()) .addOption(opt.repo()) .option("-S, --status ", "Status name (repeatable)", collect, [] satisfies string[]) diff --git a/apps/cli/src/commands/pr/status.ts b/apps/cli/src/commands/pr/status.ts index 85e237b9..0a1c5cb3 100644 --- a/apps/cli/src/commands/pr/status.ts +++ b/apps/cli/src/commands/pr/status.ts @@ -7,12 +7,7 @@ import { resolveOptions } from "../../lib/required-option"; const status = new BeeCommand("status") .summary("Show pull request status summary for yourself") - .description( - `Show a summary of pull requests assigned to you, grouped by status. - -Fetches pull requests where you are the assignee and displays them -organized by their current status (Open, Closed, Merged).`, - ) + .description(`Displays your assigned pull requests grouped by status (Open, Closed, Merged).`) .addOption(opt.project()) .addOption(opt.repo()) .addOption(opt.json()) diff --git a/apps/cli/src/commands/pr/view.ts b/apps/cli/src/commands/pr/view.ts index f8ff1440..ffba8eea 100644 --- a/apps/cli/src/commands/pr/view.ts +++ b/apps/cli/src/commands/pr/view.ts @@ -7,14 +7,7 @@ import { resolveOptions } from "../../lib/required-option"; const view = new BeeCommand("view") .summary("View a pull request") - .description( - `Display details of a Backlog pull request. - -Shows the pull request summary, status, assignee, base/head branches, -and description. - -Use \`--web\` to open the pull request in your default browser instead.`, - ) + .description(`Use \`--web\` to open in the browser.`) .argument("", "Pull request number") .addOption(opt.project()) .addOption(opt.repo()) diff --git a/apps/cli/src/commands/project/activities.ts b/apps/cli/src/commands/project/activities.ts index 2490a652..da2350df 100644 --- a/apps/cli/src/commands/project/activities.ts +++ b/apps/cli/src/commands/project/activities.ts @@ -35,16 +35,10 @@ const getActivitySummary = (activity: { const activities = new BeeCommand("activities") .summary("List project activities") .description( - `List recent activities of a Backlog project. + `Results are ordered by most recent first. Use \`--activity-type\` to filter by type. -Shows the most recent updates including issue changes, wiki edits, git pushes, -and other project activities. Results are ordered by most recent first. - -Use \`--activity-type\` to filter by specific activity types (repeatable). -Use \`--count\` to control how many activities are returned (default: 20, max: 100). - -For a list of activity type IDs, see: -https://developer.nulab.com/docs/backlog/api/2/get-project-recent-updates/#activity-type`, +For activity type IDs, see: +https://developer.nulab.com/docs/backlog/api/2/get-project-recent-updates/#response-description`, ) .argument("", "Project ID or project key") .option( diff --git a/apps/cli/src/commands/project/add-user.ts b/apps/cli/src/commands/project/add-user.ts index 37b1129c..2d3f210f 100644 --- a/apps/cli/src/commands/project/add-user.ts +++ b/apps/cli/src/commands/project/add-user.ts @@ -7,14 +7,7 @@ import { RequiredOption, resolveOptions } from "../../lib/required-option"; const addUser = new BeeCommand("add-user") .summary("Add a user to a project") - .description( - `Add a user to a Backlog project. - -The user is specified by their numeric user ID. Use \`bee project users\` -to look up user IDs. - -Requires Administrator or Project Administrator role.`, - ) + .description(`Use \`bee project users\` to look up user IDs.`) .addOption(opt.project()) .addOption(new RequiredOption("--user-id ", "User ID")) .addOption(opt.json()) diff --git a/apps/cli/src/commands/project/create.ts b/apps/cli/src/commands/project/create.ts index 811b7506..eb95f7f6 100644 --- a/apps/cli/src/commands/project/create.ts +++ b/apps/cli/src/commands/project/create.ts @@ -7,11 +7,7 @@ import * as opt from "../../lib/common-options"; const create = new BeeCommand("create") .summary("Create a project") .description( - `Create a new Backlog project. - -Project key must consist of uppercase letters (A\u2013Z), numbers (0\u20139), and -underscores (\`_\`). If \`--name\` or \`--key\` is not provided, you will be -prompted interactively.`, + `Project key must consist of uppercase letters, numbers, and underscores. Omitted fields will be prompted interactively.`, ) .option("-k, --key ", "Project key") .option("-n, --name ", "Project name") diff --git a/apps/cli/src/commands/project/delete.ts b/apps/cli/src/commands/project/delete.ts index f3d47764..c8e7a64d 100644 --- a/apps/cli/src/commands/project/delete.ts +++ b/apps/cli/src/commands/project/delete.ts @@ -6,14 +6,7 @@ import * as opt from "../../lib/common-options"; const deleteProject = new BeeCommand("delete") .summary("Delete a project") - .description( - `Delete a Backlog project. - -This action is irreversible. You will be prompted for confirmation unless -\`--yes\` is provided. - -Requires Administrator role.`, - ) + .description(`This action is irreversible. Requires Administrator role.`) .argument("", "Project ID or project key") .option("-y, --yes", "Skip confirmation prompt") .addOption(opt.json()) diff --git a/apps/cli/src/commands/project/edit.ts b/apps/cli/src/commands/project/edit.ts index 331b369b..99599a8e 100644 --- a/apps/cli/src/commands/project/edit.ts +++ b/apps/cli/src/commands/project/edit.ts @@ -6,12 +6,7 @@ import * as opt from "../../lib/common-options"; const edit = new BeeCommand("edit") .summary("Edit a project") - .description( - `Update an existing Backlog project. - -Only the specified fields will be updated. Fields that are not provided -will remain unchanged.`, - ) + .description(`Only specified fields are updated; others remain unchanged.`) .argument("", "Project ID or project key") .option("-n, --name ", "New name of the project") .option("-k, --key ", "New key of the project") diff --git a/apps/cli/src/commands/project/list.ts b/apps/cli/src/commands/project/list.ts index a3e90997..f8a867f2 100644 --- a/apps/cli/src/commands/project/list.ts +++ b/apps/cli/src/commands/project/list.ts @@ -7,13 +7,7 @@ import * as opt from "../../lib/common-options"; const list = new BeeCommand("list") .summary("List projects") .description( - `List projects accessible to the authenticated user. - -By default, only active (non-archived) projects are shown. Use \`--archived\` -to include archived projects. - -Administrators can use \`--all\` to list every project in the space, not just -the ones they have joined.`, + `By default, only active (non-archived) projects are shown. Use \`--all\` to list all projects in the space (admin only).`, ) .option("--archived", "Include archived projects") .option("--all", "Include all projects (admin only)") diff --git a/apps/cli/src/commands/project/remove-user.ts b/apps/cli/src/commands/project/remove-user.ts index bb780b2b..bb807781 100644 --- a/apps/cli/src/commands/project/remove-user.ts +++ b/apps/cli/src/commands/project/remove-user.ts @@ -7,14 +7,7 @@ import { RequiredOption, resolveOptions } from "../../lib/required-option"; const removeUser = new BeeCommand("remove-user") .summary("Remove a user from a project") - .description( - `Remove a user from a Backlog project. - -The user is specified by their numeric user ID. Use \`bee project users\` -to look up user IDs. - -Requires Administrator or Project Administrator role.`, - ) + .description(`Use \`bee project users\` to look up user IDs.`) .addOption(opt.project()) .addOption(new RequiredOption("--user-id ", "User ID")) .addOption(opt.json()) diff --git a/apps/cli/src/commands/project/users.ts b/apps/cli/src/commands/project/users.ts index 1fda7e53..9f192071 100644 --- a/apps/cli/src/commands/project/users.ts +++ b/apps/cli/src/commands/project/users.ts @@ -6,11 +6,7 @@ import * as opt from "../../lib/common-options"; const users = new BeeCommand("users") .summary("List project users") - .description( - `List members of a Backlog project. - -Displays each user's ID, user ID, name, and role within the project.`, - ) + .description(`Displays each member's ID, name, and role.`) .argument("", "Project ID or project key") .addOption(opt.json()) .envVars([...ENV_AUTH, ENV_PROJECT]) diff --git a/apps/cli/src/commands/project/view.ts b/apps/cli/src/commands/project/view.ts index 7f460dc2..bbd6e36f 100644 --- a/apps/cli/src/commands/project/view.ts +++ b/apps/cli/src/commands/project/view.ts @@ -6,14 +6,7 @@ import * as opt from "../../lib/common-options"; const view = new BeeCommand("view") .summary("View a project") - .description( - `Display details of a Backlog project. - -Shows project settings including chart, subtasking, wiki, file sharing, -and git/subversion integration status. - -Use \`--web\` to open the project in your default browser instead.`, - ) + .description(`Use \`--web\` to open in the browser.`) .argument("", "Project ID or project key") .addOption(opt.web("project")) .addOption(opt.noBrowser()) diff --git a/apps/cli/src/commands/repo/clone.ts b/apps/cli/src/commands/repo/clone.ts index 759bd086..b74ed4dd 100644 --- a/apps/cli/src/commands/repo/clone.ts +++ b/apps/cli/src/commands/repo/clone.ts @@ -20,15 +20,7 @@ const gitClone = (gitArgs: string[]): Promise => const clone = new BeeCommand("clone") .summary("Clone a repository") - .description( - `Clone a Backlog Git repository. - -Fetches the repository metadata to obtain the clone URL, then runs -\`git clone\` as a subprocess. By default the SSH URL is used; pass -\`--http\` to clone over HTTPS instead. - -Use \`--directory\` to specify a custom destination directory.`, - ) + .description(`By default the SSH URL is used; pass \`--http\` to clone over HTTPS instead.`) .argument("", "Repository name or ID") .addOption(opt.project()) .option("-d, --directory ", "Directory to clone into") diff --git a/apps/cli/src/commands/repo/list.ts b/apps/cli/src/commands/repo/list.ts index 8f33be64..723807ef 100644 --- a/apps/cli/src/commands/repo/list.ts +++ b/apps/cli/src/commands/repo/list.ts @@ -6,11 +6,7 @@ import * as opt from "../../lib/common-options"; const list = new BeeCommand("list") .summary("List repositories in a project") - .description( - `List Git repositories in a Backlog project. - -By default, repositories are listed in the configured display order.`, - ) + .description(`Repositories are listed in the configured display order.`) .argument("", "Project ID or project key") .addOption(opt.json()) .envVars([...ENV_AUTH, ENV_PROJECT]) diff --git a/apps/cli/src/commands/repo/view.ts b/apps/cli/src/commands/repo/view.ts index 17997eeb..a5a3b541 100644 --- a/apps/cli/src/commands/repo/view.ts +++ b/apps/cli/src/commands/repo/view.ts @@ -7,14 +7,7 @@ import { resolveOptions } from "../../lib/required-option"; const view = new BeeCommand("view") .summary("View a repository") - .description( - `Display details of a Git repository in a Backlog project. - -Shows repository name, description, HTTP and SSH clone URLs, size, -creation and update timestamps. - -Use \`--web\` to open the repository in your default browser instead.`, - ) + .description(`Use \`--web\` to open in the browser.`) .argument("", "Repository name or ID") .addOption(opt.project()) .addOption(opt.web("repository")) diff --git a/apps/cli/src/commands/space/activities.ts b/apps/cli/src/commands/space/activities.ts index 4ab66072..2bd31f69 100644 --- a/apps/cli/src/commands/space/activities.ts +++ b/apps/cli/src/commands/space/activities.ts @@ -35,14 +35,10 @@ const getActivitySummary = (activity: { const activities = new BeeCommand("activities") .summary("List space activities") .description( - `List recent activities across the Backlog space. + `Results are ordered by most recent first. Use \`--activity-type\` to filter by type. -Shows the most recent updates across the entire space, including -issue changes, wiki edits, git pushes, and other activities. Results are -ordered by most recent first. - -Use \`--activity-type\` to filter by specific activity types (repeatable). -Use \`--count\` to control how many activities are returned (default: 20, max: 100).`, +For activity type IDs, see: +https://developer.nulab.com/docs/backlog/api/2/get-recent-updates/#response-description`, ) .option( "--activity-type ", diff --git a/apps/cli/src/commands/star/add.ts b/apps/cli/src/commands/star/add.ts index a1bbaa30..0d13830f 100644 --- a/apps/cli/src/commands/star/add.ts +++ b/apps/cli/src/commands/star/add.ts @@ -7,11 +7,7 @@ import * as opt from "../../lib/common-options"; const add = new BeeCommand("add") .summary("Add a star") .description( - `Add a star to an issue, comment, wiki page, or pull request comment. - -Exactly one of \`--issue\`, \`--comment\`, \`--wiki\`, or \`--pr-comment\` must be -provided. The \`--issue\` flag accepts an issue key (e.g., PROJECT-123) or a -numeric ID. Other flags require numeric IDs.`, + `Specify exactly one target: \`--issue\` (accepts key or ID), \`--comment\`, \`--wiki\`, or \`--pr-comment\`.`, ) .addOption(opt.issue()) .option("--comment ", "Comment ID to star") diff --git a/apps/cli/src/commands/star/count.ts b/apps/cli/src/commands/star/count.ts index 8be5d9e4..11e701a7 100644 --- a/apps/cli/src/commands/star/count.ts +++ b/apps/cli/src/commands/star/count.ts @@ -6,12 +6,7 @@ import * as opt from "../../lib/common-options"; const count = new BeeCommand("count") .summary("Count received stars") - .description( - `Count stars received by a user. - -If no user ID is specified, counts stars for the authenticated user. Use -\`--since\` and \`--until\` to filter by date range.`, - ) + .description(`Defaults to the authenticated user if no user ID is given.`) .argument("[user]", "User ID") .option("--since ", "Count stars received on or after this date") .option("--until ", "Count stars received on or before this date") diff --git a/apps/cli/src/commands/star/list.ts b/apps/cli/src/commands/star/list.ts index a667b4be..e7862b91 100644 --- a/apps/cli/src/commands/star/list.ts +++ b/apps/cli/src/commands/star/list.ts @@ -6,11 +6,7 @@ import * as opt from "../../lib/common-options"; const list = new BeeCommand("list") .summary("List received stars") - .description( - `List stars received by a user. - -If no user ID is specified, lists stars for the authenticated user.`, - ) + .description(`Defaults to the authenticated user if no user ID is given.`) .argument("[user]", "User ID") .addOption(opt.json()) .envVars([...ENV_AUTH]) diff --git a/apps/cli/src/commands/star/remove.ts b/apps/cli/src/commands/star/remove.ts index af228d4a..3c560f03 100644 --- a/apps/cli/src/commands/star/remove.ts +++ b/apps/cli/src/commands/star/remove.ts @@ -4,11 +4,7 @@ import { BeeCommand, ENV_AUTH } from "../../lib/bee-command"; const remove = new BeeCommand("remove") .summary("Remove a star") - .description( - `Remove a star. - -Use \`bee star list\` to find star IDs.`, - ) + .description(`Use \`bee star list\` to find star IDs.`) .argument("", "Star ID") .envVars([...ENV_AUTH]) .examples([{ description: "Remove a star", command: "bee star remove 12345" }]) diff --git a/apps/cli/src/commands/status/create.ts b/apps/cli/src/commands/status/create.ts index b7d4d3ff..cf0e1ad0 100644 --- a/apps/cli/src/commands/status/create.ts +++ b/apps/cli/src/commands/status/create.ts @@ -7,12 +7,7 @@ import { resolveOptions } from "../../lib/required-option"; const create = new BeeCommand("create") .summary("Create a status") - .description( - `Create a new status in a Backlog project. - -If \`--name\` is not provided, you will be prompted interactively. -The \`--color\` flag must be one of the predefined Backlog colors.`, - ) + .description(`Omitted fields will be prompted interactively.`) .addOption(opt.project()) .option("-n, --name ", "Status name") .requiredOption( diff --git a/apps/cli/src/commands/status/delete.ts b/apps/cli/src/commands/status/delete.ts index 4cb9377b..b10706f3 100644 --- a/apps/cli/src/commands/status/delete.ts +++ b/apps/cli/src/commands/status/delete.ts @@ -8,14 +8,7 @@ import { resolveOptions } from "../../lib/required-option"; const deleteStatus = new BeeCommand("delete") .summary("Delete a status") .description( - `Delete a status from a Backlog project. - -When deleting a status, all issues with that status must be reassigned -to another status. Use \`--substitute-status-id\` to specify -the replacement. - -This action is irreversible. You will be prompted for confirmation unless -\`--yes\` is provided.`, + `All issues with this status are reassigned to the substitute status. This action is irreversible.`, ) .argument("", "Status ID") .addOption(opt.project()) diff --git a/apps/cli/src/commands/status/edit.ts b/apps/cli/src/commands/status/edit.ts index 0d487a1f..cd9c4041 100644 --- a/apps/cli/src/commands/status/edit.ts +++ b/apps/cli/src/commands/status/edit.ts @@ -7,12 +7,7 @@ import { resolveOptions } from "../../lib/required-option"; const edit = new BeeCommand("edit") .summary("Edit a status") - .description( - `Update an existing status in a Backlog project. - -Only the specified fields will be updated. Fields that are not provided -will remain unchanged.`, - ) + .description(`Only specified fields are updated; others remain unchanged.`) .argument("", "Status ID") .addOption(opt.project()) .option("-n, --name ", "New name of the status") diff --git a/apps/cli/src/commands/status/list.ts b/apps/cli/src/commands/status/list.ts index ea332f4d..c2f3319e 100644 --- a/apps/cli/src/commands/status/list.ts +++ b/apps/cli/src/commands/status/list.ts @@ -6,12 +6,7 @@ import * as opt from "../../lib/common-options"; const list = new BeeCommand("list") .summary("List statuses") - .description( - `List statuses in a Backlog project. - -Statuses define the workflow states that issues can move through. -Each status is displayed with its associated color.`, - ) + .description(`Statuses define the workflow states that issues move through.`) .argument("[project]", "Project ID or project key") .addOption(opt.json()) .envVars([...ENV_AUTH, ENV_PROJECT]) diff --git a/apps/cli/src/commands/team/list.ts b/apps/cli/src/commands/team/list.ts index 9d89c5fd..3f2c617d 100644 --- a/apps/cli/src/commands/team/list.ts +++ b/apps/cli/src/commands/team/list.ts @@ -7,13 +7,7 @@ import * as opt from "../../lib/common-options"; const list = new BeeCommand("list") .summary("List teams") - .description( - `List teams in the space. - -Teams are groups of users that can be assigned to projects collectively. -Use \`--order\` to control sort direction and \`--offset\` / \`--count\` for -pagination.`, - ) + .description(`Teams are groups of users that can be assigned to projects collectively.`) .addOption(opt.json()) .addOption(opt.order()) .addOption(opt.offset()) diff --git a/apps/cli/src/commands/team/view.ts b/apps/cli/src/commands/team/view.ts index 64f214fa..f93c77cd 100644 --- a/apps/cli/src/commands/team/view.ts +++ b/apps/cli/src/commands/team/view.ts @@ -6,12 +6,7 @@ import * as opt from "../../lib/common-options"; const view = new BeeCommand("view") .summary("View a team") - .description( - `Display details of a Backlog team. - -Shows team name, ID, creator, creation date, and the list of members -belonging to the team.`, - ) + .description(`Shows team details and the list of members.`) .argument("", "Team ID") .addOption(opt.json()) .envVars([...ENV_AUTH]) diff --git a/apps/cli/src/commands/user/activities.ts b/apps/cli/src/commands/user/activities.ts index 9fff71d1..67eeb657 100644 --- a/apps/cli/src/commands/user/activities.ts +++ b/apps/cli/src/commands/user/activities.ts @@ -35,17 +35,10 @@ const getActivitySummary = (activity: { const activities = new BeeCommand("activities") .summary("List user activities") .description( - `List recent activities of a Backlog user. + `Results are ordered by most recent first. Use \`--activity-type\` to filter by type. -Shows the most recent updates performed by the specified user, including -issue changes, wiki edits, git pushes, and other activities. Results are -ordered by most recent first. - -Use \`--activity-type\` to filter by specific activity types (repeatable). -Use \`--count\` to control how many activities are returned (default: 20, max: 100). - -For a list of activity type IDs, see: -https://developer.nulab.com/docs/backlog/api/2/get-user-recent-updates/#activity-type`, +For activity type IDs, see: +https://developer.nulab.com/docs/backlog/api/2/get-user-recent-updates/#response-description`, ) .argument("", "User ID") .option( diff --git a/apps/cli/src/commands/user/list.ts b/apps/cli/src/commands/user/list.ts index 82b3c353..ae3782aa 100644 --- a/apps/cli/src/commands/user/list.ts +++ b/apps/cli/src/commands/user/list.ts @@ -6,12 +6,7 @@ import * as opt from "../../lib/common-options"; const list = new BeeCommand("list") .summary("List users") - .description( - `List all users in the Backlog space. - -Displays each user's ID, user ID, name, and role. Only space administrators -can see the full list of users.`, - ) + .description(`Only space administrators can see the full list of users.`) .addOption(opt.json()) .envVars([...ENV_AUTH]) .examples([ diff --git a/apps/cli/src/commands/user/me.ts b/apps/cli/src/commands/user/me.ts index 6f4cdc18..f4e83da4 100644 --- a/apps/cli/src/commands/user/me.ts +++ b/apps/cli/src/commands/user/me.ts @@ -6,13 +6,7 @@ import * as opt from "../../lib/common-options"; const me = new BeeCommand("me") .summary("View the authenticated user") - .description( - `Display details of the authenticated user. - -This is a shortcut for \`bee user view\` that automatically looks up the -currently authenticated user. Shows the same profile information: name, -user ID, email address, role, language, and last login time.`, - ) + .description(`Shortcut for \`bee user view\` using the currently authenticated user.`) .addOption(opt.json()) .envVars([...ENV_AUTH]) .examples([ diff --git a/apps/cli/src/commands/user/view.ts b/apps/cli/src/commands/user/view.ts index 48df41ea..b1f7f8b6 100644 --- a/apps/cli/src/commands/user/view.ts +++ b/apps/cli/src/commands/user/view.ts @@ -6,14 +6,7 @@ import * as opt from "../../lib/common-options"; const view = new BeeCommand("view") .summary("View a user") - .description( - `Display details of a Backlog user. - -Shows user profile information including name, user ID, email address, -role, language, and last login time. - -Use \`bee user me\` as a shortcut to view your own profile.`, - ) + .description(`Use \`bee user me\` as a shortcut to view your own profile.`) .argument("", "User ID") .addOption(opt.json()) .envVars([...ENV_AUTH]) diff --git a/apps/cli/src/commands/watching/add.ts b/apps/cli/src/commands/watching/add.ts index e908c4fd..81004f84 100644 --- a/apps/cli/src/commands/watching/add.ts +++ b/apps/cli/src/commands/watching/add.ts @@ -6,12 +6,7 @@ import * as opt from "../../lib/common-options"; const add = new BeeCommand("add") .summary("Add a watching item") - .description( - `Add an issue to your watching list. - -Subscribe to an issue to receive notifications when it is updated. Optionally -attach a note for your own reference.`, - ) + .description(`Subscribe to an issue to receive update notifications.`) .requiredOption("--issue ", "Issue ID or issue key") .option("--note ", "Note to attach to the watching item") .addOption(opt.json()) diff --git a/apps/cli/src/commands/watching/delete.ts b/apps/cli/src/commands/watching/delete.ts index b38ef91f..286be05c 100644 --- a/apps/cli/src/commands/watching/delete.ts +++ b/apps/cli/src/commands/watching/delete.ts @@ -7,11 +7,7 @@ import * as opt from "../../lib/common-options"; const deleteWatching = new BeeCommand("delete") .summary("Delete a watching item") .description( - `Delete a watching item. - -This removes the issue from your watching list. You will no longer receive -notifications for updates to the issue. You will be prompted for confirmation -unless \`--yes\` is provided.`, + `Removes the issue from your watching list. You will no longer receive update notifications.`, ) .argument("", "Watching ID") .option("-y, --yes", "Skip confirmation prompt") diff --git a/apps/cli/src/commands/watching/list.ts b/apps/cli/src/commands/watching/list.ts index 10898450..cc471c4e 100644 --- a/apps/cli/src/commands/watching/list.ts +++ b/apps/cli/src/commands/watching/list.ts @@ -6,12 +6,7 @@ import * as opt from "../../lib/common-options"; const list = new BeeCommand("list") .summary("List watching items") - .description( - `List watching items for the authenticated user. - -Watching items are issue subscriptions. Unread items are marked with an -asterisk (\`*\`).`, - ) + .description(`Unread items are marked with an asterisk (\`*\`).`) .addOption(opt.json()) .envVars([...ENV_AUTH]) .examples([ diff --git a/apps/cli/src/commands/watching/read.ts b/apps/cli/src/commands/watching/read.ts index e8c13c1f..a508fd60 100644 --- a/apps/cli/src/commands/watching/read.ts +++ b/apps/cli/src/commands/watching/read.ts @@ -4,12 +4,7 @@ import { BeeCommand, ENV_AUTH } from "../../lib/bee-command"; const read = new BeeCommand("read") .summary("Mark a watching item as read") - .description( - `Mark a watching item as read. - -Specify the watching ID to mark as read. Use \`bee watching list\` -to find watching IDs.`, - ) + .description(`Use \`bee watching list\` to find watching IDs.`) .argument("", "Watching ID") .envVars([...ENV_AUTH]) .examples([{ description: "Mark a watching item as read", command: "bee watching read 12345" }]) diff --git a/apps/cli/src/commands/watching/view.ts b/apps/cli/src/commands/watching/view.ts index 03c4ed6d..decf6a2f 100644 --- a/apps/cli/src/commands/watching/view.ts +++ b/apps/cli/src/commands/watching/view.ts @@ -6,11 +6,7 @@ import * as opt from "../../lib/common-options"; const view = new BeeCommand("view") .summary("View a watching item") - .description( - `Display details of a watching item. - -Shows the watching ID, associated issue, note, read status, and timestamps.`, - ) + .description(`Shows the associated issue, note, read status, and timestamps.`) .argument("", "Watching ID") .addOption(opt.json()) .envVars([...ENV_AUTH]) diff --git a/apps/cli/src/commands/wiki/attachments.ts b/apps/cli/src/commands/wiki/attachments.ts index f759bd47..5dba49d0 100644 --- a/apps/cli/src/commands/wiki/attachments.ts +++ b/apps/cli/src/commands/wiki/attachments.ts @@ -6,11 +6,7 @@ import * as opt from "../../lib/common-options"; const attachments = new BeeCommand("attachments") .summary("List wiki page attachments") - .description( - `List files attached to a Backlog wiki page. - -Shows file name, size, creator, and creation date.`, - ) + .description(`Shows file name, size, creator, and creation date.`) .argument("", "Wiki page ID") .addOption(opt.json()) .envVars([...ENV_AUTH]) diff --git a/apps/cli/src/commands/wiki/count.ts b/apps/cli/src/commands/wiki/count.ts index 508c45a0..254ac531 100644 --- a/apps/cli/src/commands/wiki/count.ts +++ b/apps/cli/src/commands/wiki/count.ts @@ -6,11 +6,7 @@ import * as opt from "../../lib/common-options"; const count = new BeeCommand("count") .summary("Count wiki pages") - .description( - `Display the number of wiki pages in a Backlog project. - -The count includes all wiki pages regardless of tag or keyword.`, - ) + .description(`Counts all wiki pages regardless of tag or keyword.`) .argument("", "Project ID or project key") .addOption(opt.json()) .envVars([...ENV_AUTH, ENV_PROJECT]) diff --git a/apps/cli/src/commands/wiki/create.ts b/apps/cli/src/commands/wiki/create.ts index 712dfc75..2e459ba8 100644 --- a/apps/cli/src/commands/wiki/create.ts +++ b/apps/cli/src/commands/wiki/create.ts @@ -6,12 +6,7 @@ import * as opt from "../../lib/common-options"; const create = new BeeCommand("create") .summary("Create a wiki page") - .description( - `Create a new Backlog wiki page. - -Requires a project, page name, and body content. When input is piped, -it is used as the body automatically.`, - ) + .description(`When input is piped, it is used as the body automatically.`) .option("-p, --project ", "Project ID or project key") .option("-n, --name ", "Wiki page name") .option("-b, --body ", "Wiki page content") diff --git a/apps/cli/src/commands/wiki/delete.ts b/apps/cli/src/commands/wiki/delete.ts index 2e7989ee..5480517e 100644 --- a/apps/cli/src/commands/wiki/delete.ts +++ b/apps/cli/src/commands/wiki/delete.ts @@ -6,12 +6,7 @@ import * as opt from "../../lib/common-options"; const deleteWiki = new BeeCommand("delete") .summary("Delete a wiki page") - .description( - `Delete a Backlog wiki page. - -This action is irreversible. You will be prompted for confirmation unless -\`--yes\` is provided.`, - ) + .description(`This action is irreversible.`) .argument("", "Wiki page ID") .option("-y, --yes", "Skip confirmation prompt") .option("--mail-notify", "Send notification email") diff --git a/apps/cli/src/commands/wiki/edit.ts b/apps/cli/src/commands/wiki/edit.ts index 8be0f2d3..d00bc5c3 100644 --- a/apps/cli/src/commands/wiki/edit.ts +++ b/apps/cli/src/commands/wiki/edit.ts @@ -7,11 +7,7 @@ import * as opt from "../../lib/common-options"; const edit = new BeeCommand("edit") .summary("Edit a wiki page") .description( - `Update an existing Backlog wiki page. - -Only the specified fields will be updated. Fields that are not provided -will remain unchanged. When input is piped, it is used as the body -automatically.`, + `Only specified fields are updated. When input is piped, it is used as the body automatically.`, ) .argument("", "Wiki page ID") .option("-n, --name ", "New name of the wiki page") diff --git a/apps/cli/src/commands/wiki/history.ts b/apps/cli/src/commands/wiki/history.ts index d6df091b..4d2144e8 100644 --- a/apps/cli/src/commands/wiki/history.ts +++ b/apps/cli/src/commands/wiki/history.ts @@ -6,11 +6,7 @@ import * as opt from "../../lib/common-options"; const history = new BeeCommand("history") .summary("View wiki page history") - .description( - `Display the revision history of a Backlog wiki page. - -Shows version number, updater, and update date for each revision.`, - ) + .description(`Shows version number, updater, and update date for each revision.`) .argument("", "Wiki page ID") .addOption(opt.minId()) .addOption(opt.maxId()) diff --git a/apps/cli/src/commands/wiki/list.ts b/apps/cli/src/commands/wiki/list.ts index a037edc6..7b7ebd3f 100644 --- a/apps/cli/src/commands/wiki/list.ts +++ b/apps/cli/src/commands/wiki/list.ts @@ -6,11 +6,7 @@ import * as opt from "../../lib/common-options"; const list = new BeeCommand("list") .summary("List wiki pages") - .description( - `List wiki pages in a Backlog project. - -Use \`--keyword\` to filter pages by name or content.`, - ) + .description(`Use \`--keyword\` to filter pages by name or content.`) .argument("", "Project ID or project key") .addOption(opt.keyword()) .addOption(opt.json()) diff --git a/apps/cli/src/commands/wiki/tags.ts b/apps/cli/src/commands/wiki/tags.ts index 2aa9b35b..94237bcd 100644 --- a/apps/cli/src/commands/wiki/tags.ts +++ b/apps/cli/src/commands/wiki/tags.ts @@ -6,11 +6,7 @@ import * as opt from "../../lib/common-options"; const tags = new BeeCommand("tags") .summary("List wiki tags") - .description( - `List wiki tags in a Backlog project. - -Tags are labels attached to wiki pages for organization.`, - ) + .description(`Tags are labels attached to wiki pages for organization.`) .argument("", "Project ID or project key") .addOption(opt.json()) .envVars([...ENV_AUTH, ENV_PROJECT]) diff --git a/apps/cli/src/commands/wiki/view.ts b/apps/cli/src/commands/wiki/view.ts index 861bfbff..cb155ae2 100644 --- a/apps/cli/src/commands/wiki/view.ts +++ b/apps/cli/src/commands/wiki/view.ts @@ -6,14 +6,7 @@ import * as opt from "../../lib/common-options"; const view = new BeeCommand("view") .summary("View a wiki page") - .description( - `Display details of a Backlog wiki page. - -Shows the page name, ID, tags, created/updated info, and the full body -content. - -Use \`--web\` to open the wiki page in your default browser instead.`, - ) + .description(`Use \`--web\` to open in the browser.`) .argument("", "Wiki page ID") .addOption(opt.web("wiki page")) .addOption(opt.noBrowser()) diff --git a/packages/backlog-utils/src/issue-constants.ts b/packages/backlog-utils/src/issue-constants.ts index a2a5ee5b..9983b4ac 100644 --- a/packages/backlog-utils/src/issue-constants.ts +++ b/packages/backlog-utils/src/issue-constants.ts @@ -10,7 +10,7 @@ const IssueStatusId = { * Backlog resolution name-to-ID map. * * Resolution values are fixed in Backlog and cannot be changed by users. - * @see https://developer.nulab.com/ja/docs/backlog/api/2/get-resolution-list/ + * @see https://developer.nulab.com/docs/backlog/api/2/get-resolution-list/ */ const ResolutionId: Record = { fixed: 0, @@ -26,7 +26,7 @@ const RESOLUTION_NAMES = Object.keys(ResolutionId); * Backlog priority name-to-ID map. * * Priority values are fixed in Backlog and cannot be changed by users. - * @see https://developer.nulab.com/ja/docs/backlog/api/2/get-priority-list/ + * @see https://developer.nulab.com/docs/backlog/api/2/get-priority-list/ */ const PriorityId: Record = { high: 2,