@dbx-app/cli 0.4.7 → 0.4.8

package/README.md

@@ -4,10 +4,19 @@ Command line interface for DBX database connections, schema inspection, safe que
 
 ## Install
 
+### npm
+
 ```bash
 npm install -g @dbx-app/cli
 ```
 
+### Homebrew
+
+```bash
+brew tap t8y2/dbx
+brew install dbx-cli
+```
+
 Requires Node.js 22.13.0 or newer.
 
 ## Usage
@@ -29,17 +38,17 @@ dbx open local users
 
 ## Commands
 
-| Command | Description |
-|---|---|
-| `dbx doctor` | Show local DBX config and desktop bridge diagnostics |
-| `dbx capabilities` | Show direct-query and desktop-bridge database support |
-| `dbx connections list` | List DBX connections without printing secrets |
-| `dbx schema list <connection>` | List tables and views |
-| `dbx schema describe <connection> <table>` | Show table columns |
-| `dbx query <connection> <sql>` | Execute one SQL statement |
-| `dbx query <connection> --file ./query.sql` | Execute SQL from a file |
-| `dbx context <connection>` | Print compact schema context for prompts |
-| `dbx open <connection> <table>` | Open a table in DBX Desktop |
+| Command                                     | Description                                           |
+| ------------------------------------------- | ----------------------------------------------------- |
+| `dbx doctor`                                | Show local DBX config and desktop bridge diagnostics  |
+| `dbx capabilities`                          | Show direct-query and desktop-bridge database support |
+| `dbx connections list`                      | List DBX connections without printing secrets         |
+| `dbx schema list <connection>`              | List tables and views                                 |
+| `dbx schema describe <connection> <table>`  | Show table columns                                    |
+| `dbx query <connection> <sql>`              | Execute one SQL statement                             |
+| `dbx query <connection> --file ./query.sql` | Execute SQL from a file                               |
+| `dbx context <connection>`                  | Print compact schema context for prompts              |
+| `dbx open <connection> <table>`             | Open a table in DBX Desktop                           |
 
 ## Output
 
@@ -102,16 +111,16 @@ npm install -g @dbx-app/cli
 
 CLI JSON errors use stable codes:
 
-| Code | Meaning |
-|---|---|
-| `UNKNOWN_OPTION` | An unsupported flag was provided |
-| `INVALID_OPTION` | A flag is missing a value or has an invalid value |
-| `INVALID_ARGUMENT` | Positional arguments are missing or conflicting |
+| Code                     | Meaning                                             |
+| ------------------------ | --------------------------------------------------- |
+| `UNKNOWN_OPTION`         | An unsupported flag was provided                    |
+| `INVALID_OPTION`         | A flag is missing a value or has an invalid value   |
+| `INVALID_ARGUMENT`       | Positional arguments are missing or conflicting     |
 | `CONNECTION_STORE_ERROR` | DBX connection storage exists but could not be read |
-| `CONNECTION_NOT_FOUND` | No DBX connection matched the requested name |
-| `SQL_BLOCKED` | SQL safety rules blocked execution |
-| `DBX_NOT_RUNNING` | DBX Desktop bridge is unavailable |
-| `ERROR` | Unexpected runtime failure |
+| `CONNECTION_NOT_FOUND`   | No DBX connection matched the requested name        |
+| `SQL_BLOCKED`            | SQL safety rules blocked execution                  |
+| `DBX_NOT_RUNNING`        | DBX Desktop bridge is unavailable                   |
+| `ERROR`                  | Unexpected runtime failure                          |
 
 ## Codex
 

package/dist/cli.js

@@ -1,6 +1,6 @@
 #!/usr/bin/env node
 import { readFile } from "node:fs/promises";
-import { buildSchemaContext, createBackend, DIRECT_QUERY_TYPES, BRIDGE_REQUIRED_TYPES, evaluateSqlSafety, formatSchemaContext, getDbxDiagnostics, isMainModule, postBridge, } from "@dbx-app/node-core";
+import { buildSchemaContext, createBackend, DIRECT_QUERY_TYPES, BRIDGE_REQUIRED_TYPES, evaluateSqlSafety, formatSchemaContext, getDbxDiagnostics, isMainModule, postBridge } from "@dbx-app/node-core";
 import { connectionSummary, csvTable, errorPayload, formatCell, formatErrorMessage, mdTable } from "./cli-format.js";
 class CliError extends Error {
     code;
@@ -55,12 +55,12 @@ export async function runCli(argv, options = {}) {
             if (flags.format === "json")
                 return okJson(payload);
             if (flags.format === "csv") {
-                return ok(csvTable(["mode", "type"], [
-                    ...payload.directQueryTypes.map((type) => ({ mode: "direct", type })),
-                    ...payload.bridgeRequiredTypes.map((type) => ({ mode: "bridge", type })),
-                ]));
+                return ok(csvTable(["mode", "type"], [...payload.directQueryTypes.map((type) => ({ mode: "direct", type })), ...payload.bridgeRequiredTypes.map((type) => ({ mode: "bridge", type }))]));
             }
-            return ok(`${mdTable(["Mode", "Types"], [["Direct", payload.directQueryTypes.join(", ")], ["Requires DBX Desktop", payload.bridgeRequiredTypes.join(", ")]])}\n`);
+            return ok(`${mdTable(["Mode", "Types"], [
+                ["Direct", payload.directQueryTypes.join(", ")],
+                ["Requires DBX Desktop", payload.bridgeRequiredTypes.join(", ")],
+            ])}\n`);
         }
         if (args[0] === "connections" && args[1] === "list") {
             ensureArgCount(args, 2, "dbx connections list");
@@ -93,13 +93,7 @@ export async function runCli(argv, options = {}) {
             if (flags.format === "csv") {
                 return ok(csvTable(["name", "data_type", "is_nullable", "is_primary_key", "column_default", "comment"], columns));
             }
-            return ok(`${mdTable(["Column", "Type", "Nullable", "Default", "Comment"], columns.map((c) => [
-                c.is_primary_key ? `${c.name} (PK)` : c.name,
-                c.data_type,
-                c.is_nullable ? "YES" : "NO",
-                c.column_default ?? "",
-                c.comment ?? "",
-            ]))}\n`);
+            return ok(`${mdTable(["Column", "Type", "Nullable", "Default", "Comment"], columns.map((c) => [c.is_primary_key ? `${c.name} (PK)` : c.name, c.data_type, c.is_nullable ? "YES" : "NO", c.column_default ?? "", c.comment ?? ""]))}\n`);
         }
         if (args[0] === "query") {
             const usesDefaultConnection = !!env.DBX_CONNECTION && args.length === (flags.file ? 1 : 2);
@@ -171,11 +165,7 @@ export async function runCli(argv, options = {}) {
     }
     catch (error) {
         const message = error instanceof Error ? error.message : String(error);
-        const code = error instanceof CliError
-            ? error.code
-            : typeof error === "object" && error !== null && "code" in error && typeof error.code === "string"
-                ? error.code
-                : "ERROR";
+        const code = error instanceof CliError ? error.code : typeof error === "object" && error !== null && "code" in error && typeof error.code === "string" ? error.code : "ERROR";
         const wantsJson = argv.includes("--json");
         return fail(code, message, wantsJson);
     }
@@ -332,12 +322,7 @@ function formatDoctor(diagnostics) {
         ["App data directory", diagnostics.appDataDir],
         ["DBX database", diagnostics.dbPathExists ? `found (${diagnostics.dbPath})` : `missing (${diagnostics.dbPath})`],
         ["Connections table", diagnostics.connectionsTableExists ? `${diagnostics.connectionRowCount} row(s)` : "missing"],
-        [
-            "Connection loading",
-            diagnostics.loadConnectionsOk
-                ? `ok (${diagnostics.loadedConnectionCount} loaded)`
-                : `failed (${diagnostics.loadConnectionsError ?? "unknown error"})`,
-        ],
+        ["Connection loading", diagnostics.loadConnectionsOk ? `ok (${diagnostics.loadedConnectionCount} loaded)` : `failed (${diagnostics.loadConnectionsError ?? "unknown error"})`],
         ...(diagnostics.loadConnectionsHint ? [["Connection fix", diagnostics.loadConnectionsHint]] : []),
         ["Desktop bridge", diagnostics.bridgePortFileExists ? `available (${diagnostics.bridgeUrl ?? diagnostics.bridgePortFile})` : "not running"],
         ["Direct query types", diagnostics.directQueryTypes.join(", ")],

package/package.json

@@ -1,43 +1,43 @@
 {
   "name": "@dbx-app/cli",
-  "version": "0.4.7",
+  "version": "0.4.8",
   "description": "Command line interface for DBX database connections, schema, and safe queries",
-  "type": "module",
-  "engines": {
-    "node": ">=22.13.0"
-  },
-  "bin": {
-    "dbx": "dist/cli.js"
-  },
-  "files": [
-    "dist"
-  ],
   "keywords": [
+    "ai-agent",
+    "automation",
     "cli",
+    "codex",
     "database",
     "dbx",
-    "codex",
-    "terminal",
-    "automation",
-    "postgresql",
     "mysql",
-    "ai-agent"
+    "postgresql",
+    "terminal"
   ],
+  "homepage": "https://github.com/t8y2/dbx/tree/main/packages/cli",
   "license": "Apache-2.0",
   "repository": {
     "type": "git",
     "url": "https://github.com/t8y2/dbx",
     "directory": "packages/cli"
   },
-  "homepage": "https://github.com/t8y2/dbx/tree/main/packages/cli",
+  "bin": {
+    "dbx": "dist/cli.js"
+  },
+  "files": [
+    "dist"
+  ],
+  "type": "module",
   "dependencies": {
-    "@dbx-app/node-core": "^0.4.7"
+    "@dbx-app/node-core": "^0.4.8"
   },
   "devDependencies": {
     "@types/node": "^22.15.21",
     "tsx": "^4.19.4",
     "typescript": "^5.8.3"
   },
+  "engines": {
+    "node": ">=22.13.0"
+  },
   "scripts": {
     "start": "tsx src/cli.ts",
     "test": "pnpm --filter @dbx-app/node-core build && vitest run --config vitest.config.ts",