PgBeam Docs
projects

projects update

Update project settings

Update the settings of an existing project. Currently supports renaming the project. If no project ID is provided, uses the linked project in the current directory. At least one update flag must be provided.

Usage

pgbeam projects update [id] [flags]

Options

OptionDescriptionRequiredDefault
<id>Project ID to update. Uses the linked project if omitted.No-
--name <value>New display name for the projectNo-

Global options

All global options (--token, --profile, --project, --org, --json, --no-color, --debug) are also available on this command.

Examples

# Rename the linked project
pgbeam projects update --name new-name

# Rename a specific project
pgbeam projects update prj_xxx --name new-name

# Update and get the result as JSON
pgbeam projects update --name new-name --json

Output

Prints a success message confirming the project was updated. With --json, returns the updated project object.

On this page