Discover projects
Review which Neon projects are available before selecting one for further CLI work.
Neon · Command
neonctl projects
neonctl projects is the Neon CLI command group for managing projects. Use neonctl projects list to view projects, with related subcommands for creating, updating, and deleting them.
How it works
The command group manages Neon projects from the terminal. Use the list subcommand to display projects available to the authenticated account; other project lifecycle operations include creating, updating, and deleting projects.
Syntax
neonctl projects <subcommand>Returns
For list, the command displays the authenticated account's Neon projects in the terminal. The page does not specify a formal return type.
Key points
- Use the
listsubcommand to display the projects associated with the authenticated Neon account. - The command provides terminal-based project management instead of requiring the Neon Console.
- The documented command name is
neon, butneonctlis an equivalent alias. - The command group also supports project creation through its
createsubcommand.
Common mistakes
- Current Neon documentation uses
neonas the CLI name, whileneonctlremains an alias, so both command forms work.
Example: List Neon projects
neonctl projects listLists the projects available to the authenticated Neon account.
When to use it
Create a project
Provision a new Neon project from a terminal or automation workflow.
Manage project lifecycle
Perform project lifecycle administration from the command line.
Interview questions
QHow do you list Neon projects with the CLI?
Use neonctl projects list to display the projects available to the authenticated account. The current CLI documentation shows this operation as neon projects list, and documents neonctl as an alias.
Follow-up: How would you create a project? Use neonctl projects create; the create operation provisions a project with a default database and branch.
QWhat does the project-create operation provide?
Run neonctl projects create. The command creates a Neon project with a default database and branch, and the CLI can return a connection string for the new project.
Follow-up: How can a project be assigned to a particular organization? Supply the optional org_id parameter when creating it.
QWhat kinds of operations belong to the projects command?
Project management is grouped under the projects command. The documented project operations include listing projects and CRUD operations such as creating, updating, and deleting them.
Follow-up: What should be used when only a branch must be removed? Use the branches command rather than deleting the whole project.
Related
neon projects listneon projects createneon projects updateneon projects deleteneon branches delete