Skip to content

submit

The submit command updates your pull request with the latest changes from your branch and optionally creates a new PR if one doesn't exist. It streamlines the process of sharing your changes with your team for review.

Usage

bash
pq submit [BRANCH_NAME] [OPTIONS]

Arguments

ArgumentDescription
BRANCH_NAMEOptional branch to update PR for

Options

OptionDescription
--create-pr / --no-create-prCreate or skip a missing PR without prompting
--push / --no-pushPush or skip an unpushed PR base branch without prompting
--draft / --no-draftCreate a missing PR as draft or ready for review
--title TEXTSet the title of a missing PR
--body TEXTSet the body of a missing PR
--body-file PATHRead the body from a file; use - for stdin
--reviewer USERNAMEAdd a reviewer; repeat for multiple reviewers
--no-reviewersCreate without reviewers or a reviewer prompt
--defaultsUse a generated title, empty body, and no reviewers without metadata prompts
--yes, -ySkip the final PR creation confirmation
--jsonOutput machine-readable JSON and disable remaining prompts

Examples

Basic Usage

bash
pq submit

For a Specific Branch

bash
pq submit feature-auth

Creating New PRs

When a branch doesn't have an existing PR, submit will prompt you to create one. During the PR creation process, you'll be asked whether to create it as a draft PR, giving you the option to share work-in-progress changes.

For a fully non-interactive submission that creates a missing PR:

bash
pq submit feature-auth \
  --create-pr \
  --push \
  --no-draft \
  --defaults \
  --yes \
  --json

INFO

Use submit as your primary command for sharing changes for review.

TIP

After making revisions based on PR feedback, use submit again to update the PR.

Released under the MIT License.