https://github.com/nirajpandkar/git-tip
CLI that gives a random git-tip.
https://github.com/nirajpandkar/git-tip
Last synced: 3 months ago
JSON representation
CLI that gives a random git-tip.
- Host: GitHub
- URL: https://github.com/nirajpandkar/git-tip
- Owner: nirajpandkar
- License: mit
- Created: 2016-08-01T06:42:02.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2018-02-13T03:36:35.000Z (about 7 years ago)
- Last Synced: 2024-11-24T16:36:46.332Z (3 months ago)
- Language: JavaScript
- Homepage:
- Size: 145 KB
- Stars: 56
- Watchers: 5
- Forks: 8
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- jimsghstars - nirajpandkar/git-tip - CLI that gives a random git-tip. (JavaScript)
README
# git-tip [](https://travis-ci.org/nirajpandkar/git-tip)
> CLI that gives a random git-tip.
The git-tips [JSON file](https://github.com/git-tips/tips/blob/master/tips.json) is taken from this awesome project - [git-tips](https://github.com/git-tips/tips)
Any suggestion/criticism/PRs are welcome :)
## `wget` dependency for Windows and Mac Users
### Mac
```
$ brew install wget
```
### Windows
[Download and install wget](http://gnuwin32.sourceforge.net/packages/wget.htm)
## Install
```
$ npm install --global git-tip
```
### Script to greet yourself with a git-tip every time a new terminal opens
```
which git-tip >> ~/.bashrc
```
## Usage
```
Usage
$ git-tip [options]
Options
--help Provides usage help (Shows the current page)
--all Gives all the git tips
Gives the git tips consisting of the keyword
Examples
$ git-tip bypass
1. Bypass pre-commit and commit-msg githooks
=> git commit --no-verify
$ git-tip
Git Tip of the Terminal
-------------------------
Saving current state of tracked files without commiting
=> git stash
```
## Todo
- [x] Basic Functionality
- [x] Help page
- [x] Add continuous integration(Travis CI)
- [x] Add tests
- [ ] Add more relevant tests to increase code coverage
- [x] Code coverage
- [ ] Add code coverage reports
- [x] Script to automatically update tips.json file when installing globally from npm
- [x] Script to execute `git-tip` every time a new terminal opens
- [x] Add `wget`'s necessity before installation in the README.
## License
MIT © [Niraj Pandkar](https://github.com/nirajpandkar)