@dbx-tools/cli-appkit-env 0.9.38 → 0.9.40

package/README.md

@@ -1,77 +1,76 @@
 # @dbx-tools/cli-appkit-env
 
-CLI and formatting helpers for exporting AppKit auto-configuration results.
+Export the environment that AppKit resolves so another process can use the same
+Lakebase connection and application configuration. Choose shell, JSON, or
+Windows output without repeating AppKit discovery in your startup scripts.
 
-Use `dbx appkit env` when a shell or process manager needs the Lakebase /
-AppKit environment that [`@dbx-tools/appkit`](../../node/appkit) would
-resolve before `createApp()`.
+## Configure A Shell
 
-Key features:
-
-- Runs the same AppKit auto-configuration path used by
-  [`@dbx-tools/appkit`](../../node/appkit).
-- Emits only variables that changed during auto-configuration.
-- Supports shell `export`, JSON, and Windows `set` output formats.
-- Provides importable env snapshot/diff/format helpers for tests and wrapper
-  CLIs.
-- Keeps local shell setup aligned with deployed AppKit startup behavior.
-
-## Load Env Into A Shell
+Install the [`dbx` CLI](../dbx-tools), then run this from your AppKit project:
 
 ```sh
 eval "$(dbx appkit env --quiet)"
 ```
 
-The command snapshots `process.env`, runs AppKit auto-config, diffs the result,
-and prints only new or changed variables. On POSIX shells the default output is
-`export KEY=value`.
-
-This package ships no bin of its own. It contributes the `appkit` command group
-to the single `dbx` CLI in [`@dbx-tools/cli`](../dbx-tools), which is what you
-install:
-
-```sh
-npm install --global @dbx-tools/cli
-dbx appkit env --quiet
-```
-
-`dbx` imports this package lazily, so AppKit loads only when an `appkit`
-command actually runs.
+The command runs AppKit auto-configuration and prints only variables that were
+added or changed. The default format is POSIX `export KEY=value` statements.
+`--quiet` keeps configuration logs out of the output you evaluate.
 
-This is useful when another process must start after Lakebase discovery has
-filled `PGHOST`, `PGDATABASE`, `PGUSER`, or related AppKit variables.
+Use this before starting a process that needs resolved variables such as
+`PGHOST`, `PGDATABASE`, or `PGUSER`.
 
-## Inspect JSON Or Windows Output
+## Inspect Configuration
 
 ```sh
 dbx appkit env --format json
 dbx appkit env --format windows
 ```
 
-Use JSON for process managers and tests. Use Windows format for `cmd.exe`
-`set KEY=value` lines.
+JSON is useful for process managers and scripts. Windows format produces
+`set KEY=value` statements for `cmd.exe`. Review output before sharing it:
+resolved configuration may contain credentials.
 
-## Format Env Diffs Programmatically
+## Format Environment Changes In Code
 
 ```ts
 import { envExport } from "@dbx-tools/cli-appkit-env";
 
 const before = envExport.snapshotEnv();
-process.env.PGHOST = "ep-foo.database.azuredatabricks.net";
-const diff = envExport.diffEnv(before);
+process.env.PGHOST = "ep-example.database.cloud.databricks.com";
+const changed = envExport.diffEnv(before);
+console.log(envExport.formatEnvExport(changed, "export"));
+```
 
-console.log(envExport.formatEnvExport(diff, "export"));
+Reuse these helpers when a custom CLI or test needs the same formats. For AppKit
+application startup itself, use
+[`@dbx-tools/appkit`](../../node/appkit) rather than invoking a shell command.
+
+<!-- cli-reference:start -->
+
+## Command Reference
+
+### `dbx appkit`
+
+```text
+Usage: dbx appkit [command]
+
+AppKit helpers: resolve the environment an AppKit app would start with.
+
+Commands:
+  env [options]  Run AppKit auto-config and print new/changed env vars.
 ```
 
-These helpers are useful in tests for auto-config behavior or in custom CLIs
-that want the same output formats without invoking the bin.
+### `dbx appkit env`
 
-## Modules
+```text
+Usage: dbx appkit env [options]
 
-- `cli` - the `dbx appkit` commander program: `buildProgram(name?)` (what
-  `@dbx-tools/cli` mounts), `buildEnvCommand()`, and `runCli()`.
-- `envExport` - env snapshots, env diffs, default format detection,
-  `formatEnvExport()`, and `parseEnvExportFormat()`.
+Run AppKit auto-config and print new/changed env vars.
+
+Options:
+  -f, --format <format>  Output: export (POSIX shell), windows (cmd set), or json. Defaults by
+                         platform.
+  -q, --quiet            Suppress auto-config log output (LOG_LEVEL=error)
+```
 
-Auto-config itself lives in
-[`@dbx-tools/appkit`](../../node/appkit).
+<!-- cli-reference:end -->

package/index.ts

@@ -3,7 +3,7 @@
 // Hand edits are overwritten on the next watch; this file is read-only.
 
 export const PACKAGE_IDENTIFIER = "@dbx-tools/cli-appkit-env";
-export const PACKAGE_VERSION = "0.9.38";
+export const PACKAGE_VERSION = "0.9.40";
 export * as cli from "./src/cli.ts";
 export * as envExport from "./src/env-export.ts";
 export { CommanderError } from "./src/cli.ts";

package/lib/index.d.ts

@@ -1,5 +1,5 @@
 export declare const PACKAGE_IDENTIFIER = "@dbx-tools/cli-appkit-env";
-export declare const PACKAGE_VERSION = "0.9.38";
+export declare const PACKAGE_VERSION = "0.9.40";
 export * as cli from "./src/cli.ts";
 export * as envExport from "./src/env-export.ts";
 export { CommanderError } from "./src/cli.ts";

package/lib/index.js

@@ -2,8 +2,8 @@
 // Regenerated from the exporting modules in ./src.
 // Hand edits are overwritten on the next watch; this file is read-only.
 export const PACKAGE_IDENTIFIER = "@dbx-tools/cli-appkit-env";
-export const PACKAGE_VERSION = "0.9.38";
+export const PACKAGE_VERSION = "0.9.40";
 export * as cli from "./src/cli.js";
 export * as envExport from "./src/env-export.js";
 export { CommanderError } from "./src/cli.js";
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi9pbmRleC50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiQUFBQSwyQ0FBMkM7QUFDM0MsbURBQW1EO0FBQ25ELHdFQUF3RTtBQUV4RSxNQUFNLENBQUMsTUFBTSxrQkFBa0IsR0FBRywyQkFBMkIsQ0FBQztBQUM5RCxNQUFNLENBQUMsTUFBTSxlQUFlLEdBQUcsUUFBUSxDQUFDO0FBQ3hDLE9BQU8sS0FBSyxHQUFHLE1BQU0sY0FBYyxDQUFDO0FBQ3BDLE9BQU8sS0FBSyxTQUFTLE1BQU0scUJBQXFCLENBQUM7QUFDakQsT0FBTyxFQUFFLGNBQWMsRUFBRSxNQUFNLGNBQWMsQ0FBQyIsInNvdXJjZXNDb250ZW50IjpbIi8vIEdFTkVSQVRFRCBieSBwcm9qZW4gd2F0Y2ggLSBETyBOT1QgRURJVC5cbi8vIFJlZ2VuZXJhdGVkIGZyb20gdGhlIGV4cG9ydGluZyBtb2R1bGVzIGluIC4vc3JjLlxuLy8gSGFuZCBlZGl0cyBhcmUgb3ZlcndyaXR0ZW4gb24gdGhlIG5leHQgd2F0Y2g7IHRoaXMgZmlsZSBpcyByZWFkLW9ubHkuXG5cbmV4cG9ydCBjb25zdCBQQUNLQUdFX0lERU5USUZJRVIgPSBcIkBkYngtdG9vbHMvY2xpLWFwcGtpdC1lbnZcIjtcbmV4cG9ydCBjb25zdCBQQUNLQUdFX1ZFUlNJT04gPSBcIjAuOS4zOFwiO1xuZXhwb3J0ICogYXMgY2xpIGZyb20gXCIuL3NyYy9jbGkudHNcIjtcbmV4cG9ydCAqIGFzIGVudkV4cG9ydCBmcm9tIFwiLi9zcmMvZW52LWV4cG9ydC50c1wiO1xuZXhwb3J0IHsgQ29tbWFuZGVyRXJyb3IgfSBmcm9tIFwiLi9zcmMvY2xpLnRzXCI7XG5leHBvcnQgdHlwZSB7IEVudkV4cG9ydEZvcm1hdCB9IGZyb20gXCIuL3NyYy9lbnYtZXhwb3J0LnRzXCI7XG4iXX0=
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi9pbmRleC50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiQUFBQSwyQ0FBMkM7QUFDM0MsbURBQW1EO0FBQ25ELHdFQUF3RTtBQUV4RSxNQUFNLENBQUMsTUFBTSxrQkFBa0IsR0FBRywyQkFBMkIsQ0FBQztBQUM5RCxNQUFNLENBQUMsTUFBTSxlQUFlLEdBQUcsUUFBUSxDQUFDO0FBQ3hDLE9BQU8sS0FBSyxHQUFHLE1BQU0sY0FBYyxDQUFDO0FBQ3BDLE9BQU8sS0FBSyxTQUFTLE1BQU0scUJBQXFCLENBQUM7QUFDakQsT0FBTyxFQUFFLGNBQWMsRUFBRSxNQUFNLGNBQWMsQ0FBQyIsInNvdXJjZXNDb250ZW50IjpbIi8vIEdFTkVSQVRFRCBieSBwcm9qZW4gd2F0Y2ggLSBETyBOT1QgRURJVC5cbi8vIFJlZ2VuZXJhdGVkIGZyb20gdGhlIGV4cG9ydGluZyBtb2R1bGVzIGluIC4vc3JjLlxuLy8gSGFuZCBlZGl0cyBhcmUgb3ZlcndyaXR0ZW4gb24gdGhlIG5leHQgd2F0Y2g7IHRoaXMgZmlsZSBpcyByZWFkLW9ubHkuXG5cbmV4cG9ydCBjb25zdCBQQUNLQUdFX0lERU5USUZJRVIgPSBcIkBkYngtdG9vbHMvY2xpLWFwcGtpdC1lbnZcIjtcbmV4cG9ydCBjb25zdCBQQUNLQUdFX1ZFUlNJT04gPSBcIjAuOS40MFwiO1xuZXhwb3J0ICogYXMgY2xpIGZyb20gXCIuL3NyYy9jbGkudHNcIjtcbmV4cG9ydCAqIGFzIGVudkV4cG9ydCBmcm9tIFwiLi9zcmMvZW52LWV4cG9ydC50c1wiO1xuZXhwb3J0IHsgQ29tbWFuZGVyRXJyb3IgfSBmcm9tIFwiLi9zcmMvY2xpLnRzXCI7XG5leHBvcnQgdHlwZSB7IEVudkV4cG9ydEZvcm1hdCB9IGZyb20gXCIuL3NyYy9lbnYtZXhwb3J0LnRzXCI7XG4iXX0=

package/package.json

@@ -24,8 +24,8 @@
   },
   "dependencies": {
     "@databricks/appkit": "0.81.0",
-    "@dbx-tools/appkit": "^0.9.38",
-    "@dbx-tools/shared-core": "^0.9.38",
+    "@dbx-tools/appkit": "^0.9.40",
+    "@dbx-tools/shared-core": "^0.9.40",
     "commander": "^15.0.0"
   },
   "main": "./lib/index.js",
@@ -50,7 +50,7 @@
       "./package.json": "./package.json"
     }
   },
-  "version": "0.9.38",
+  "version": "0.9.40",
   "types": "./lib/index.d.ts",
   "dbxToolsConfig": {
     "tags": [