create-pull

Create a pull targeting a repo

Auth

Authenticated

Example

pearing-cli create-pull website \
  --source-repo alice/website-fork \
  --source-ref feature-x \
  --target-ref main \
  --title "Feature x" \
  --body "Please review"
# or read the body from stdin explicitly
printf 'Please review\n' \
| pearing-cli create-pull website \
  --body - \
  --source-repo alice/website-fork \
  --source-ref feature-x \
  --target-ref main \
  --title "Feature x"

Expected Response

Creates the resource and prints the created JSON object.

Errors

400 Bad Request for invalid flags/values.
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

Create a pull targeting a repo.

Usage: pearing-cli create-pull [OPTIONS] --source-repo <SOURCE_REPO> --source-ref <SOURCE_REF> --target-ref <TARGET_REF> --title <TITLE> <REPO>

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

Options:
      --source-repo <SOURCE_REPO>  Source repo locator (`teams/<team_slug>/<repo_slug>` or `<username>/<repo_slug>`)
      --source-ref <SOURCE_REF>    Source ref
      --target-ref <TARGET_REF>    Target ref
      --title <TITLE>              Pull title
      --body <BODY>                Pull body. Pass '-' to read from stdin
      --status <STATUS>            Initial status (open or draft) [possible values: open, draft, closed, merged]
  -h, --help                       Print help (see more with '--help')