Improve Xata CLI command help messages (#2534)

Synced from monorepo@27c1ea8412ed3c0115ba54400b74ec6d34659a32

Author: divyenduz

.sync-commit

@@ -1 +1 @@
-19f931a84902e351aa5b75118561635b69d0e8cb
+27c1ea8412ed3c0115ba54400b74ec6d34659a32

package.json

@@ -39,13 +39,13 @@
     "@xata.io/ai": "0.1.0",
     "@xata.io/api": "0.1.0",
     "@xata.io/config": "0.0.0",
+    "@xata.io/lang": "0.0.1",
     "@xata.io/pgroll": "0.9.0",
     "@xata.io/pgstream": "0.2.0",
     "@xata.io/sql": "0.1.3",
     "@xata.io/test-utils": "0.0.0",
     "@xata.io/tsconfig": "0.0.1",
-    "@xata.io/utils": "0.1.0",
-    "@xata.io/lang": "0.0.1"
+    "@xata.io/utils": "0.1.0"
   },
   "scripts": {
     "dev": "bun src/bin/cli.ts",

src/commands/auth/access-token.ts

@@ -27,7 +27,7 @@ export const AuthAccessTokenCommand = buildCommand({
       profile: {
         kind: 'parsed',
         parse: String,
-        brief: 'The profile to log in to',
+        brief: 'The profile to use',
         default: 'default'
       }
     }

src/commands/auth/refresh-token.ts

@@ -37,7 +37,7 @@ export const AuthRefreshTokenCommand = buildCommand({
       profile: {
         kind: 'parsed',
         parse: String,
-        brief: 'The profile to log in to',
+        brief: 'The profile to use',
         default: 'default'
       }
     }

src/commands/auth/status.ts

@@ -35,7 +35,7 @@ export const AuthStatusCommand = buildCommand({
       profile: {
         kind: 'parsed',
         parse: String,
-        brief: 'The profile to log in to',
+        brief: 'The profile to check',
         optional: true
       }
     }

src/commands/branch/delete.ts

@@ -31,6 +31,15 @@ export async function implementation(this: LocalContext, flags: Flags, branchNam
   }
 
   if (!flags.yes) {
+    if (!this.isInteractive) {
+      // In an interactive terminal, declining the confirmation is an intentional
+      // user cancellation, so it exits successfully below. In CI or agentic
+      // contexts prompts are disabled, so there is no opportunity to confirm;
+      // returning success would make automation think the branch was deleted.
+      this.process.stderr.write(chalk.red(`Cannot delete branch without confirmation. Pass --yes to confirm.\n`));
+      this.process.exit(1);
+    }
+
     const confirmFromPrompt = await this.enquirer.confirmPrompt(
       this.isInteractive,
       `Are you sure you want to delete the branch ${branchToDelete.name} with id ${branchToDelete.id}?`
@@ -50,7 +59,7 @@ export async function implementation(this: LocalContext, flags: Flags, branchNam
 
 export const BranchDeleteCommand = buildCommand({
   docs: {
-    brief: 'Delete  new branch'
+    brief: 'Delete a branch'
   },
   parameters: {
     flags: {
@@ -87,7 +96,7 @@ export const BranchDeleteCommand = buildCommand({
       kind: 'tuple',
       parameters: [
         {
-          brief: 'The branch to switch to',
+          brief: 'The branch to delete',
           parse: String,
           placeholder: 'branch name',
           optional: true

src/commands/branch/tree.ts

@@ -115,7 +115,7 @@ export const BranchTreeCommand = buildCommand({
       },
       'show-id': {
         kind: 'boolean',
-        brief: 'Project ID',
+        brief: 'Show branch IDs in the tree',
         default: false
       }
     }

src/commands/branch/wait-ready.ts

@@ -93,7 +93,7 @@ export const BranchWaitReadyCommand = buildCommand({
       kind: 'tuple',
       parameters: [
         {
-          brief: 'The branch to switch to',
+          brief: 'The branch to wait for',
           parse: String,
           placeholder: 'branch name',
           optional: true

src/commands/clone/stream.ts

@@ -270,7 +270,7 @@ export const CloneStreamCommand = buildCommand({
       },
       role: {
         kind: 'parsed',
-        brief: 'Postgres role to use for streaming (it should have atleast REPLICATION privilege)',
+        brief: 'Postgres role to use for streaming (it should have at least REPLICATION privilege)',
         parse: String,
         optional: true
       },

src/commands/organization/delete.ts

@@ -22,7 +22,7 @@ export async function implementation(this: LocalContext, flags: Flags) {
       `Are you sure you want to delete the organization ${organization.name}?`
     );
     if (!confirmFromPrompt) {
-      this.process.stdout.write(`Aborted as there was no confirmation. Organzation not deleted.`);
+      this.process.stdout.write(`Aborted as there was no confirmation. Organization not deleted.`);
       return;
     }
   }
@@ -40,7 +40,7 @@ export async function implementation(this: LocalContext, flags: Flags) {
 
 export const OrganizationDeleteCommand = buildCommand({
   docs: {
-    brief: 'Delete a Organization'
+    brief: 'Delete an organization'
   },
   parameters: {
     flags: {