oflifurkan / git-lucky

Discover random GitHub repositories directly from your terminal. Dive into new codebases, explore diverse projects, and get inspired with git-lucky!

git-lucky 🍀

Discover a random GitHub repository from popular programming languages with just one command. Dive into diverse projects, explore new territories, and get inspired.

Features

• Randomly selects from popular programming languages or allows you to specify a language of your choice.
• Provides a simple command-line interface.
• Option to select a specific programming language using the -lang flag.
• View the help text and options using the -h flag.
• Fetches repositories sorted by the latest commit.
• Configurable via a JSON configuration file.

Getting Started

Download Precompiled Binaries

For those who prefer not to compile the software, precompiled binaries are available:

• Windows
• macOS
• Linux

Build from Source

Prerequisites

• Go

Steps

1. Clone this repository:

   git clone https://github.com/omerbustun/git-lucky.git

2. Navigate to the cloned directory:

   cd git-lucky

3. Build the project:

   go build

Configuration

1. Copy the sample configuration file:

   cp config.sample.json config.json

2. Add your GitHub API token (optional but recommended to increase rate limits):

   {
     "api_token": "YOUR_GITHUB_API_TOKEN"
   }

Usage

Simply run:

./git-lucky

To specify a programming language:

./git-lucky -lang=Python

For help:

./git-lucky -h

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

License

This project is licensed under the GNU General Public License, version 3 (GPLv3). See the LICENSE file for the full license text.