CliConsole

platform

Manage Prisma Console workspaces, projects, environments, and API keys

The prisma platform command provides access to Prisma Console functionality for managing workspaces, projects, environments, and API keys.

Usage

prisma platform [subcommand] [options] --early-access

Subcommands

SubcommandDescription
authManage Console authentication
workspaceManage workspaces
projectManage projects
environmentManage environments
apikeyManage API keys

Examples

Authenticate with Console

Log in to your Console account (opens a browser window for GitHub authentication):

npx prisma platform auth login --early-access

Display information about the currently authenticated user:

npx prisma platform auth show --early-access

Log out of your Console account:

npx prisma platform auth logout --early-access

Manage workspaces

List all workspaces available to your account:

npx prisma platform workspace show --early-access

Manage projects

List all projects within a workspace:

npx prisma platform project show --workspace $WORKSPACE_ID --early-access

Create a new project within a workspace:

npx prisma platform project create --workspace $WORKSPACE_ID --name "My Project" --early-access

Delete a project:

npx prisma platform project delete --project $PROJECT_ID --early-access

Manage environments

List all environments within a project:

npx prisma platform environment show --project $PROJECT_ID --early-access

Create a new environment within a project:

npx prisma platform environment create --project $PROJECT_ID --name "production" --early-access

Delete an environment:

npx prisma platform environment delete --environment $ENVIRONMENT_ID --early-access

Manage API keys

List all API keys for an environment:

npx prisma platform apikey show --environment $ENVIRONMENT_ID --early-access

Create a new API key for an environment:

npx prisma platform apikey create --environment $ENVIRONMENT_ID --name "production-key" --early-access

Delete an API key:

npx prisma platform apikey delete --apikey $API_KEY_ID --early-access

Options

Authentication commands

OptionDescription
-h, --helpDisplay help message

Workspace commands

OptionDescription
-h, --helpDisplay help message

Project commands

OptionDescription
-h, --helpDisplay help message
-w, --workspaceThe workspace ID (required for show and create commands)
-p, --projectThe project ID (required for delete command)
-n, --nameDisplay name for the project (optional for create command)

Environment commands

OptionDescription
-h, --helpDisplay help message
-p, --projectThe project ID (required for show and create commands)
-e, --environmentThe environment ID (required for delete command)
-n, --nameDisplay name for the environment (optional for create command)

API key commands

OptionDescription
-h, --helpDisplay help message
-e, --environmentThe environment ID (required for show and create commands)
-a, --apikeyThe API key ID (required for delete command)
-n, --nameDisplay name for the API key (optional for create command)

Global options

OptionDescription
--early-accessEnable early access Console features (required for all commands)

On this page