github-activity

command module
v0.0.0-...-1e4538d Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Dec 27, 2024 License: MIT Imports: 4 Imported by: 0

README

GitHub Activity Tracker

A command-line tool built in Golang to track your GitHub activities, such as commits, issues, pull requests, and more, for a given user.

Installation

Linux:
  1. Build the application:

    go build -o github-activity
    
  2. Move the executable to /usr/local/bin/ for system-wide access:

    sudo mv github-activity /usr/local/bin/
    
Windows:

For Windows, follow these steps to build and install your Go application:

  1. Build the application: Open a command prompt (or PowerShell) in the directory where your Go code is located and run the following command:

    go build -o github-activity.exe
    

    This will generate the github-activity.exe executable.

  2. Move the executable to a directory in your PATH: To make the application accessible system-wide, move it to a directory that's included in your PATH. You can use a directory like C:\Program Files or C:\Users\<your_username>\go\bin, or choose another location.

    Use the following command to move the github-activity.exe:

    move github-activity.exe C:\path\to\desired\directory\
    

    For example:

    move github-activity.exe C:\Users\<your_username>\go\bin\
    
  3. Ensure the directory is in your PATH: If the directory where you moved the executable is not already in your PATH, you can add it manually:

    • Right-click on This PC or Computer, and select Properties.
    • Click Advanced system settings on the left side.
    • In the System Properties window, click Environment Variables.
    • Under System variables, scroll down and select the Path variable, then click Edit.
    • Click New and add the path to the directory where github-activity.exe was moved (e.g., C:\Users\<your_username>\go\bin\).
    • Click OK to save the changes.

After following these steps, you should be able to run github-activity from any command prompt or PowerShell window.


Usage

Tracking GitHub Activity

To track a user's GitHub activity, use the following command:

github-activity <username>

Example:

github-activity bronerone

Output will show recent events, such as:

- Pushed 3 commits to bronerone/project
- Opened a new issue in bronerone/project
- Starred bronerone/project
- Forked bronerone/project

Contributing

Feel free to fork the repository, submit issues, or create pull requests. Contributions are welcome!


License

This project is licensed under the MIT License - see the LICENSE file for details.


Documentation

The Go Gopher

There is no documentation for this package.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL