Skip to content

Commit fc03b38

Browse files
Add docs for command line options. (#59)
Co-authored-by: Shay Nehmad <[email protected]>
1 parent 2d93a26 commit fc03b38

File tree

1 file changed

+44
-1
lines changed

1 file changed

+44
-1
lines changed

README.md

Lines changed: 44 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -239,9 +239,52 @@ stack-pr land -B HEAD~5 -H HEAD~2
239239
```
240240
241241
## Command Line Options Reference
242-
The section is not added yet, contributions are welcome!
242+
243+
### Common Arguments
244+
245+
These arguments can be used with any subcommand:
246+
247+
- `-R, --remote`: Remote name (default: "origin")
248+
- `-B, --base`: Local base branch
249+
- `-H, --head`: Local head branch (default: "HEAD")
250+
- `-T, --target`: Remote target branch (default: "main")
251+
- `--hyperlinks/--no-hyperlinks`: Enable/disable hyperlink support (default: enabled)
252+
- `-V, --verbose`: Enable verbose output from Git subcommands (default: false)
253+
- `--branch-name-template`: Template for generated branch names (default: "$USERNAME/stack")
254+
255+
### Subcommands
256+
257+
#### submit (alias: export)
258+
259+
Submit a stack of PRs
260+
261+
Options:
262+
263+
- `--keep-body`: Keep current PR body, only update cross-links (default: false)
264+
- `-d, --draft`: Submit PRs in draft mode (default: false)
265+
- `--draft-bitmask`: Bitmask for setting draft status per PR
266+
- `--reviewer`: List of reviewers for the PRs (default: from $STACK_PR_DEFAULT_REVIEWER or config)
267+
268+
#### land
269+
270+
Land the current stack
271+
272+
Takes no additional arguments beyond common ones.
273+
274+
#### abandon
275+
276+
Abandon the current stack
277+
278+
Takes no additional arguments beyond common ones.
279+
280+
#### view
281+
282+
Inspect the current stack
283+
284+
Takes no additional arguments beyond common ones.
243285
244286
### Config files
287+
245288
Default values for command line options can be specified via a config file.
246289
Path to the config file can be specified via `STACKPR_CONFIG` envvar, and by
247290
default it's assumed to be `.stack-pr.cfg` in the current folder.

0 commit comments

Comments
 (0)