| 1 | <p align="center">
|
| 2 | <h1 align="center">Git Cheats - <i>Cheatsheet For Git Commands</i></h1>
|
| 3 | </p>
|
| 4 | <p align = "center">
|
| 5 | A companion app for <a href="http://gitcheats.com/">Git Cheats</a> where you can fetch git descriptions directly into your terminal
|
| 6 | </p>
|
| 7 | <p align="center">
|
| 8 | <img src="screenshot.gif">
|
| 9 | </p>
|
| 10 |
|
| 11 | <p align="center">
|
| 12 | <a href="https://travis-ci.org/excalith/git-cheats-cli">
|
| 13 | <img alt="Build Status" height="18" src="https://img.shields.io/travis/excalith/git-cheats-cli.svg">
|
| 14 | </a>
|
| 15 | <a href="https://www.npmjs.com/package/git-commands-cli">
|
| 16 | <img alt="NPM Installs" height="18" src="https://img.shields.io/npm/dt/git-commands-cli.svg?label=installs">
|
| 17 | </a>
|
| 18 | <a href="https://github.com/excalith/Git-Cheats-Cli/issues">
|
| 19 | <img alt="Build Status" height="18" src="https://img.shields.io/github/issues/excalith/Git-Cheats-Cli.svg">
|
| 20 | </a>
|
| 21 | <a href="https://github.com/excalith/Git-Cheats-Cli/stargazers">
|
| 22 | <img alt="Stars" height="18" src="https://img.shields.io/github/stars/excalith/Git-Cheats-Cli.svg">
|
| 23 | </a>
|
| 24 | <a href="https://github.com/excalith/Git-Cheats-Cli/network">
|
| 25 | <img alt="Forks" height="18" src="https://img.shields.io/github/forks/excalith/Git-Cheats-Cli.svg">
|
| 26 | </a>
|
| 27 | <a href="https://prettier.io/">
|
| 28 | <img alt="Prettier" height="18" src="https://img.shields.io/badge/code_style-prettier-ff69b4.svg">
|
| 29 | </a>
|
| 30 | </p>
|
| 31 |
|
| 32 | <hr/>
|
| 33 |
|
| 34 | **Git Cheats** is a small project for people who wants to get into git using commands but don't know where to start. It started as a side-project to help my friends / colleagues check commands easily, but it turned out it has been shared through my friends lots of times and it is being used on a daily basis. Suprising enough, I wanted to create a project for this. Maybe someone finds it useful and / or wants to contribute!
|
| 35 |
|
| 36 | You can either use web based [GitCheats App](http://gitcheats.com) from your browser or use this GitCheats CLI right from your terminal.
|
| 37 |
|
| 38 | ## How To Install:
|
| 39 |
|
| 40 | ### Using NPM
|
| 41 |
|
| 42 | `npm i -g git-commands-cli`
|
| 43 |
|
| 44 | ### Clone
|
| 45 |
|
| 46 | - Clone or Download this repository
|
| 47 | - Within the directory, from your favorite terminal
|
| 48 | - npm install
|
| 49 | - npm link (might ask for permission depending on your OS)
|
| 50 |
|
| 51 | ## Available Commands:
|
| 52 |
|
| 53 | | _Command_ | _Description_ |
|
| 54 | | -------------------------- | -------------------------------------------------------- |
|
| 55 | | gitcheats | Launch gitcheats.com directly |
|
| 56 | | gitcheats [command] | Print command descriptions right into your terminal |
|
| 57 | | gitcheats --open [command] | Open gitcheats.com in browser with your command filtered |
|
| 58 | | gitcheats --language [key] | Set your preffered language (Default: en) |
|
| 59 | | gitcheats --version | Shows and checks version |
|
| 60 | | gitcheats --help | Show commands for the app |
|
| 61 |
|
| 62 | ## How To Contribute:
|
| 63 |
|
| 64 | - If you want to add more commands into GitCheats, please contribute to original [GitCheats Repository](https://github.com/excalith/Git-Cheats).
|
| 65 | - If you want to further improve CLI app, please send a pull request to this repository.
|
| 66 |
|
| 67 | ## License
|
| 68 |
|
| 69 | This project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details.
|