Skip to content

compozy worktree pr

Open a pull request for the worktree

566 pages in CLI Reference

On this page4

Usage

compozy worktree pr <ref> [flags]

Options6

--basestring
Pull request base branch
--bodystring
Pull request body
--draft
Open as a draft
--help-h
help for pr
--titlestring
Pull request title
--workspacestring
Override workspace context (ID, name, or path)

Inherited options3

--json
Emit JSON output
--output-ostring
Output format: human, json, jsonl, or toon (default "human")
--profilestring
Act as a profile for this command

Output Formats

The root -o, --output flag accepts these values. A renderer is supported only when this command writes that result; jsonl is for commands that emit one JSON record per line.

FormatCommand result
humanInteractive terminal rendering
jsonMachine-readable JSON rendering
jsonlOne JSON record per line when supported
toonCompact agent-readable rendering

Example:

compozy worktree pr <ref> -o json