ContextQMD
Back to Prisma

platform

apps/docs/content/docs/cli/console/index.mdx

latest2.2 KB
Original Source

The prisma platform command group provides tools to manage Prisma Console workspaces, projects, environments, and connection strings.

:::warning[Legacy GraphQL API]

These commands currently rely on a deprecated GraphQL API. They are being modernized to use the Management API with improved authentication. Until the migration is complete, these commands remain in early access.

:::

Usage

bash
prisma platform [command] [options] --early-access

Global options

OptionDescription
-h, --helpDisplay help message
--early-accessEnable early access Console features (required for all commands)

Subcommands

CommandDescription
prisma platform authManage Console authentication
prisma platform workspaceManage workspaces
prisma platform projectManage projects
prisma platform environmentManage environments
prisma platform apikeyManage connection strings

Examples

bash
# Authenticate with Console
prisma platform auth login --early-access

# List workspaces
prisma platform workspace show --early-access

# Create a project
prisma platform project create --workspace $WORKSPACE_ID --name "My Project" --early-access

# Create an environment
prisma platform environment create --project $PROJECT_ID --name "production" --early-access

# Create a connection string
prisma platform apikey create --environment $ENVIRONMENT_ID --name "production-key" --early-access

See also