diff --git a/apps/docs/content/docs/cli/console/apikey.mdx b/apps/docs/content/docs/cli/console/apikey.mdx deleted file mode 100644 index 9cc60d19b5..0000000000 --- a/apps/docs/content/docs/cli/console/apikey.mdx +++ /dev/null @@ -1,53 +0,0 @@ ---- -title: apikey -description: 'Create, list, and delete connection strings for Prisma Console environments' -metaTitle: prisma platform apikey | Manage Console Connection Strings -metaDescription: 'Create, list, and delete connection strings for Prisma Console environments. Use prisma platform apikey show, create, and delete with --early-access.' -badge: early-access -url: /cli/console/apikey ---- - -The `prisma platform apikey` command manages connection strings for Prisma Console environments. - -## Usage - -```bash -prisma platform apikey [action] [options] --early-access -``` - -## Actions - -| Action | Description | -| -------- | ------------------------------ | -| `show` | List all connection strings | -| `create` | Create a new connection string | -| `delete` | Delete a connection string | - -## Options - -| Option | Description | -| ------------------- | ------------------------------------------------------------------------ | -| `-h`, `--help` | Display help message | -| `-e`, `--environment` | The environment ID (required for `show` and `create` commands) | -| `-a`, `--apikey` | The connection string ID (required for `delete` command) | -| `-n`, `--name` | Display name for the connection string (optional for `create` command) | - -## Examples - -### List connection strings - -```npm -npx prisma platform apikey show --environment $ENVIRONMENT_ID --early-access -``` - -### Create a connection string - -```npm -npx prisma platform apikey create --environment $ENVIRONMENT_ID --name "production-key" --early-access -``` - -### Delete a connection string - -```npm -npx prisma platform apikey delete --apikey $API_KEY_ID --early-access -``` diff --git a/apps/docs/content/docs/cli/console/auth.mdx b/apps/docs/content/docs/cli/console/auth.mdx deleted file mode 100644 index e5ac630044..0000000000 --- a/apps/docs/content/docs/cli/console/auth.mdx +++ /dev/null @@ -1,50 +0,0 @@ ---- -title: auth -description: Manage authentication with Prisma Console using the platform auth command -metaTitle: prisma platform auth | Console Login & Logout -metaDescription: 'Authenticate with Prisma Console using prisma platform auth. Log in, view your session, or log out. Required for Platform CLI commands.' -badge: early-access -url: /cli/console/auth ---- - -The `prisma platform auth` command manages authentication with Prisma Console. - -## Usage - -```bash -prisma platform auth [action] [options] --early-access -``` - -## Actions - -| Action | Description | -| -------- | -------------------------------- | -| `login` | Log in to Console | -| `show` | Display authenticated user info | -| `logout` | Log out of Console | - -## Options - -| Option | Description | -| -------------- | ------------------------ | -| `-h`, `--help` | Display help message | - -## Examples - -### Log in to Console - -```npm -npx prisma platform auth login --early-access -``` - -### Display authenticated user - -```npm -npx prisma platform auth show --early-access -``` - -### Log out - -```npm -npx prisma platform auth logout --early-access -``` diff --git a/apps/docs/content/docs/cli/console/environment.mdx b/apps/docs/content/docs/cli/console/environment.mdx deleted file mode 100644 index fcf8ba7a84..0000000000 --- a/apps/docs/content/docs/cli/console/environment.mdx +++ /dev/null @@ -1,53 +0,0 @@ ---- -title: environment -description: 'Create, list, and delete environments within Prisma Console projects' -metaTitle: prisma platform environment | Manage Console Environments -metaDescription: 'Create, list, and delete environments in Prisma Console projects. Use prisma platform environment show, create, and delete.' -badge: early-access -url: /cli/console/environment ---- - -The `prisma platform environment` command manages environments within Prisma Console projects. - -## Usage - -```bash -prisma platform environment [action] [options] --early-access -``` - -## Actions - -| Action | Description | -| -------- | -------------------------- | -| `show` | List all environments | -| `create` | Create a new environment | -| `delete` | Delete an environment | - -## Options - -| Option | Description | -| ------------------- | ------------------------------------------------------------------- | -| `-h`, `--help` | Display help message | -| `-p`, `--project` | The project ID (required for `show` and `create` commands) | -| `-e`, `--environment` | The environment ID (required for `delete` command) | -| `-n`, `--name` | Display name for the environment (optional for `create` command) | - -## Examples - -### List environments - -```npm -npx prisma platform environment show --project $PROJECT_ID --early-access -``` - -### Create an environment - -```npm -npx prisma platform environment create --project $PROJECT_ID --name "production" --early-access -``` - -### Delete an environment - -```npm -npx prisma platform environment delete --environment $ENVIRONMENT_ID --early-access -``` diff --git a/apps/docs/content/docs/cli/console/index.mdx b/apps/docs/content/docs/cli/console/index.mdx index 92e2ae86de..3a1e9116ee 100644 --- a/apps/docs/content/docs/cli/console/index.mdx +++ b/apps/docs/content/docs/cli/console/index.mdx @@ -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) diff --git a/apps/docs/content/docs/cli/console/meta.json b/apps/docs/content/docs/cli/console/meta.json index ded3a46bd6..da77414ddf 100644 --- a/apps/docs/content/docs/cli/console/meta.json +++ b/apps/docs/content/docs/cli/console/meta.json @@ -1 +1,5 @@ -{"title": "Console", "icon": "Cloud", "pages": ["index", "auth", "workspace", "project", "environment", "apikey"]} +{ + "title": "Console", + "defaultOpen": true, + "pages": ["index", "status"] +} diff --git a/apps/docs/content/docs/cli/console/platform.mdx b/apps/docs/content/docs/cli/console/platform.mdx deleted file mode 100644 index c6745a7b88..0000000000 --- a/apps/docs/content/docs/cli/console/platform.mdx +++ /dev/null @@ -1,163 +0,0 @@ ---- -title: platform -description: 'Manage Prisma Console workspaces, projects, environments, and connection strings' -metaTitle: prisma platform | Console CLI Commands Reference -metaDescription: 'Manage Prisma Console workspaces, projects, environments, and connection strings from the CLI. Auth, workspace, project, environment, and apikey subcommands.' -badge: early-access -url: /cli/console/platform ---- - -The `prisma platform` command provides access to Prisma Console functionality for managing workspaces, projects, environments, and connection strings. - -## Usage - -```bash -prisma platform [subcommand] [options] --early-access -``` - -## Subcommands - -| Subcommand | Description | -| ------------- | -------------------------------- | -| `auth` | Manage Console authentication | -| `workspace` | Manage workspaces | -| `project` | Manage projects | -| `environment` | Manage environments | -| `apikey` | Manage connection strings | - -## Examples - -### Authenticate with Console - -Log in to your Console account (opens a browser window for GitHub authentication): - -```npm -npx prisma platform auth login --early-access -``` - -Display information about the currently authenticated user: - -```npm -npx prisma platform auth show --early-access -``` - -Log out of your Console account: - -```npm -npx prisma platform auth logout --early-access -``` - -### Manage workspaces - -List all workspaces available to your account: - -```npm -npx prisma platform workspace show --early-access -``` - -### Manage projects - -List all projects within a workspace: - -```npm -npx prisma platform project show --workspace $WORKSPACE_ID --early-access -``` - -Create a new project within a workspace: - -```npm -npx prisma platform project create --workspace $WORKSPACE_ID --name "My Project" --early-access -``` - -Delete a project: - -```npm -npx prisma platform project delete --project $PROJECT_ID --early-access -``` - -### Manage environments - -List all environments within a project: - -```npm -npx prisma platform environment show --project $PROJECT_ID --early-access -``` - -Create a new environment within a project: - -```npm -npx prisma platform environment create --project $PROJECT_ID --name "production" --early-access -``` - -Delete an environment: - -```npm -npx prisma platform environment delete --environment $ENVIRONMENT_ID --early-access -``` - -### Manage connection strings - -List all connection strings for an environment: - -```npm -npx prisma platform apikey show --environment $ENVIRONMENT_ID --early-access -``` - -Create a new connection string for an environment: - -```npm -npx prisma platform apikey create --environment $ENVIRONMENT_ID --name "production-key" --early-access -``` - -Delete a connection string: - -```npm -npx prisma platform apikey delete --apikey $API_KEY_ID --early-access -``` - -## Options - -### Authentication commands - -| Option | Description | -| -------------- | ------------------------ | -| `-h`, `--help` | Display help message | - -### Workspace commands - -| Option | Description | -| ----------------- | -------------------------------- | -| `-h`, `--help` | Display help message | - -### Project commands - -| Option | Description | -| ------------------ | ---------------------------------------------------------------- | -| `-h`, `--help` | Display help message | -| `-w`, `--workspace` | The workspace ID (required for `show` and `create` commands) | -| `-p`, `--project` | The project ID (required for `delete` command) | -| `-n`, `--name` | Display name for the project (optional for `create` command) | - -### Environment commands - -| Option | Description | -| ------------------- | ------------------------------------------------------------------- | -| `-h`, `--help` | Display help message | -| `-p`, `--project` | The project ID (required for `show` and `create` commands) | -| `-e`, `--environment` | The environment ID (required for `delete` command) | -| `-n`, `--name` | Display name for the environment (optional for `create` command) | - -### Connection string commands - -| Option | Description | -| ------------------- | ------------------------------------------------------------------------ | -| `-h`, `--help` | Display help message | -| `-e`, `--environment` | The environment ID (required for `show` and `create` commands) | -| `-a`, `--apikey` | The connection string ID (required for `delete` command) | -| `-n`, `--name` | Display name for the connection string (optional for `create` command) | - -### Global options - -| Option | Description | -| ----------------- | ---------------------------------- | -| `--early-access` | Enable early access Console features (required for all commands) | diff --git a/apps/docs/content/docs/cli/console/project.mdx b/apps/docs/content/docs/cli/console/project.mdx deleted file mode 100644 index 7b5921fb7d..0000000000 --- a/apps/docs/content/docs/cli/console/project.mdx +++ /dev/null @@ -1,53 +0,0 @@ ---- -title: project -description: 'Create, list, and delete projects within Prisma Console workspaces' -metaTitle: prisma platform project | Manage Console Projects -metaDescription: 'Create, list, and delete projects in Prisma Console workspaces. Use prisma platform project show, create, and delete.' -badge: early-access -url: /cli/console/project ---- - -The `prisma platform project` command manages projects within Prisma Console workspaces. - -## Usage - -```bash -prisma platform project [action] [options] --early-access -``` - -## Actions - -| Action | Description | -| -------- | ------------------------ | -| `show` | List all projects | -| `create` | Create a new project | -| `delete` | Delete a project | - -## Options - -| Option | Description | -| ------------------ | ---------------------------------------------------------------- | -| `-h`, `--help` | Display help message | -| `-w`, `--workspace` | The workspace ID (required for `show` and `create` commands) | -| `-p`, `--project` | The project ID (required for `delete` command) | -| `-n`, `--name` | Display name for the project (optional for `create` command) | - -## Examples - -### List projects - -```npm -npx prisma platform project show --workspace $WORKSPACE_ID --early-access -``` - -### Create a project - -```npm -npx prisma platform project create --workspace $WORKSPACE_ID --name "My Project" --early-access -``` - -### Delete a project - -```npm -npx prisma platform project delete --project $PROJECT_ID --early-access -``` diff --git a/apps/docs/content/docs/cli/console/status.mdx b/apps/docs/content/docs/cli/console/status.mdx new file mode 100644 index 0000000000..97ca20e009 --- /dev/null +++ b/apps/docs/content/docs/cli/console/status.mdx @@ -0,0 +1,36 @@ +--- +title: status +description: Show Prisma Data Platform service status +metaTitle: prisma platform status | Check Platform Service Status +metaDescription: 'Check the current status of Prisma Data Platform services with prisma platform status. Supports JSON output.' +url: /cli/console/status +--- + +The `prisma platform status` command shows the current status of Prisma Data Platform services. + +## Usage + +```bash +prisma platform status [options] +``` + +## Options + +| Option | Description | +| -------------- | ----------------------------------- | +| `-h`, `--help` | Display help message | +| `--json` | Output raw JSON from the status API | + +## Examples + +### Check service status + +```npm +npx prisma platform status +``` + +### Output status as JSON + +```npm +npx prisma platform status --json +``` diff --git a/apps/docs/content/docs/cli/console/workspace.mdx b/apps/docs/content/docs/cli/console/workspace.mdx deleted file mode 100644 index c75c03e831..0000000000 --- a/apps/docs/content/docs/cli/console/workspace.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: workspace -description: List and manage workspaces in Prisma Console -metaTitle: prisma platform workspace | List Console Workspaces -metaDescription: 'List and manage workspaces in Prisma Console. Use prisma platform workspace show to view all workspaces available to your account.' -badge: early-access -url: /cli/console/workspace ---- - -The `prisma platform workspace` command manages workspaces in Prisma Console. - -## Usage - -```bash -prisma platform workspace [action] [options] --early-access -``` - -## Actions - -| Action | Description | -| ------ | ------------------------ | -| `show` | List all workspaces | - -## Options - -| Option | Description | -| ----------------- | -------------------------------- | -| `-h`, `--help` | Display help message | - -## Examples - -### List workspaces - -```npm -npx prisma platform workspace show --early-access -``` diff --git a/apps/docs/content/docs/console/concepts.mdx b/apps/docs/content/docs/console/concepts.mdx index 1adc85b535..85b68728bf 100644 --- a/apps/docs/content/docs/console/concepts.mdx +++ b/apps/docs/content/docs/console/concepts.mdx @@ -35,14 +35,6 @@ In each workspace, you can: - invite other users to collaborate in the workspace. - access the [Optimize dashboard](https://console.prisma.io/optimize?utm_source=docs&utm_medium=optimize-docs) to measure query performance and receive AI-powered recommendations. -### CLI commands - -List all workspaces: - -```npm -npx prisma platform workspace show --early-access -``` - ## Project In each workspace, you can create several projects. A project typically represents an application (a product or service). You typically have one [Prisma schema](/orm/prisma-schema/overview) per project. @@ -53,26 +45,6 @@ In each project, you can: The number of projects you can create in a workspace depends on the [subscription plan](https://www.prisma.io/pricing?utm_source=docs&utm_medium=platform-docs) configured in that workspace. -### CLI commands - -List all projects in a workspace: - -```npm -npx prisma platform project show --workspace $WORKSPACE_ID --early-access -``` - -Create a new project: - -```npm -npx prisma platform project create --workspace $WORKSPACE_ID --name "My Project" --early-access -``` - -Delete a project: - -```npm -npx prisma platform project delete --project $PROJECT_ID --early-access -``` - ## Resources Resources represent the actual services or databases within a project. The type of resources available depends on the Prisma products you're using: @@ -98,22 +70,3 @@ In each project, you can: The number of resources you can create in a project depends on your [subscription plan](https://www.prisma.io/pricing?utm_source=docs&utm_medium=platform-docs). -### CLI commands - -List all environments (resources) in a project: - -```npm -npx prisma platform environment show --project $PROJECT_ID --early-access -``` - -Create a new environment: - -```npm -npx prisma platform environment create --project $PROJECT_ID --name "production" --early-access -``` - -Delete an environment: - -```npm -npx prisma platform environment delete --environment $ENVIRONMENT_ID --early-access -``` diff --git a/apps/docs/content/docs/console/getting-started.mdx b/apps/docs/content/docs/console/getting-started.mdx index bc68c876d2..5315b01662 100644 --- a/apps/docs/content/docs/console/getting-started.mdx +++ b/apps/docs/content/docs/console/getting-started.mdx @@ -34,14 +34,6 @@ To create an additional workspace: 3. Enter a name for your workspace 4. Click **Create** -### Using the CLI - -List all workspaces: - -```npm -npx prisma platform workspace show --early-access -``` - ## Step 3: Create a project Projects organize your databases and environments within a workspace. @@ -53,12 +45,6 @@ Projects organize your databases and environments within a workspace. 3. Enter a project name 4. Click **Create** -### Using the CLI - -```npm -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. @@ -78,12 +64,6 @@ Resources are the actual databases or environments within your project. 3. Enter an environment name (e.g., "production") 4. Click **Create** -### Using the CLI - -```npm -npx prisma platform environment create --project $PROJECT_ID --name "production" --early-access -``` - ## Step 5: Generate a connection string Connection strings authenticate your application's requests to Prisma products. @@ -97,12 +77,6 @@ Connection strings authenticate your application's requests to Prisma products. 5. Copy the connection string and store it securely 6. Click **Done** -### Using the CLI - -```npm -npx prisma platform apikey create --environment $ENVIRONMENT_ID --name "production-key" --early-access -``` - ## Step 6: Use the connection string in your application Add the connection string to your `.env` file: diff --git a/apps/docs/vercel.json b/apps/docs/vercel.json index 1d950b480f..59f5be16f7 100644 --- a/apps/docs/vercel.json +++ b/apps/docs/vercel.json @@ -1294,7 +1294,14 @@ {"source": "/docs/about/:slug", "destination": "/docs", "permanent": true}, {"source": "/docs/concepts/overview/prisma-in-your-stack/:slug", "destination": "/docs/orm", "permanent": true}, {"source": "/docs/orm/more/help-and-troubleshooting/dataguide/:slug", "destination": "/docs/orm/more/troubleshooting/nextjs", "permanent": true}, - {"source": "/docs/postgres/database/caching", "destination": "/docs/accelerate/caching", "permanent": true} + {"source": "/docs/postgres/database/caching", "destination": "/docs/accelerate/caching", "permanent": true}, + + {"source": "/docs/cli/console/auth", "destination": "/docs/cli/console", "permanent": true}, + {"source": "/docs/cli/console/workspace", "destination": "/docs/cli/console", "permanent": true}, + {"source": "/docs/cli/console/project", "destination": "/docs/cli/console", "permanent": true}, + {"source": "/docs/cli/console/environment", "destination": "/docs/cli/console", "permanent": true}, + {"source": "/docs/cli/console/apikey", "destination": "/docs/cli/console", "permanent": true}, + {"source": "/docs/cli/console/platform", "destination": "/docs/cli/console", "permanent": true} ] }