Before you begin
- Before running the
orgscommand, ensure that you have installed the Neon CLI. - If you have not authenticated with the neon auth command, running a Neon CLI command automatically launches the Neon CLI browser authentication process. Alternatively, you can specify a Neon API key using the
--api-keyoption when running a command. See Connect.
The orgs command
Use this command to manage the organizations you belong to within the Neon CLI.
Usage
neon orgs <sub-command> [options]Sub-commands
list
This sub-command lists all organizations associated with the authenticated Neon CLI user.
neon orgs listOptions
Only global options apply.
Examples
Here is the default output in table format.
neon orgs list
Organizations
┌────────────────────────┬──────────────────┐
│ Id │ Name │
├────────────────────────┼──────────────────┤
│ org-xxxxxxxx-xxxxxxxx │ Example Org │
└────────────────────────┴──────────────────┘This next example shows neon orgs list with --output json, which also shows the created_at and updated_at timestamps not shown with the default table output format.
neon orgs list -o json
[
{
"id": "org-xxxxxxxx-xxxxxxxx",
"name": "Example Org",
"handle": "example-org-xxxxxxxx",
"created_at": "2024-04-22T16:50:41Z",
"updated_at": "2024-06-28T15:38:26Z"
}
]Need help?
Join our Discord Server to ask questions or see what others are doing with Neon. Users on paid plans can open a support ticket from the console. For more details, see Getting Support.