Neon CLI commands — roles

Before you begin

• Before running the roles command, ensure that you have installed the Neon CLI.
• If you have not authenticated with the neonctl 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-key option when running a command. See Connect.

For information about roles in Neon, see Manage roles.

The roles command

The roles command allows you to list, create, and delete roles in a Neon project.

Usage

neonctl roles <subcommand> [options]

list

This subcommand allows you to list roles.

Usage

neonctl roles list [options]

Options

In addition to the Neon CLI global options, the list subcommand supports these options:

If a branch ID or name is not provided, the command lists roles for the primary branch of the project.

Examples

neonctl roles list 
┌────────┬──────────────────────┐
│ Name   │ Created At           │
├────────┼──────────────────────┤
│ daniel │ 2023-06-19T18:27:19Z │
└────────┴──────────────────────┘

List roles with the --output format set to json:

neonctl roles list --output json
[
  {
    "branch_id": "br-odd-frog-703504",
    "name": "daniel",
    "protected": false,
    "created_at": "2023-06-28T10:17:28Z",
    "updated_at": "2023-06-28T10:17:28Z"
  }

create

This subcommand allows you to create a role.

Usage

neonctl roles create [options]

Options

In addition to the Neon CLI global options, the create subcommand supports these options:

If a branch ID or name is not provided, the command creates a role in the primary branch of the project.

Example

neonctl roles create --name sally
┌───────┬──────────────────────┐
│ Name  │ Created At           │
├───────┼──────────────────────┤
│ sally │ 2023-06-20T00:43:17Z │
└───────┴──────────────────────┘

delete

This subcommand allows you to delete a role.

Usage

neonctl roles delete <role> [options]

Options

In addition to the Neon CLI global options, the delete subcommand supports these options:

If a branch ID or name is not provided, the command assumes the role resides in the primary branch of the project.

Example

neonctl roles delete sally
┌───────┬──────────────────────┐
│ Name  │ Created At           │
├───────┼──────────────────────┤
│ sally │ 2023-06-20T00:43:17Z │
└───────┴──────────────────────┘