Neon CLI command: roles

The roles command lists, creates, and deletes roles in a Neon project from the terminal. For information about roles in Neon, see Manage roles. If --project-id is omitted, the CLI resolves it from your context file, auto-selects when your account has only one project, and prompts otherwise.

neon roles list

Lists roles. If you don't specify a branch ID or name with --branch, the command targets the project's default branch. This applies to all roles subcommands.

neon roles list [options]

List roles with the default table output format:

neon roles list

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

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

neon 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"
  }
]

neon roles create

Creates a role. The role name cannot exceed 63 bytes.

neon roles create [options]

neon roles create --name sally

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

neon roles delete

Deletes a role. The <role> is the role name.

neon roles delete <role> [options]

neon roles delete sally

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