Skip to content

Latest commit

 

History

History
45 lines (30 loc) · 1.31 KB

README.md

File metadata and controls

45 lines (30 loc) · 1.31 KB

gh-dxp

A GitHub (gh) CLI extension for automating daily development work, brought to you by Elhub's DevXP team. It implements an opinionated workflow based around small and frequent commits, squash merge, and mandatory linting and unit testing. To view more detailed documentation, please refer to the gh-dxp page in docs-support.

User Guide

Using the -h flag with any command will display relevant documentation. In addition to that, a user guide for gh dxp can be found here

Aliases

To avoid having to type gh dxp constantly, we recommend running:

gh alias import alias.yml

On the alias.yml file that follows this project. This installs a number of useful aliases for the commands in this extension.

Installation

  1. Install the gh CLI
  2. Install gh-dxp: 
    gh extension install elhub/gh-dxp
Install from source

If you want to install this extension from source, such as for development, follow these two steps:

  1. Clone the repo

    # git
git clone https://github.com/elhub/gh-dxp

  2. Build and install locally

    cd gh-dxp; make clean install