Skip to content

Commit ff8d2ec

Browse files
fix(docs): remove outdated platform CLI subcommands (#7691)
* fix(docs): remove outdated platform CLI subcommands that no longer exist The Prisma CLI `prisma platform` command now only supports `status`. The previously documented subcommands (auth, workspace, project, environment, apikey) have been removed from the CLI but were still referenced throughout the docs, causing confusion for users trying to follow the Console auth and project management workflows. * fix(docs): add redirects for removed platform CLI subcommand pages Redirect old URLs for auth, workspace, project, environment, apikey, and platform pages to the updated Console CLI reference page. * fix(docs): split platform CLI into overview + status page Match the structure of other CLI command groups (db, migrate, dev) with an index page for the command group overview and a dedicated page for each subcommand.
1 parent 348636a commit ff8d2ec

File tree

12 files changed

+65
-521
lines changed

12 files changed

+65
-521
lines changed

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

Lines changed: 0 additions & 53 deletions
This file was deleted.

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

Lines changed: 0 additions & 50 deletions
This file was deleted.

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

Lines changed: 0 additions & 53 deletions
This file was deleted.
Lines changed: 16 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -1,64 +1,42 @@
11
---
22
title: platform
3-
description: 'Manage Prisma Console workspaces, projects, environments, and connection strings'
4-
badge: early-access
3+
description: Prisma Data Platform commands
54
url: /cli/console
6-
metaTitle: 'Platform CLI: About'
7-
metaDescription: Learn about the CLI for Prisma Console
5+
metaTitle: prisma platform | Prisma Data Platform Commands
6+
metaDescription: 'Interact with the Prisma Data Platform from the CLI. Check service status and more.'
87
---
98

10-
The `prisma platform` command group provides tools to manage Prisma Console workspaces, projects, environments, and connection strings.
11-
12-
:::warning[Legacy GraphQL API]
13-
14-
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.
15-
16-
:::
9+
The `prisma platform` command group provides tools for interacting with the Prisma Data Platform.
1710

1811
## Usage
1912

2013
```bash
21-
prisma platform [command] [options] --early-access
14+
prisma platform [command] [options]
2215
```
2316

24-
## Global options
17+
## Options
2518

26-
| Option | Description |
27-
| ----------------- | ---------------------------------------------------------------- |
28-
| `-h`, `--help` | Display help message |
29-
| `--early-access` | Enable early access Console features (required for all commands) |
19+
| Option | Description |
20+
| -------------- | -------------------- |
21+
| `-h`, `--help` | Display help message |
3022

3123
## Subcommands
3224

33-
| Command | Description |
34-
| ----------------------------------------------------------- | -------------------------------- |
35-
| [`prisma platform auth`](/cli/console/auth) | Manage Console authentication |
36-
| [`prisma platform workspace`](/cli/console/workspace) | Manage workspaces |
37-
| [`prisma platform project`](/cli/console/project) | Manage projects |
38-
| [`prisma platform environment`](/cli/console/environment) | Manage environments |
39-
| [`prisma platform apikey`](/cli/console/apikey) | Manage connection strings |
25+
| Command | Description |
26+
| -------------------------------------------------- | ---------------------------------------- |
27+
| [`prisma platform status`](/cli/console/status) | Show Prisma Data Platform service status |
4028

4129
## Examples
4230

4331
```bash
44-
# Authenticate with Console
45-
prisma platform auth login --early-access
46-
47-
# List workspaces
48-
prisma platform workspace show --early-access
49-
50-
# Create a project
51-
prisma platform project create --workspace $WORKSPACE_ID --name "My Project" --early-access
52-
53-
# Create an environment
54-
prisma platform environment create --project $PROJECT_ID --name "production" --early-access
32+
# Check service status
33+
prisma platform status
5534

56-
# Create a connection string
57-
prisma platform apikey create --environment $ENVIRONMENT_ID --name "production-key" --early-access
35+
# Output status as JSON
36+
prisma platform status --json
5837
```
5938

6039
## See also
6140

6241
- [Console overview](/console)
6342
- [Getting started with Console](/console/getting-started)
64-
- [Management API](/management-api)
Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,5 @@
1-
{"title": "Console", "icon": "Cloud", "pages": ["index", "auth", "workspace", "project", "environment", "apikey"]}
1+
{
2+
"title": "Console",
3+
"defaultOpen": true,
4+
"pages": ["index", "status"]
5+
}

0 commit comments

Comments
 (0)