Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
53 changes: 0 additions & 53 deletions apps/docs/content/docs/cli/console/apikey.mdx

This file was deleted.

50 changes: 0 additions & 50 deletions apps/docs/content/docs/cli/console/auth.mdx

This file was deleted.

53 changes: 0 additions & 53 deletions apps/docs/content/docs/cli/console/environment.mdx

This file was deleted.

54 changes: 16 additions & 38 deletions apps/docs/content/docs/cli/console/index.mdx
Original file line number Diff line number Diff line change
@@ -1,64 +1,42 @@
---
title: platform
description: 'Manage Prisma Console workspaces, projects, environments, and connection strings'
badge: early-access
description: Prisma Data Platform commands
url: /cli/console
metaTitle: 'Platform CLI: About'
metaDescription: Learn about the CLI for Prisma Console
metaTitle: prisma platform | Prisma Data Platform Commands
metaDescription: 'Interact with the Prisma Data Platform from the CLI. Check service status and more.'
---

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](/management-api) with improved authentication. Until the migration is complete, these commands remain in early access.

:::
The `prisma platform` command group provides tools for interacting with the Prisma Data Platform.

## Usage

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

## Global options
## Options

| Option | Description |
| ----------------- | ---------------------------------------------------------------- |
| `-h`, `--help` | Display help message |
| `--early-access` | Enable early access Console features (required for all commands) |
| Option | Description |
| -------------- | -------------------- |
| `-h`, `--help` | Display help message |

## Subcommands

| Command | Description |
| ----------------------------------------------------------- | -------------------------------- |
| [`prisma platform auth`](/cli/console/auth) | Manage Console authentication |
| [`prisma platform workspace`](/cli/console/workspace) | Manage workspaces |
| [`prisma platform project`](/cli/console/project) | Manage projects |
| [`prisma platform environment`](/cli/console/environment) | Manage environments |
| [`prisma platform apikey`](/cli/console/apikey) | Manage connection strings |
| Command | Description |
| -------------------------------------------------- | ---------------------------------------- |
| [`prisma platform status`](/cli/console/status) | Show Prisma Data Platform service status |

## 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
# Check service status
prisma platform status

# Create a connection string
prisma platform apikey create --environment $ENVIRONMENT_ID --name "production-key" --early-access
# Output status as JSON
prisma platform status --json
```

## See also

- [Console overview](/console)
- [Getting started with Console](/console/getting-started)
- [Management API](/management-api)
6 changes: 5 additions & 1 deletion apps/docs/content/docs/cli/console/meta.json
Original file line number Diff line number Diff line change
@@ -1 +1,5 @@
{"title": "Console", "icon": "Cloud", "pages": ["index", "auth", "workspace", "project", "environment", "apikey"]}
{
"title": "Console",
"defaultOpen": true,
"pages": ["index", "status"]
}
Loading
Loading