ngit pr
work with pull requests
Parent command: ngit
Related guide: Pull requests
Upcoming command surface
This page is generated from an unreleased ngit commit. Its interface may change before the next release.
Usage
text
Usage: ngit pr [OPTIONS] <COMMAND>Subcommands
| Command | Description |
|---|---|
ngit pr list | list PRs and view details |
ngit pr view | view a PR; use --comments to include comment thread |
ngit pr checkout | checkout a proposal branch by event-id or nevent |
ngit pr apply | apply proposal patches to current branch |
ngit pr send | submit PR with advanced options (alias for ngit send) |
ngit pr close | close a PR (author or maintainer only) |
ngit pr reopen | reopen a closed PR (author or maintainer only) |
ngit pr ready | mark a draft PR as ready for review (author or maintainer only) |
ngit pr draft | convert a PR back to draft (author or maintainer only) |
ngit pr comment | add a comment to a PR |
ngit pr merge | merge a PR into the current branch (maintainer only) |
ngit pr label | add one or more labels to a PR (author or maintainer only) |
ngit pr set-subject | set the subject/title of a PR (author or maintainer only) |
ngit pr set-cover-note | set or update the cover note for a PR (author or maintainer only) |
Arguments and options
| Input | Description | Details |
|---|---|---|
-n, --nsec <NSEC> | nsec or hex private key | global; conflicts with --nbunksec <NBUNKSEC>, --nbunksec-file <PATH>, --nsec-file <PATH>, --signer <NPUB|ALIAS|NAME> |
--nsec-file <PATH> | read an nsec or hex private key from a path resolving to a regular file | global; conflicts with --nbunksec <NBUNKSEC>, --nbunksec-file <PATH>, -n, --nsec <NSEC>, --signer <NPUB|ALIAS|NAME> |
--nbunksec <NBUNKSEC> | established remote signer connection encoded as nbunksec | global; conflicts with --nbunksec-file <PATH>, -n, --nsec <NSEC>, --nsec-file <PATH>, --signer <NPUB|ALIAS|NAME> |
--nbunksec-file <PATH> | read an nbunksec connection from a path resolving to a regular file | global; conflicts with --nbunksec <NBUNKSEC>, -n, --nsec <NSEC>, --nsec-file <PATH>, --signer <NPUB|ALIAS|NAME> |
--signer <NPUB|ALIAS|NAME> | use a configured signer by npub, alias, or cached profile name for this command | global; conflicts with --nbunksec <NBUNKSEC>, --nbunksec-file <PATH>, -n, --nsec <NSEC>, --nsec-file <PATH> |
-c, --customize | show customization options via git config | global |
-d, --defaults | Use default values without prompting (non-interactive mode) | global; conflicts with -i, --interactive |
-i, --interactive | Enable interactive prompts (default behavior) | global; conflicts with -d, --defaults, --json |
-f, --force | Force operations, bypass safety guards | global |
-v, --verbose | Enable verbose output | global |
--repo-relay-only | Only publish nostr events to repository relays, not user or default relays | global |
--repo <REMOTE|NADDR|NOSTR-URL> | Target repository for repo-scoped operations. Accepts a configured nostr:// remote name, an naddr, or a nostr:// URL. Overrides nostr.repo, tracked-upstream, and remote-based auto-detection. Available at any command position: ngit --repo upstream send ngit issue --repo upstream create ngit issue create --repo upstream | global |
--json | Output one machine-readable JSON document on stdout | global; conflicts with -i, --interactive |
-h, --help | Print help (see a summary with '-h') | — |
-V, --version | Print version | — |
Details
work with pull requests
PRs are created by pushing a branch with the pr/ prefix: git push -u origin pr/my-branch or with advanced options via ngit send