Prisma /docs
Getting StartedORMPostgresCLIGuides

Getting Started

Quick start guide for setting up and using the Prisma Console

This guide walks you through setting up your Console account and creating your first project.

Prerequisites

  • A GitHub account (for authentication)
  • A Prisma project (optional, but recommended)

Step 1: Create your account

  1. Go to console.prisma.io/login
  2. Click Sign in with GitHub
  3. Authorize Prisma Console to access your GitHub account

You now have a Console account with a default workspace.

Step 2: Set up a workspace

When you create an account, a default workspace is automatically created for you. You can create additional workspaces for different teams or organizations.

Create a workspace (optional)

To create an additional workspace:

  1. Click the workspace dropdown in the top navigation
  2. Click Create Workspace
  3. Enter a name for your workspace
  4. Click Create

Using the CLI

List all workspaces:

npx prisma platform workspace show --early-access

Step 3: Create a project

Projects organize your databases and environments within a workspace.

Using the Console web interface

  1. Navigate to your workspace
  2. Click Create Project
  3. Enter a project name
  4. Click Create

Using the CLI

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

Step 4: Create a resource

Resources are the actual databases or environments within your project.

For Prisma Postgres

  1. Navigate to your project
  2. Click Create Database
  3. Enter a database name
  4. Select a region
  5. Click Create

For Accelerate

  1. Navigate to your project
  2. Click Create Environment
  3. Enter an environment name (e.g., "production")
  4. Click Create

Using the CLI

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

Step 5: Generate an API key

API keys authenticate your application's requests to Prisma products.

Using the Console web interface

  1. Navigate to your resource (database or environment)
  2. Click API Keys tab
  3. Click Create API Key
  4. Enter a name for the key
  5. Copy the API key and store it securely
  6. Click Done

Using the CLI

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

Step 6: Use the API key in your application

Add the API key to your .env file:

# For Accelerate
DATABASE_URL="prisma://accelerate.prisma-data.net/?api_key=YOUR_API_KEY"

# For Optimize
OPTIMIZE_API_KEY="YOUR_API_KEY"

Next steps

Edit on GitHub

Console

Learn how to use the Console to manage and integrate Prisma products into your application.

Concepts

Understand the core concepts of the Prisma Console: user accounts, workspaces, projects, and resources

On this page

PrerequisitesStep 1: Create your accountStep 2: Set up a workspaceCreate a workspace (optional)Using the CLIStep 3: Create a projectUsing the Console web interfaceUsing the CLIStep 4: Create a resourceFor Prisma PostgresFor AccelerateUsing the CLIStep 5: Generate an API keyUsing the Console web interfaceUsing the CLIStep 6: Use the API key in your applicationNext steps