Skip to main content

Documentation Index

Fetch the complete documentation index at: https://planetscale.com/docs/llms.txt

Use this file to discover all available pages before exploring further.

Resources are provisioned in your PlanetScale account with normal access and dashboards. Your billing page in the PlanetScale dashboard will indicate that you are connected to the Stripe app and payments are made through Stripe.
Stripe Projects is currently in developer preview. You can request access to try it out here.

​
Before you begin

Before you can use PlanetScale with the Stripe CLI, you’ll need:
  • Access to the developer preview
  • A Stripe account
  • A PlanetScale account (or Stripe Projects can create one for you)
  • The Stripe CLI installed and up to date
  • The Projects plugin installed:
stripe plugin install projects

​
Quickstart

Initialize Stripe Projects in your app directory, add a PlanetScale database, and sync credentials to your local environment: 
# Enter into your app directory
cd my-app

# Initialize a new Stripe project
stripe projects init

# Add a PlanetScale Postgres database
stripe projects add planetscale/postgresql

# Or add a PlanetScale MySQL database
stripe projects add planetscale/mysql

# Sync credentials to your local .env file
stripe projects env --sync
After syncing, your .env file will be updated with your PlanetScale database connection string.

​
Add a database

When you run stripe projects add, you can sign in to your existing PlanetScale account or let Stripe Projects create a new one. You’ll be prompted to configure:
  • Database name
  • Cluster size
  • Region
  • Number of replicas
Once confirmed, your database is provisioned and credentials are returned in an agent-readable format.

​
Manage credentials

List your project’s environment variables (values are not shown): 
stripe projects env list
Sync credentials to your local .env file: 
stripe projects env --sync
Rotate credentials for your PlanetScale database: 
stripe projects rotate planetscale/postgresql
stripe projects rotate planetscale/mysql

​
Check project status

Review your project’s linked providers, provisioned services, and health: 
stripe projects status

​
Open your PlanetScale dashboard

stripe projects open planetscale

​
Remove a database

This is a destructive operation. Running this command will delete your PlanetScale database.
stripe projects remove planetscale/postgresql
stripe projects remove planetscale/mysql

​
Non-interactive and agent use

All commands support flags for use in CI/CD pipelines, scripts, and AI agents:
FlagDescription
--jsonReturn output as structured JSON
--no-interactiveDisable prompts; commands fail if input is missing
--auto-confirmAccept confirmation prompts automatically
--quietSuppress non-essential output
Example — add a database with no prompts: 
stripe projects add planetscale/postgresql \
  --no-interactive \
  --json

​
Further reading

For full documentation on Stripe Projects, including billing, LLM context generation, the complete command reference, and regional availability, see the Stripe Projects documentation. You can also view PlanetScale in the Stripe Marketplace to get started.

​
Need help?

Get help from the PlanetScale Support team, or join our Discord community to see how others are using PlanetScale.