Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/asjordi/gh-user-activity-cli
CLI to fetch the recent activity of a GitHub user and display it in the terminal.
https://github.com/asjordi/gh-user-activity-cli
cli-app github-api java
Last synced: 8 days ago
JSON representation
CLI to fetch the recent activity of a GitHub user and display it in the terminal.
- Host: GitHub
- URL: https://github.com/asjordi/gh-user-activity-cli
- Owner: ASJordi
- License: mit
- Created: 2024-08-15T19:00:17.000Z (6 months ago)
- Default Branch: main
- Last Pushed: 2024-10-20T23:33:46.000Z (4 months ago)
- Last Synced: 2024-10-21T03:24:18.376Z (4 months ago)
- Topics: cli-app, github-api, java
- Language: Java
- Homepage:
- Size: 272 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
GitHub User Activity CLI
CLI app to fetch the recent activity of a GitHub user and display it in the terminal.
## About :computer:
Simple command line interface (CLI) to fetch the recent activity of a GitHub user and display it in the terminal. The app uses the GitHub API to fetch the user's activity and display it in the terminal.
## Features :sparkles:
- Fetch the recent activity of a GitHub user
- Display the activity in the terminal
```bash
# Fetch the recent activity of the specified GitHub user using the GitHub API.
# https://api.github.com/users//events
# Example: https://api.github.com/users/ASJordi/events
```
## Technologies :gear:
- Java 21
- [GSON](https://github.com/google/gson)
## Installation :floppy_disk:
1. Clone the repository
2. Open the project in your favorite IDE
3. Run the project
4. Or build the project with Maven and run the generated jar file
```bash
mvn clean install
```
## Usage :hammer_and_wrench:
```bash
Usage: java -jar github-activity.jar [options]
The options below are available for the GitHub User Activity:
GitHub username
-h, --help Show this help message and exit
```
### Examples :bulb:
```bash
java -jar github-activity.jar ASJordi
# Output:
# Event type (Description)
# Repository name
# Event[id, repoUrl, createdAt, action]
# ...
# Event type (Description)
# Repository name
# Event[id, repoUrl, createdAt, action]
# ...
```
## License :page_facing_up:
Distributed under the MIT License. See `LICENSE` for more information.
## Contact :email:
Jordi Ayala - [@ASJordi](https://twitter.com/ASJordi)
Project Link: [https://github.com/ASJordi/gh-user-activity-cli](https://github.com/ASJordi/gh-user-activity-cli)
Reference: [https://roadmap.sh/projects/github-user-activity](https://roadmap.sh/projects/github-user-activity)