neonctl 2.27.1 → 2.29.0

package/README.md

@@ -361,7 +361,7 @@ neonctl env pull
 neonctl env pull --branch preview --file .env.preview
 ```
 
-If you'd rather not keep env vars on disk, inject them at runtime instead with `neon-env run -- <your dev command>` (from `@neondatabase/env`) or `neonctl dev`, and pass `--no-env-pull` to `link` / `checkout`.
+If you'd rather not keep env vars on disk, inject them at runtime instead with `neon-env run -- <your dev command>` (from `@neon/env`) or `neonctl dev`, and pass `--no-env-pull` to `link` / `checkout`.
 
 **Where `.neon` lives**: `link` writes `.neon` into the **current working directory** by default. If an existing `.neon` is found in any parent directory, that file is reused — so commands run from a sub-directory of a linked project still pick up the project's context. To pin the location explicitly, pass `--context-file <path>`.
 
@@ -373,7 +373,7 @@ Describe a branch's desired state in a `neon.ts` policy and reconcile it from th
 
 ```ts
 // neon.ts
-import { defineConfig } from '@neondatabase/config/v1';
+import { defineConfig } from '@neon/config/v1';
 
 export default defineConfig({
   // Static: what exists on every branch (drives the typed env).
@@ -388,12 +388,15 @@ export default defineConfig({
 });
 ```
 
-Three sub-commands plus a top-level alias drive it:
+Three sub-commands plus two top-level aliases drive it:
 
 ```bash
 # Inspect the branch's live Neon state (read-only — never mutates)
 neon config status
 
+# `neon status` is an alias for `neon config status`
+neon status
+
 # Dry-run diff: show exactly what `apply` would change
 neon config plan
 
@@ -419,6 +422,35 @@ The branch is chosen with `--branch <id|name>`; without it the project's default
 
 **Output**: `status` prints the project, branch, and reverse-engineered config; `plan` / `apply` print the planned/applied changes and any conflicts as tables. Pass `--output json` (or `--output yaml`) to emit the full machine-readable result (`PushResult`) for piping into other tools or CI.
 
+**`config status --current-branch`** (alias `neon status --current-branch`) prints _only_ the branch pinned in the local `.neon` file — no network, no auth, no analytics — and exits non-zero when none is pinned. This behavior lets it safely drive a shell prompt. Example [starship](https://starship.rs) segment:
+
+```toml
+[custom.neon]
+description = "Current Neon database branch"
+format = "[$symbol$output]($style) "
+style = "bold green"
+# `symbol` below uses a Nerd Font glyph; swap it for a plain
+# label/emoji if you don't have a Nerd Font installed.
+symbol = " "
+command = "neon status --current-branch"
+# Starship evaluates this on EVERY prompt render. To keep prompts instant
+# everywhere outside a Neon project, do a zero-subprocess walk-up for an
+# ancestor `.neon` first (the same walk the CLI does, stopping at $HOME and /).
+# Only when one is found do we invoke the CLI, whose exit code is the real
+# gate: non-zero (no branch pinned) hides the segment cleanly.
+when = '''
+d="$PWD"
+while [ "$d" != "$HOME" ] && [ "$d" != / ]; do
+  if [ -e "$d/.neon" ]; then
+    neon status --current-branch >/dev/null 2>&1
+    exit $?
+  fi
+  d=$(dirname "$d")
+done
+exit 1
+'''
+```
+
 ```bash
 # CI gate: fail the build if the branch has drifted from the policy
 neon config plan --project-id polished-snowflake-12345678 --output json

package/dist/analytics.js

@@ -1,16 +1,22 @@
-import { readFileSync } from 'node:fs';
-import { join } from 'node:path';
-import { Analytics } from '@segment/analytics-node';
-import { isAxiosError } from 'axios';
-import { CREDENTIALS_FILE } from './config.js';
-import { getGithubEnvVars, isCi } from './env.js';
-import { log } from './log.js';
-import pkg from './pkg.js';
-import { getApiClient } from './api.js';
-const WRITE_KEY = '3SQXn5ejjXWLEJ8xU2PRYhAotLtTaeeV';
+import { readFileSync } from "node:fs";
+import { join } from "node:path";
+import { Analytics } from "@segment/analytics-node";
+import { getApiClient, isNeonApiError } from "./api.js";
+import { CREDENTIALS_FILE } from "./config.js";
+import { isCurrentBranchProbe } from "./context.js";
+import { getGithubEnvVars, isCi } from "./env.js";
+import { log } from "./log.js";
+import pkg from "./pkg.js";
+const WRITE_KEY = "3SQXn5ejjXWLEJ8xU2PRYhAotLtTaeeV";
+/**
+ * Raw-argv fallback for the offline `--current-branch` probe. The init
+ * middleware runs before validation, where the parsed `currentBranch` flag may
+ * not be populated yet, so we also scan `process.argv` directly to be safe.
+ */
+const hasCurrentBranchArgv = () => process.argv.includes("--current-branch");
 let client;
 let clientInitialized = false;
-let userId = '';
+let userId = "";
 /**
  * Phase 1: Run before validation so the Segment client exists if any
  * middleware (e.g. auth) fails. Enables sendError() in the fail handler.
@@ -20,14 +26,21 @@ export const initAnalyticsClientMiddleware = (args) => {
     if (!args.analytics || clientInitialized) {
         return;
     }
+    // The offline `--current-branch` probe must make zero network calls. This
+    // middleware runs before validation, so guard on the raw argv too (in case
+    // the parsed `currentBranch` flag isn't populated this early): never create
+    // the Segment client, which keeps trackEvent/closeAnalytics no-ops downstream.
+    if (isCurrentBranchProbe(args) || hasCurrentBranchArgv()) {
+        return;
+    }
     clientInitialized = true;
     client = new Analytics({
         writeKey: WRITE_KEY,
-        host: 'https://track.neon.tech',
+        host: "https://track.neon.tech",
     });
-    log.debug('Initialized CLI analytics client');
+    log.debug("Initialized CLI analytics client");
     client.identify({
-        userId: 'anonymous',
+        userId: "anonymous",
     });
 };
 /**
@@ -38,13 +51,18 @@ export const analyticsMiddleware = async (args) => {
     if (!client || !args.analytics) {
         return;
     }
+    if (isCurrentBranchProbe(args)) {
+        return;
+    }
     try {
         const credentialsPath = join(args.configDir, CREDENTIALS_FILE);
-        const credentials = readFileSync(credentialsPath, { encoding: 'utf-8' });
+        const credentials = readFileSync(credentialsPath, {
+            encoding: "utf-8",
+        });
         userId = JSON.parse(credentials).user_id;
     }
     catch (err) {
-        log.debug('Failed to read credentials file', err);
+        log.debug("Failed to read credentials file", err);
     }
     try {
         if (args.apiKey) {
@@ -59,25 +77,25 @@ export const analyticsMiddleware = async (args) => {
             args.authMethod = authDetails.auth_method;
             args.authData = authDetails.auth_data;
             // Get user id if not org api key
-            if (!userId && authDetails.auth_method !== 'api_key_org') {
+            if (!userId && authDetails.auth_method !== "api_key_org") {
                 const resp = await apiClient?.getCurrentUserInfo?.();
                 userId = resp?.data?.id;
             }
         }
         else {
             args.accountId = userId;
-            args.authMethod = 'oauth';
+            args.authMethod = "oauth";
         }
     }
     catch (err) {
-        log.debug('Failed to get user id from api', err);
+        log.debug("Failed to get user id from api", err);
     }
     client.identify({
-        userId: userId?.toString() ?? 'anonymous',
+        userId: userId?.toString() ?? "anonymous",
     });
     client.track({
-        userId: userId || 'anonymous',
-        event: 'CLI Started',
+        userId: userId || "anonymous",
+        event: "CLI Started",
         properties: getAnalyticsEventProperties(args),
         context: {
             direct: true,
@@ -86,35 +104,35 @@ export const analyticsMiddleware = async (args) => {
 };
 export const closeAnalytics = async (opts) => {
     if (client) {
-        log.debug('Flushing CLI analytics');
+        log.debug("Flushing CLI analytics");
         // `timeout` bounds how long we wait for in-flight events to flush so a
         // slow / unreachable track.neon.tech can't hang a short-lived command
         // (e.g. the psql launch path, which flushes here before process.exit).
         await client.closeAndFlush(opts);
-        log.debug('Flushed CLI analytics');
+        log.debug("Flushed CLI analytics");
     }
 };
 export const sendError = (err, errCode) => {
     if (!client) {
         return;
     }
-    const axiosError = isAxiosError(err) ? err : undefined;
-    const requestId = axiosError?.response?.headers['x-neon-ret-request-id'];
+    const apiError = isNeonApiError(err) ? err : undefined;
+    const requestId = apiError?.headers?.["x-neon-ret-request-id"];
     if (requestId) {
-        log.debug('Failed request ID: %s', requestId);
+        log.debug("Failed request ID: %s", requestId);
     }
     client.track({
-        event: 'CLI Error',
-        userId: userId || 'anonymous',
+        event: "CLI Error",
+        userId: userId || "anonymous",
         properties: {
             message: err.message,
             stack: err.stack,
             errCode,
-            statusCode: axiosError?.response?.status,
+            statusCode: apiError?.status,
             requestId: requestId,
         },
     });
-    log.debug('Sent CLI error event: %s', errCode);
+    log.debug("Sent CLI error event: %s", errCode);
 };
 export const trackEvent = (event, properties) => {
     if (!client) {
@@ -122,14 +140,14 @@ export const trackEvent = (event, properties) => {
     }
     client.track({
         event,
-        userId: userId || 'anonymous',
+        userId: userId || "anonymous",
         properties,
     });
-    log.debug('Sent CLI event: %s', event);
+    log.debug("Sent CLI event: %s", event);
 };
 export const getAnalyticsEventProperties = (args) => ({
     version: pkg.version,
-    command: args._.join(' '),
+    command: args._.join(" "),
     flags: {
         output: args.output,
     },