neon 3.1.1 → 3.2.1

package/README.md

@@ -352,6 +352,19 @@ How today's `set-context` uses map onto `link`:
 
 The key difference: `link` resolves and **verifies** before writing (so you never get a half-written or stale `.neon`), whereas `set-context` writes whatever you give it verbatim. The closest like-for-like replacement for the old raw write is `link --no-checks`.
 
+### open
+
+`open` launches the linked project's page in the Neon Console. It reads the closest `.neon` file without authenticating or calling the Neon API, so it works from any sub-directory of a linked project.
+
+```bash
+neon open
+
+# Open a project without changing the linked context
+neon open --project-id polished-snowflake-12345678
+```
+
+A branch pinned in `.neon` does not change the destination. `.neon` stores the branch as a name, while the Console route requires its ID; resolving it would turn this local command into an authenticated API call.
+
 ### checkout
 
 `checkout [id|name]` pins a branch in the local context so subsequent commands target it — it's the focused companion to `link` for the common "switch the branch I'm working on" case (`link` resolves org + project; `checkout` pins the branch). It resolves the branch (by name or id) against the project, then **heals** the `.neon` file: it always (re)writes `projectId`, `branch`, and `orgId` (when the project has one), so a `.neon` that was missing fields or drifted ends up complete and consistent. The branch is stored as its **name** when known (matching `link`). When `orgId` isn't already known (from `--org-id` or the existing `.neon`), it's looked up from the project itself.
@@ -1044,6 +1057,7 @@ API keys in org-7
 | checkout                                                                   |                                                                                                              | Pin a branch in `.neon`            |
 | diff                                                                       |                                                                                                              | Git-style schema diff vs a branch  |
 | [link](https://neon.com/docs/reference/cli-link)                           |                                                                                                              | Link a directory to a project      |
+| open                                                                       |                                                                                                              | Open the linked project in Console |
 | config                                                                     | `init`, `status`, `plan`, `apply`                                                                            | Drive a branch from `neon.ts`      |
 | deploy                                                                     |                                                                                                              | Alias for `config apply`           |
 | bootstrap                                                                  |                                                                                                              | Scaffold a project from a template |

package/dist/commands/auth.js

@@ -174,6 +174,7 @@ const ensureAuth = async (props) => {
 	if (isCurrentBranchProbe(props)) return;
 	if (isConfigInit(props)) return;
 	if (isProfileCommand(props)) return;
+	if (props._[0] === "open") return;
 	const isLocalDev = props._[0] === "dev";
 	const isBootstrap = props._[0] === "bootstrap";
 	const isInit = props._[0] === "init";

package/dist/commands/index.js

@@ -21,6 +21,7 @@ import { t as inspect_exports } from "./inspect.js";
 import { t as ip_allow_exports } from "./ip_allow.js";
 import { t as logs_exports } from "./logs.js";
 import { t as neon_auth_exports } from "./neon_auth.js";
+import { t as open_exports } from "./open.js";
 import { t as operations_exports } from "./operations.js";
 import { t as orgs_exports } from "./orgs.js";
 import { t as profile_exports } from "./profile.js";
@@ -55,6 +56,7 @@ var commands_default = [
 	set_context_exports,
 	checkout_exports,
 	link_exports,
+	open_exports,
 	init_exports,
 	data_api_exports,
 	functions_exports,

package/dist/commands/open.js

@@ -0,0 +1,33 @@
+import { t as __exportAll } from "../_chunks/rolldown-runtime-D7D4PA-g.js";
+import { log } from "../log.js";
+import { getCliName } from "../utils/cli_name.js";
+import open from "open";
+//#region src/commands/open.ts
+var open_exports = /* @__PURE__ */ __exportAll({
+	builder: () => builder,
+	command: () => command,
+	describe: () => describe,
+	handler: () => handler,
+	projectConsoleUrl: () => projectConsoleUrl
+});
+const command = "open";
+const describe = "Open the linked project in the Neon Console";
+const builder = (argv) => argv.usage("$0 open [options]").option("project-id", {
+	describe: "Project ID (defaults to the project linked in .neon)",
+	type: "string"
+}).example("$0 open", describe);
+const projectConsoleUrl = (projectId) => `https://console.neon.tech/app/projects/${encodeURIComponent(projectId)}`;
+const handler = async (props) => {
+	if (!props.projectId) throw new Error(`No Neon project linked. Run \`${getCliName()} link\` to link this directory to a project.`);
+	const url = projectConsoleUrl(props.projectId);
+	log.info("Opening %s in your browser.", url);
+	const subprocess = await open(url);
+	await new Promise((resolve, reject) => {
+		subprocess.once("spawn", resolve);
+		subprocess.once("error", (error) => {
+			reject(/* @__PURE__ */ new Error(`Failed to open the Neon Console in your browser. Open ${url} manually. ${error.message}`));
+		});
+	});
+};
+//#endregion
+export { builder, command, describe, handler, projectConsoleUrl, open_exports as t };

package/dist/index.js

@@ -27,6 +27,7 @@ const NO_SUBCOMMANDS_VERBS = [
 	"set-context",
 	"checkout",
 	"link",
+	"open",
 	"init",
 	"dev",
 	"deploy",

package/dist/init/auth.js

@@ -5,7 +5,7 @@ import { log } from "@clack/prompts";
 import { execa } from "execa";
 //#region src/init/auth.ts
 /**
-* Ensures neonctl is authenticated by running a command that triggers auth if needed
+* Ensures the Neon CLI is authenticated by running a command that triggers auth if needed
 * This will automatically start the OAuth flow if the user isn't already authenticated
 */
 async function ensureNeonctlAuth(options) {
@@ -14,7 +14,7 @@ async function ensureNeonctlAuth(options) {
 	try {
 		await execa("npx", [
 			"-y",
-			"neonctl",
+			"neon",
 			"me"
 		], {
 			stdio: "inherit",
@@ -32,7 +32,7 @@ async function ensureNeonctlAuth(options) {
 	}
 }
 /**
-* Checks whether neonctl has stored OAuth credentials.
+* Checks whether the Neon CLI has stored OAuth credentials.
 */
 async function isAuthenticated() {
 	return await getNeonctlAccessToken() !== null;

package/dist/init/neonctl.js

@@ -3,12 +3,14 @@ import { lstatSync } from "node:fs";
 import { execa } from "execa";
 //#region src/init/neonctl.ts
 /**
-* Returns the Neon CLI command prefix: "CI= npx -y neon".
+* Returns the Neon CLI command prefix emitted to users and agents:
+* `CI= npx -y neon`.
 *
 * The CLI reads NEON_API_HOST and NEON_OAUTH_HOST from the environment
-* directly, so no extra flags are needed. The `neon` package ships both the
-* `neon` and `neonctl` binaries; we surface the cleaner `neon` command in the
-* examples emitted to users and agents.
+* directly, so no extra flags are needed. The published package is `neon`
+* (its binary is `neon`; the older `neonctl` alias is no longer shipped). `npx`
+* runs it with zero global-install assumptions, and the leading `CI=` keeps the
+* CLI non-interactive.
 *
 * Usage: `${neonctlCmd()} orgs list --output json`
 */
@@ -16,12 +18,19 @@ function neonctlCmd() {
 	return "CI= npx -y neon";
 }
 /**
-* Gets the currently available neonctl version.
-* Tries the global binary first, then falls back to npx.
+* The global binaries that indicate the Neon CLI is installed. The current
+* package ships `neon`; `neonctl` is the legacy alias, kept in the probe so an
+* older global install still counts as "installed" (and isn't reinstalled).
 */
-async function getNeonctlVersion() {
-	try {
-		const match = (await execa("neonctl", ["--version"], {
+const NEON_CLI_BINARIES = ["neon", "neonctl"];
+/**
+* Gets the currently installed Neon CLI version, probing the `neon` binary
+* first and falling back to the legacy `neonctl` alias. Returns null when the
+* CLI isn't on PATH.
+*/
+async function getNeonCliVersion() {
+	for (const bin of NEON_CLI_BINARIES) try {
+		const match = (await execa(bin, ["--version"], {
 			stdio: "pipe",
 			timeout: 5e3
 		})).stdout.trim().match(/(\d+\.\d+\.\d+)/);
@@ -30,10 +39,10 @@ async function getNeonctlVersion() {
 	return null;
 }
 /**
-* Checks whether the neonctl CLI is globally installed and whether it's up to date.
+* Checks whether the Neon CLI is globally installed and whether it's up to date.
 */
 async function checkNeonctl() {
-	const currentVersion = await getNeonctlVersion();
+	const currentVersion = await getNeonCliVersion();
 	if (!currentVersion) return {
 		installed: false,
 		currentVersion: null,
@@ -44,7 +53,7 @@ async function checkNeonctl() {
 	try {
 		latestVersion = (await execa("npm", [
 			"view",
-			"neonctl",
+			"neon",
 			"version"
 		], {
 			stdio: "pipe",
@@ -82,9 +91,9 @@ function isOlderVersion(current, latest) {
 function isLocalDevSymlink() {
 	try {
 		const home = process.env.HOME || process.env.USERPROFILE || "";
-		const candidates = [`${process.env.NVM_DIR || `${home}/.nvm`}/versions/node/${process.version}/lib/node_modules/neonctl`, `${home}/.nvm/versions/node/${process.version}/lib/node_modules/neonctl`];
-		for (const candidate of candidates) try {
-			if (lstatSync(candidate).isSymbolicLink()) return true;
+		const roots = [`${process.env.NVM_DIR || `${home}/.nvm`}/versions/node/${process.version}/lib/node_modules`, `${home}/.nvm/versions/node/${process.version}/lib/node_modules`];
+		for (const root of roots) for (const pkg of NEON_CLI_BINARIES) try {
+			if (lstatSync(`${root}/${pkg}`).isSymbolicLink()) return true;
 		} catch {}
 		return false;
 	} catch {
@@ -98,7 +107,7 @@ function isLocalDevSymlink() {
 async function ensureNeonctl() {
 	if (isLocalDevSymlink()) return {
 		status: "already_current",
-		version: await getNeonctlVersion() ?? "dev"
+		version: await getNeonCliVersion() ?? "dev"
 	};
 	const check = await checkNeonctl();
 	if (check.installed && !check.needsUpdate) return {
@@ -106,7 +115,7 @@ async function ensureNeonctl() {
 		version: check.currentVersion ?? void 0
 	};
 	const pm = resolveInvokingPackageManager();
-	const install = globalInstallCommand(pm, "neonctl");
+	const install = globalInstallCommand(pm, "neon");
 	if (!install) return {
 		status: "failed",
 		error: "Could not install the Neon CLI: this machine has no package manager that can perform a global install. npm, pnpm and bun are not on PATH (yarn Berry has no global install). Install npm, pnpm or bun, then run this again."
@@ -117,7 +126,7 @@ async function ensureNeonctl() {
 			stdio: "pipe",
 			timeout: 6e4
 		});
-		const version = await getNeonctlVersion();
+		const version = await getNeonCliVersion();
 		return {
 			status: check.installed ? "updated" : "installed",
 			version: version ?? void 0

package/dist/init/resolve_context.js

@@ -30,7 +30,7 @@ function extractNeonHost(cwd) {
 *
 * Strategy:
 * 1. Extract endpoint hostname from .env
-* 2. List orgs via neonctl
+* 2. List orgs via the Neon CLI
 * 3. For each org, list projects
 * 4. For each project, get connection string and compare hostnames
 * 5. Return the matching org/project
@@ -42,7 +42,7 @@ async function resolveNeonContext(cwd) {
 	try {
 		const result = await execa("npx", [
 			"-y",
-			"neonctl",
+			"neon",
 			"orgs",
 			"list",
 			"--output",
@@ -65,7 +65,7 @@ async function resolveNeonContext(cwd) {
 		try {
 			const result = await execa("npx", [
 				"-y",
-				"neonctl",
+				"neon",
 				"projects",
 				"list",
 				"--org-id",
@@ -87,7 +87,7 @@ async function resolveNeonContext(cwd) {
 		for (const project of projects) try {
 			if ((await execa("npx", [
 				"-y",
-				"neonctl",
+				"neon",
 				"connection-string",
 				"--project-id",
 				project.id

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "neon",
-  "version": "3.1.1",
+  "version": "3.2.1",
   "description": "CLI tool for Neon, the cloud backend primitives built around Lakebase Postgres",
   "keywords": [
     "neon",
@@ -63,9 +63,9 @@
     "yaml": "^2.9.0",
     "yargs": "17.7.2",
     "yoctocolors": "^2.1.2",
-    "@neon/sdk": "2.0.0",
     "@neon/config": "1.0.0",
-    "@neon/config-runtime": "1.0.0"
+    "@neon/config-runtime": "1.0.0",
+    "@neon/sdk": "2.0.0"
   },
   "optionalDependencies": {
     "esbuild": "0.28.1"