git-pulse
v0.5.0
Published
CLI tool to display concise information from github repos you follow
Downloads
11
Maintainers
Readme
About The Project
Git Pulse is a node.js CLI tool which makes it quick and easy to keep up to date with your favourite repositories and issues.
The Need
Countless hours have been wasted manually tracking repository releases / version and issue states. Git Pulse now makes it easier to track the repositories and issues you are interested in by running a simple command:
gpulse check
Built With
Getting Started
To get up and running with Git Pulse, follow these simple steps.
Prerequisites
- npm
- GitHub account with a valid authentication token. Ensure you select the repo scope at a minium.
Installation
- Install package from npm globally
npm i -g git-pulse
Set up your GitHub authentication token. Go to this link to set up a token for your account.
Set up your initial configuration by running
gpulse config
, and follow the interactive wizard.
Usage
The CLI is invoked using the
gpulse
command rather thangit-pulse
Run the initialise config wizard
gpulse init
View existing configs
gpulse config ls [<-r -i>]
Update token in config file
gpulse config token
Add / remove repository in config file
gpulse config rm -r <id>
gpulse config add -r <link/to/repo>
Add / remove issue in config file
gpulse config rm -i <id>
gpulse config add -i <link/to/repo>
Check latest repository information
gpulse check -r
Check latest issues information
gpulse check -i
Check latest repository and issues information
gpulse check
or gpulse check -a
Contributing
Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.
Please read the Contribution Guidelines before you start making your awesome contributions!
Roadmap
See the open issues for a list of proposed features (and known issues).
License
Distributed under the MIT License. See LICENSE
for more information.
Contact
Josh Wheeler: [email protected]
Project Link: https://github.com/jltwheeler/git-pulse