update-repo

Update a repo by locator or self shorthand

Auth

Authenticated Owner Scope

Example

pearing-cli update-repo website --name "Website API" --description "Backend APIs for the website" --about "## Services\n\n- auth\n- billing"
pearing-cli update-repo website --max-disk-bytes "1 GB"
# or
# pearing-cli update-repo teams/platform/website --visibility public

Expected Response

Updates the resource and prints the updated JSON object.

Errors

  • 400 Bad Request for invalid flags/values.
  • 403 Forbidden when caller requests a disallowed update.
  • 404 Not Found when referenced owners/resources are missing.
  • 409 Conflict for uniqueness or state conflicts.

Common auth errors are documented on the CLI overview page.

Help Output

Update a repo by locator or self shorthand.

Usage: pearing-cli update-repo [OPTIONS] <REPO>

Arguments:
  <REPO>  Repo locator (`teams/<team_slug>/<repo_slug>` or `<username>/<repo_slug>`) or `<repo_slug>` for authenticated user

Options:
      --name <NAME>
          Repo name
      --description <DESCRIPTION>
          Repo description
      --about <ABOUT>
          Repo about markdown
      --slug <SLUG>
          Repo slug
      --visibility <VISIBILITY>
          Repo visibility [possible values: public, private]
      --default-branch <DEFAULT_BRANCH>
          Default branch name
      --max-disk-bytes <MAX_DISK_BYTES>
          Maximum repo size in human-readable bytes
  -h, --help
          Print help (see more with '--help')