projects
projects create
Create a new project
Create a new PgBeam project in your organization. A project groups one or more database connections under a single proxy endpoint. Without flags, the command runs interactively and prompts for all required values including the upstream database connection details and SSL mode.
Usage
pgbeam projects create [flags]Options
| Option | Description | Required | Default |
|---|---|---|---|
--name <value> | Display name for the project | No | - |
--host <value> | Hostname or IP address of the upstream PostgreSQL server | No | - |
--port <value> | Port number of the upstream PostgreSQL server | No | 5432 |
--database <value> | Name of the database on the upstream server | No | - |
--username <value> | Username for authenticating with the upstream database | No | - |
--password <value> | Password for authenticating with the upstream database | No | - |
--ssl-mode <value> | SSL connection mode: disable, require, verify-ca, or verify-full | No | - |
Global options
All global options (--token, --profile,
--project, --org, --json, --no-color, --debug) are also available on
this command.
Examples
# Interactive project creation
pgbeam projects create
# Create with all flags (non-interactive)
pgbeam projects create --name my-app --host db.example.com --port 5432 --database mydb --username admin --password secret --ssl-mode require
# Create and capture the project ID for scripting
PROJECT_ID=$(pgbeam projects create --name my-app --host db.example.com --database mydb --username admin --password secret --json | jq -r '.project.id')Output
Prints the new project ID, name, and database host. Suggests running
pgbeam link as a next step. With --json, returns the full project and
database objects.