GitWatch CLI is a simple command-line tool that allows you to fetch and display the recent activity of any GitHub user directly in your terminal.
- Fetch recent GitHub activity for any user
- Display activity in a human-readable format
- Handle various GitHub event types (Push, Issue, Watch, Create, Fork)
- Easy to use with a single command
To install GitWatch CLI globally on your system, follow these steps:
-
Clone this repository:
git clone https://github.com/yourusername/gitwatch-cli.git
-
Navigate to the project directory:
cd gitwatch-cli
-
Install the package globally:
npm install -g .
After installation, you can use GitWatch CLI with the following command:
gitwatch <username>
Replace <username>
with the GitHub username you want to check.
Example:
gitwatch octocat
This will display the recent GitHub activity for the user "octocat".
The tool will display recent activities in the following format:
- Pushed 3 commit(s) to octocat/Hello-World
- Opened an issue in octocat/Spoon-Knife
- Starred octocat/git-consortium
- Created branch main in octocat/Hello-World
- Forked octocat/linguist
If there's an error fetching the GitHub activity (e.g., invalid username, API failure), the tool will display an error message and exit with a non-zero status code.
- Node.js
- Yargs
Contributions are welcome! Please feel free to submit a Pull Request.
This project is licensed under the ISC License.
Kartik Labhshetwar
Happy GitWatching!