|
1 | 1 | --- |
2 | 2 | title: platform |
3 | | -description: 'Manage Prisma Console workspaces, projects, environments, and connection strings' |
4 | | -badge: early-access |
| 3 | +description: Prisma Data Platform commands |
5 | 4 | 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.' |
8 | 7 | --- |
9 | 8 |
|
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. |
17 | 10 |
|
18 | 11 | ## Usage |
19 | 12 |
|
20 | 13 | ```bash |
21 | | -prisma platform [command] [options] --early-access |
| 14 | +prisma platform [command] [options] |
22 | 15 | ``` |
23 | 16 |
|
24 | | -## Global options |
| 17 | +## Options |
25 | 18 |
|
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 | |
30 | 22 |
|
31 | 23 | ## Subcommands |
32 | 24 |
|
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 | |
40 | 28 |
|
41 | 29 | ## Examples |
42 | 30 |
|
43 | 31 | ```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 |
55 | 34 |
|
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 |
58 | 37 | ``` |
59 | 38 |
|
60 | 39 | ## See also |
61 | 40 |
|
62 | 41 | - [Console overview](/console) |
63 | 42 | - [Getting started with Console](/console/getting-started) |
64 | | -- [Management API](/management-api) |
0 commit comments