Compare commits
3 Commits
f8dd4b9f95
...
160928e228
Author | SHA1 | Date | |
---|---|---|---|
160928e228 | |||
bd07ee8022 | |||
1bc5ae70d9 |
35
README.md
35
README.md
@ -1,3 +1,38 @@
|
|||||||
# ghup
|
# ghup
|
||||||
|
|
||||||
Simple Github helper for myself.
|
Simple Github helper for myself.
|
||||||
|
|
||||||
|
## Installation
|
||||||
|
|
||||||
|
If you don't have haskell GHC and cabal installed,
|
||||||
|
follow [ghcup](https://www.haskell.org/ghcup/) first.
|
||||||
|
|
||||||
|
Then issue:
|
||||||
|
|
||||||
|
```sh
|
||||||
|
$ cabal v2-install ghup
|
||||||
|
```
|
||||||
|
|
||||||
|
## Usage
|
||||||
|
|
||||||
|
First you need to set the github OAuth (no other method currently supported)
|
||||||
|
for API access:
|
||||||
|
|
||||||
|
```
|
||||||
|
ghup config --oauth "<your-github-token>"
|
||||||
|
```
|
||||||
|
|
||||||
|
Then follow the help page:
|
||||||
|
|
||||||
|
```
|
||||||
|
Usage: ghup COMMAND
|
||||||
|
|
||||||
|
Available options:
|
||||||
|
-h,--help Show this help text
|
||||||
|
|
||||||
|
Available commands:
|
||||||
|
fork Fork a repository
|
||||||
|
config Set ghup config (such as OAuth)
|
||||||
|
delete Delete a forked repository
|
||||||
|
list-forks List my forks
|
||||||
|
```
|
||||||
|
@ -63,10 +63,10 @@ data DelOptions = DelOptions {
|
|||||||
|
|
||||||
opts :: Parser Command
|
opts :: Parser Command
|
||||||
opts = subparser
|
opts = subparser
|
||||||
( command "fork" (Fork <$> (info (forkOpts <**> helper) idm))
|
( command "fork" (Fork <$> (info (forkOpts <**> helper) (progDesc "Fork a repository")))
|
||||||
<> command "config" (Config <$> (info (configOpts <**> helper) idm))
|
<> command "config" (Config <$> (info (configOpts <**> helper) (progDesc "Set ghup config (such as OAuth)")))
|
||||||
<> command "delete" (Del <$> (info (delOpts <**> helper) idm))
|
<> command "delete" (Del <$> (info (delOpts <**> helper) (progDesc "Delete a forked repository")))
|
||||||
<> command "list-forks" (ListForks <$> (info (lForkOpts <**> helper) idm))
|
<> command "list-forks" (ListForks <$> (info (lForkOpts <**> helper) (progDesc "List my forks")))
|
||||||
)
|
)
|
||||||
|
|
||||||
configOpts :: Parser ConfigOptions
|
configOpts :: Parser ConfigOptions
|
||||||
|
@ -106,7 +106,7 @@ constraints: any.Cabal ==3.0.0.0,
|
|||||||
any.monad-control ==1.0.2.3,
|
any.monad-control ==1.0.2.3,
|
||||||
any.mtl ==2.2.2,
|
any.mtl ==2.2.2,
|
||||||
any.network ==3.1.1.1,
|
any.network ==3.1.1.1,
|
||||||
any.network-uri ==2.6.1.0,
|
any.network-uri ==2.6.2.0,
|
||||||
any.optparse-applicative ==0.15.1.0,
|
any.optparse-applicative ==0.15.1.0,
|
||||||
any.parsec ==3.1.13.0,
|
any.parsec ==3.1.13.0,
|
||||||
any.pem ==0.2.4,
|
any.pem ==0.2.4,
|
||||||
|
Loading…
Reference in New Issue
Block a user