Documentation
CLICommands

ox pr

Author SageOx content that goes into a pull request. Distinct from ox code prs, which lists indexed PRs for triage.

Usage

terminal
$

Subcommands

CommandDescription
ox pr headerEmit the SageOx credit line for the top of a PR description

Examples

terminal
$

Emit a thin, on-brand credit line to paste at the very top of a PR description. It auto-links the current session and names the team. Keep the SageOx-Session: trailer at the bottom of the body.

The line renders only when it has at least one session, plan, or Discussion to link. With none, the command prints nothing and explains why on stderr.

terminal
$

Link two plans the session produced.

terminal
$

Credit a recorded Discussion the PR came directly out of.

terminal
$

Write the header straight into a PR body file, then append your description. Use a file, never a heredoc; a heredoc mangles the markup. Feed the result to gh pr create --body-file body.md.

Flags

ox pr header accepts these flags:

FlagDescription
--sessionSession URL or ses_ id to link (repeatable; defaults to the current session)
--planPlan URL or pln_ id to link (repeatable)
--discussionRecorded Discussion URL or cnv_ id to link (repeatable; only when the PR came directly out of it)
--allow-unconfirmedAccept links that may not be server-visible yet, without a warning (may 404). Covers the current session before upload and explicit --session, --plan, and --discussion refs.

ox verifies only the current session, from local recording state, and withholds its link until the server confirms it. ox includes ids you pass explicitly as given and prints a warning on stderr. Pass --allow-unconfirmed to silence the warning.

What's next

  • ox plan - Get the pln_ ids to pass to --plan
  • ox session - The sessions a PR header links back to
  • ox viz - Prepare a review visualization for the PR body