1.0.0 • Published 11 months ago

geekink-cli v1.0.0

Weekly downloads
-
License
ISC
Repository
-
Last release
11 months ago

Geekink CLI

The Geekink CLI is a command-line tool that retrieves and displays issue information from GitHub repositories. It provides a convenient way to fetch details such as issue number, title, URL, and state for easy access and reference.

Installation

To use the Geekink CLI, make sure you have Node.js installed on your system. Then, follow these steps:

  • Clone this repository or download the source code.
  • Open a terminal and navigate to the project directory.
  • Run the following command to install the dependencies:
npm install
npm install -g  

npm install -g in the directory folder to make geekink global commend

The Geekink CLI requires a GitHub username and repository name as command-line arguments. Here's the

basic usage:

geekink -u <username> -r <repository>

Replace with your GitHub username and with the name of the repository you want to fetch issues from.

Examples

Here are a few examples of how to use the Geekink CLI:

Retrieve issues from the "AdamsGeeky/Adams" repository

geekink -u AdamsGeeky -r Adams

Retrieve issues from the "openai/openai-python" repository

geekink -u openai -r openai-python

After executing the Geekink CLI, it will display information about the issues in the specified repository. The output includes the issue number, title, URL, and state of each issue. The console output is color-coded to enhance readability.

Contributing

Contributions are welcome! If you find any issues or have suggestions for improvements, please open an issue or submit a pull request. Make sure to follow the existing coding style and add appropriate tests for new functionality.

License

This project is licensed under the MIT License.

Acknowledgments

The Geekink CLI was built with the help of the following resources and dependencies:

  • Node.js
  • node-fetch
  • GitHub API
  • ANSI escape codes

  • Developer community and online tutorials

Thank you for your interest in the Geekink CLI! If you have any questions or feedback, please don't hesitate to reach out. Happy geeking!

1.0.0

11 months ago