Skip to content

Latest commit

 

History

History
99 lines (69 loc) · 2.68 KB

README.md

File metadata and controls

99 lines (69 loc) · 2.68 KB
Raw

work-cli

Awesome command line tools for managing the lifecycle of Github pull requests.

  • Branch and open a beautiful draft PR by typing work begin from main/master
  • Fast switch between your open PRs with work pr switch
  • Open or focus your PR in the browser with work pr show
  • Ask for a review on Github with work review alice

Currently only works on macOS, but could be tweaked for Linux/Windows!

Creating a PR Result

image

image

 
$ work -h

Remove every day developer toil around Github, branches, and reviews.

USAGE
  work <command> <subcommand> [flags]

CORE COMMANDS
  begin:   Create a new pull request off origin/main
  pr:      Switch between and view your pull requests
  review:  Quickly request a review and edit your PR description in one shot

ONBOARDING COMMANDS
  setup:   One-time setup to install required dependencies

FLAGS
  -h    Show help for any command

EXAMPLES
  $ work begin              # create a new branch and open a draft PR
  $ work review cindy       # request a review from @cindy on Github
  $ work pr switch          # quick switch to another PR's branch
  $ work pr show            # quick open your PR in Chrome

LEARN MORE
  Use 'work <command> <subcommand> -h' for more information about a command.

Installation

⏰ I'm busy, can I paste in 1 line of shell code?

bash <(curl -s https://raw.githubusercontent.com/dbalatero/work-cli/main/bin/install)

🤓 I'm paranoid about running code directly from curl:

git clone https://github.com/dbalatero/work-cli.git ~/.work-cli

cd ~/.work-cli
bin/install       # don't forget to audit the script, you nerd

Additional setup/dependencies

  • work will always automatically install any dependencies it needs for you.
  • Occasionally you'll need to generate an API key (Github) - work will magically prompt you when it's time to do so.

My philosophy is that READMEs are bad, only 20% of people read them, and it's better if software just does everything for you, at the exact moment you need it.

FAQ

I forget how to quit Vim, can I use VSCode to edit my PR descriptions?

Sure, why not. Just add this to your bashrc/zshrc/whatever file and reload your shell:

export EDITOR="code --wait"