https://github.com/manifold-systems/github-traffic
GitHub traffic CLI utility with bonus features
https://github.com/manifold-systems/github-traffic
cli github-traffic java
Last synced: 24 days ago
JSON representation
GitHub traffic CLI utility with bonus features
- Host: GitHub
- URL: https://github.com/manifold-systems/github-traffic
- Owner: manifold-systems
- License: mit
- Created: 2024-07-31T03:56:59.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-02-21T18:05:22.000Z (about 1 year ago)
- Last Synced: 2025-04-10T16:12:20.948Z (12 months ago)
- Topics: cli, github-traffic, java
- Language: Java
- Homepage:
- Size: 647 KB
- Stars: 11
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
- License: LICENSE
Awesome Lists containing this project
README
# GitHub traffic CLI
Use this command line interface (CLI) tool to produce a textual GitHub traffic report for any repository. The report is
similar in format to GitHub's Traffic page, but includes additional features such as star diffs between usages, who
starred/unstarred the repo, and unique view ratio per top views. See the example below.
# Development
This is a Java language project. While you can use the development tools of your choice, this project uses [manifold](https://github.com/manifold-systems/manifold),
therefore it is best to develop this project in IntelliJ IDEA with the [manifold plugin](https://plugins.jetbrains.com/plugin/10057-manifold/edit) enabled.
# Build
### Requirements
- [Maven](https://maven.apache.org/)
- JDK 8 or later
### Command line
From the project root directory:
```
mvn package
```
This will produce an executable JAR file in the ./target directory.
# Usage
### Requirements
- Java 8 or later
> Ensure a JVM 8 or greater is on your execution path.
Use the included shell script to run the GitHub traffic CLI tool.
- `traffic` for Unix/Mac
- `traffic.bat` for Windows
Example:
```
traffic -user joeuser -repo joeswidget -token xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
```
#### Required parameters:
`-user`: Github user/org name
`-repo`: Github repository name
`-token`: Github [authentication token](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens)
#### Optional parameters:
`-days`: Number of days to display. Values may range from 1..14. Default is 14.
# Sample report
