bdy project update

View as Markdown
$bdy project update|edit [options] [name]

Update project settings Required scopes: PROJECT_WRITE

ARGUMENTS
name
Project name (human-readable ID) to update. Defaults to the linked project (required)
OPTIONS
--context <name>
Connection and scope context: default, git, link or a saved name. Overrides the globally active context for this invocation.
--examples
Show only examples; with this flag --format accepts text, json or jsonl
--verbose
Show REST API requests, responses, timing and retries on stderr
-w, --workspace <domain>
Workspace URL handle. Can be set via variable: BUDDY_WORKSPACE
-n, --name <name>
New project name (human-readable ID). Commands using the old name stop finding the project
-d, --display-name <name>
New display name of the project
-a, --access <access>
Project access: PRIVATE, PUBLIC
--status <status>
Project status: ACTIVE, CLOSED (closed projects are archived)
-r, --allow-pull-requests
Enable pull requests (projects synchronized with GitHub or GitLab only)
--no-allow-pull-requests
Disable pull requests
--fetch-submodules
Fetch git submodules in the runs of this project. Requires --submodules-key
--no-fetch-submodules
Do not fetch git submodules
--submodules-key <env_key>
Name of the key used to authorize fetching submodules
--sync-default-branch
Update the default branch from GitHub, GitLab or Bitbucket
--no-sync-default-branch
Do not update the default branch from the external repository
--format <text|json>
Output format: json, text. JSON CLI errors: {error:{code,message,hint}}, exit 1. Default: text (choices: "text", "json")
-h, --help
display help for command

Documentation for bdy v1.25.34

Last modified on Nov 3, 2026

Examples

Change the display name of the linked project
bdy project update -d "My Project"$
Rename a project and make it public
bdy project update my-project -n new-name -a PUBLIC$
Fetch git submodules authorized with an SSH key variable
bdy project update my-project --fetch-submodules --submodules-key SSH_KEY$
Close (archive) a project
bdy project edit my-project --status closed$
Disable pull requests and return the project as JSON
bdy project update my-project --no-allow-pull-requests --format json$