---
title: "projects update"
description: "Update project settings"
canonical: "https://pgbeam.com/docs/cli/projects/update"
last-updated: "2026-10-30T13:32:17.000Z"
---

# projects update

> Update project settings

URL: https://pgbeam.com/docs/cli/projects/update

{/* Auto-generated from CLI commands. Do not edit. Run `pnpm generate:cli-docs` to regenerate. */}

Update the settings of an existing project. If no project ID is provided, uses the linked project in the current directory. At least one update flag must be provided. `--agents-disabled` is the project kill-switch: setting it true blocks ALL agent-credential connections (live sessions drop within seconds); passthrough/human connections are unaffected. `--allowed-cidrs` replaces the IP allowlist; pass an empty string to allow all.

## Usage

```bash
pgbeam projects update [id] [flags]
```

## Options

| Option                                | Description                                                                                                     | Required | Default |
| ------------------------------------- | --------------------------------------------------------------------------------------------------------------- | -------- | ------- |
| `<id>`                                | Project ID to update. Uses the linked project if omitted.                                                       | No       | -       |
| `--name <value>`                      | New display name for the project                                                                                | No       | -       |
| `--description <value>`               | New project description                                                                                         | No       | -       |
| `--tags <value>`                      | Comma-separated labels (replaces the current set)                                                               | No       | -       |
| `--status <value>`                    | Project lifecycle status: active, suspended, or deleted                                                         | No       | -       |
| `--allowed-cidrs <value>`             | Comma-separated CIDR ranges for the IP allowlist (replaces the current set). Pass an empty string to allow all. | No       | -       |
| `--default-policy-profile-id <value>` | Policy profile enforced on passthrough/human connections. Pass an empty string to clear.                        | No       | -       |
| `--agents-disabled <value>`           | Project kill-switch. true blocks all agent-credential connections; false re-enables.                            | No       | -       |

> **Global options**
>
> All [global options](/docs/cli/global-options) (`--token`, `--profile`,
> `--project`, `--org`, `--json`, `--no-color`, `--no-trunc`, `--debug`) are
> also available on this command.

## Examples

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

# Engage the kill-switch (block all agents)
pgbeam projects update --agents-disabled true

# Restrict access to an office IP range
pgbeam projects update --allowed-cidrs "203.0.113.0/24,10.0.0.0/8"

# Clear the IP allowlist (allow all)
pgbeam projects update --allowed-cidrs ""

# Set the default policy for passthrough connections
pgbeam projects update --default-policy-profile-id pol_xxx

# Replace tags and description
pgbeam projects update --tags "prod,us-east-1" --description "Prod proxy"
```

## Output

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