Update docs
ci/woodpecker/push/goreleaser Pipeline was successful Details

Signed-off-by: jolheiser <john.olheiser@gmail.com>
main
jolheiser 2022-09-03 21:08:43 -05:00
parent b3d15829a2
commit c950b9e903
Signed by: jolheiser
GPG Key ID: B853ADA5DA7BBF7A
1 changed files with 77 additions and 1 deletions

78
DOCS.md
View File

@ -6,8 +6,11 @@ git-ea is the base command
git-ea git-ea
├─ backport ├─ backport
├─ branch ├─ branch
├─ cleanup
├─ frontport ├─ frontport
└─ init ├─ ide
├─ init
└─ pr
``` ```
@ -31,6 +34,25 @@ git-ea <cmd>
**--version**: Print git-ea version **--version**: Print git-ea version
-----
## cleanup
cleanup removes named branches, or interactive if no arguments
```
[--help]
```
**Usage**:
```
cleanup [branches...]
```
**--help**: Show help
----- -----
## backport ## backport
@ -85,6 +107,8 @@ branch creates a new branch called `name` based on `base`
[--b]=[value] [--b]=[value]
[--base]=[value] [--base]=[value]
[--help] [--help]
[--l]
[--list]
[--nf] [--nf]
[--no-fetch] [--no-fetch]
``` ```
@ -103,6 +127,12 @@ branch --base [ref=main] <name>
**--help**: Show help **--help**: Show help
**--l**: --list
**--list**: List branches available
**--nf**: --no-fetch **--nf**: --no-fetch
@ -144,6 +174,25 @@ frontport --from [release=latest] --to [release=main]
**--to**="": Release to frontport to (ex: `main`, default: `main`) **--to**="": Release to frontport to (ex: `main`, default: `main`)
-----
## ide
ide starts an IDE for `branch`
```
[--help]
```
**Usage**:
```
ide <branch>
```
**--help**: Show help
----- -----
## init ## init
@ -165,3 +214,30 @@ init
----- -----
## pr
pr pulls down a pull request for testing
```
[--help]
[--i]
[--ide]
```
**Usage**:
```
pr <index>
```
**--help**: Show help
**--i**: --ide
**--ide**: Start an IDE for this PR
-----