chore: regen docs
Signed-off-by: jolheiser <john.olheiser@gmail.com>main v0.0.9
parent
50d40aacc1
commit
fd9f898315
112
DOCS.md
112
DOCS.md
|
@ -6,12 +6,14 @@ git-ea is the base command
|
||||||
git-ea
|
git-ea
|
||||||
├─ backport
|
├─ backport
|
||||||
├─ branch
|
├─ branch
|
||||||
|
├─ cd
|
||||||
├─ cleanup
|
├─ cleanup
|
||||||
├─ frontport
|
├─ frontport
|
||||||
├─ ide
|
├─ ide
|
||||||
├─ init
|
├─ init
|
||||||
├─ post
|
├─ post
|
||||||
└─ pr
|
├─ pr
|
||||||
|
└─ tag
|
||||||
```
|
```
|
||||||
|
|
||||||
|
|
||||||
|
@ -31,25 +33,6 @@ git-ea <cmd>
|
||||||
**--version,-v**: Print git-ea version
|
**--version,-v**: Print git-ea version
|
||||||
|
|
||||||
|
|
||||||
-----
|
|
||||||
|
|
||||||
## cleanup
|
|
||||||
|
|
||||||
cleanup removes named branches, or interactive if no arguments
|
|
||||||
|
|
||||||
|
|
||||||
```
|
|
||||||
[--help]
|
|
||||||
```
|
|
||||||
**Usage**:
|
|
||||||
|
|
||||||
```
|
|
||||||
cleanup [branches...]
|
|
||||||
```
|
|
||||||
|
|
||||||
**--help**: Show help
|
|
||||||
|
|
||||||
|
|
||||||
-----
|
-----
|
||||||
|
|
||||||
## backport
|
## backport
|
||||||
|
@ -61,6 +44,7 @@ backport cherry-picks a commit and applies it to a clean branch based on `releas
|
||||||
[--from,-f]=[value]
|
[--from,-f]=[value]
|
||||||
[--help]
|
[--help]
|
||||||
[--list,-l]
|
[--list,-l]
|
||||||
|
[--push,-p]
|
||||||
[--to,-t]=[value]
|
[--to,-t]=[value]
|
||||||
```
|
```
|
||||||
**Usage**:
|
**Usage**:
|
||||||
|
@ -78,6 +62,9 @@ backport --from [release=main] --to [release=latest]
|
||||||
**--list,-l**: Open repository to see needed backports
|
**--list,-l**: Open repository to see needed backports
|
||||||
|
|
||||||
|
|
||||||
|
**--push,-p**: Push immediately
|
||||||
|
|
||||||
|
|
||||||
**--to,-t**="": Release to backport to (ex: `17`, default: `latest`)
|
**--to,-t**="": Release to backport to (ex: `17`, default: `latest`)
|
||||||
|
|
||||||
|
|
||||||
|
@ -93,7 +80,7 @@ branch creates a new branch called `name` based on `base`
|
||||||
[--help]
|
[--help]
|
||||||
[--ide,-i]
|
[--ide,-i]
|
||||||
[--list,-l]
|
[--list,-l]
|
||||||
[--no-fetch,-nf]
|
[--no-fetch,-n]
|
||||||
```
|
```
|
||||||
**Usage**:
|
**Usage**:
|
||||||
|
|
||||||
|
@ -113,7 +100,57 @@ branch --base [ref=main] <name>
|
||||||
**--list,-l**: List branches available
|
**--list,-l**: List branches available
|
||||||
|
|
||||||
|
|
||||||
**--no-fetch,-nf**: Skip fetching
|
**--no-fetch,-n**: Skip fetching
|
||||||
|
|
||||||
|
|
||||||
|
-----
|
||||||
|
|
||||||
|
## cleanup
|
||||||
|
|
||||||
|
cleanup removes named branches, or interactive if no arguments
|
||||||
|
|
||||||
|
|
||||||
|
```
|
||||||
|
[--force,-f]
|
||||||
|
[--help]
|
||||||
|
[--prune,-p]
|
||||||
|
```
|
||||||
|
**Usage**:
|
||||||
|
|
||||||
|
```
|
||||||
|
cleanup [branches...]
|
||||||
|
```
|
||||||
|
|
||||||
|
**--force,-f**: Force cleanup
|
||||||
|
|
||||||
|
|
||||||
|
**--help**: Show help
|
||||||
|
|
||||||
|
|
||||||
|
**--prune,-p**: Prune worktrees
|
||||||
|
|
||||||
|
|
||||||
|
-----
|
||||||
|
|
||||||
|
## cd
|
||||||
|
|
||||||
|
Open a shell in the specified `workspace`
|
||||||
|
|
||||||
|
|
||||||
|
```
|
||||||
|
[--help]
|
||||||
|
[--print,-p]
|
||||||
|
```
|
||||||
|
**Usage**:
|
||||||
|
|
||||||
|
```
|
||||||
|
cd [workspace=base]
|
||||||
|
```
|
||||||
|
|
||||||
|
**--help**: Show help
|
||||||
|
|
||||||
|
|
||||||
|
**--print,-p**: Print workspace dir instead of spawning a shell
|
||||||
|
|
||||||
|
|
||||||
-----
|
-----
|
||||||
|
@ -126,6 +163,7 @@ frontport cherry-picks a commit and applies it to a clean branch based on `relea
|
||||||
```
|
```
|
||||||
[--from,-f]=[value]
|
[--from,-f]=[value]
|
||||||
[--help]
|
[--help]
|
||||||
|
[--push,-p]
|
||||||
[--to,-t]=[value]
|
[--to,-t]=[value]
|
||||||
```
|
```
|
||||||
**Usage**:
|
**Usage**:
|
||||||
|
@ -140,6 +178,9 @@ frontport --from [release=latest] --to [release=main]
|
||||||
**--help**: Show help
|
**--help**: Show help
|
||||||
|
|
||||||
|
|
||||||
|
**--push,-p**: Push immediately
|
||||||
|
|
||||||
|
|
||||||
**--to,-t**="": Release to frontport to (ex: `main`, default: `main`)
|
**--to,-t**="": Release to frontport to (ex: `main`, default: `main`)
|
||||||
|
|
||||||
|
|
||||||
|
@ -151,6 +192,7 @@ ide starts an IDE for `branch`
|
||||||
|
|
||||||
|
|
||||||
```
|
```
|
||||||
|
[--gui,-g]
|
||||||
[--help]
|
[--help]
|
||||||
```
|
```
|
||||||
**Usage**:
|
**Usage**:
|
||||||
|
@ -159,6 +201,9 @@ ide starts an IDE for `branch`
|
||||||
ide <branch>
|
ide <branch>
|
||||||
```
|
```
|
||||||
|
|
||||||
|
**--gui,-g**: Prefer GUI editor
|
||||||
|
|
||||||
|
|
||||||
**--help**: Show help
|
**--help**: Show help
|
||||||
|
|
||||||
|
|
||||||
|
@ -241,3 +286,26 @@ pr <index>
|
||||||
|
|
||||||
-----
|
-----
|
||||||
|
|
||||||
|
## tag
|
||||||
|
|
||||||
|
tag makes a signed tag for `branch`
|
||||||
|
|
||||||
|
|
||||||
|
```
|
||||||
|
[--help]
|
||||||
|
[--push,-p]
|
||||||
|
```
|
||||||
|
**Usage**:
|
||||||
|
|
||||||
|
```
|
||||||
|
tag <branch>
|
||||||
|
```
|
||||||
|
|
||||||
|
**--help**: Show help
|
||||||
|
|
||||||
|
|
||||||
|
**--push,-p**: Push immediately
|
||||||
|
|
||||||
|
|
||||||
|
-----
|
||||||
|
|
||||||
|
|
Loading…
Reference in New Issue