docs: rework neon init for the 4.11.0 orchestrator behavior - #5663
Merged
Conversation
Neon CLI 4.10.0 turned neon init from a standalone setup command into a thin wrapper: an empty directory scaffolds a template, and an existing app gets agent tooling (a plugin, or skills and the MCP server), a linked project, and a neon.ts config. It runs interactively, so agents and CI use the underlying commands instead. This brings the docs in line: rewrites the neon init reference, fixes the examples that used the removed --preview and --agent flags, updates the getting-started and MCP pages and the Functions guides, refreshes the bootstrap template list, corrects where env vars land (.env or .env.local), and regenerates schema.json to 4.10.0. Co-authored-by: Isaac <no-reply@databricks.com>
philip
requested review from
andrelandgraf,
danieltprice and
ruf-io
as code owners
August 27, 2026 23:00
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
`neon projects create` and `neon branches create` accept `--no-secrets` (Neon CLI 4.9.0+) to keep the connection string out of output and logs. Documented on the reference pages and the CI and test-on-branch guides that run these commands. Co-authored-by: Isaac <no-reply@databricks.com>
Neon CLI 4.11.0 re-adds --agent (repeatable, names the coding agents to set up) on neon init and neon bootstrap, and -y now detects the host CLI agent when no project folder matches. Document --agent and the -y detection order on the init reference, note that init is project-scoped, and reframe the non-interactive section around neon init -y --agent. Switch neon skills update examples to --yes (the -y alias isn't recognized there), drop the removed claimable-postgres skill, and regenerate schema.json to 4.11.0 with an override so skills update --yes renders as boolean. Co-authored-by: Isaac <no-reply@databricks.com>
philip
changed the title
The neon skills update `yes` flag inherits its alias and boolean type from the parent skills command; the static schema parser reads each builder in isolation and misses that, so the override supplies the type. Note that it's removable once the generator models parent-option inheritance. Co-authored-by: Isaac <no-reply@databricks.com>
Both -y and --yes work (the -y alias is inherited from the parent skills command), so use -y to match the neon skills examples above and the CLI's own help. The schema parser reads each builder in isolation and misses that inherited alias, so an overrides.json entry restores it until the generator models parent-option inheritance. Co-authored-by: Isaac <no-reply@databricks.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Overview
Neon CLI 4.11.0 reworked what
neon initdoes. It's no longer a standalone setup product that installs the CLI, creates an API key, and configures MCP per editor. It's now a thin orchestrator: in an empty directory it scaffolds a starter template, and in an existing app it installs agent tooling (a plugin, or agent skills and the MCP server), links a Neon project, and writes aneon.tsconfig. It runs interactively by default; pass--agentto name the coding agents and-yto skip the prompts, so agents and CI can run it unattended. Selecting a specific project without a terminal still usesneon link --project-id, sinceinithas no project selector of its own.This updates the docs to match:
neon initreference and fixesbootstrap.md, which described the old post-scaffold flow.--agentonneon initandneon bootstrap(repeatable, names the coding agents to set up), the-yagent-detection order, and that init is project-scoped. Drops stale claims that init installs the CLI, creates an API key, or installs an editor extension.neon skills -s ....neon linkalways writes.env.local(it writes to an existing.envif you have one, otherwise.env.local), refreshes the bootstrap template list, and attributes "Get started with Neon" to the Neon MCP server.neon skills updateexamples to--yes(its-yalias isn't recognized), removes the retiredclaimable-postgresskill, and documents--no-secretsonneon projects createandneon branches create.schema.jsonto 4.11.0. The bump also surfacesneon api --describe, which now renders in its reference table.A changelog entry and a couple of upstream agent-skills fixes are tracked separately as follow-ups.
Testing:
npm run cli-docs -- checkpasses (48/48); verified the commands and interactive vs non-interactive behavior against the released 4.11.0 CLI.This pull request and its description were written by Isaac.