Skip to content

Latest commit

 

History

History
206 lines (172 loc) · 4.47 KB

README.md

File metadata and controls

206 lines (172 loc) · 4.47 KB

GH Detective

Cover

What is it?

It's a ShellScript CLI App that picks-up github's links, like events, trendings, or a User's repository.
The features are: Search, Explore, Trending, Trending Devs, Get User Info, Topics, Learn and Open Souce Guide.


How to use

Installation

$ git clone git+https://github.com/RickBarretto/GH-Detective.git
$ cd GH-Detective/
$ ./install.sh
Note: If you are using Git's Shell Terminal on Windows, the ghd command will be ghd.sh

🔎 Search

Standard:

$ ghd search [search]

It'll returns to you informations from the Github's Search page.

With Language parameter:

$ ghd search [search] <lang>
  • Lang can be whatever language that you want.

It'll returns to you informations from the Github's Search page filtred by language.

With Type parameter:

$ ghd search [search] <type>
  • Type can be:
    • --repos | -r;
    • --discussions | -d;
    • --users | -u;

It'll returns to you informations from the Github's Search page filtred by type.

With Sort parameter:

$ ghd search [search] <sort>
  • Sort can be:
    • --best | -b;
    • --star | -s;
    • --forks | -f;
    • --new | -n;

It'll returns to you informations from the Github's Search page sorted.

Examples:

$ ghd search unreal Csharp --best --r
$ ghd search unreal -b -r python
$ ghd search boot -star
$ ghd search rickb --user
$ ghd search rickb python -u 
$ ghd search design --discussions

✈️ Explore

Standard:

$ ghd

Alternative:

$ ghd explore

It'll returns to you informations from the Explore Github's page.

👋 Devs

Standard:

$ ghd devs

With Since parameter

$ ghd devs <--since>
  • Since can be:
    • --month | --monthly | -m;
    • --week | --weekly | -w;
    • --day | --daily | -d;

With Language parameter

$ ghd devs <lang>
  • Lang can be whatever language that you want.

Examples:

$ ghd devs python --m
$ ghd devs -w cpp

It'll returns to you informations from the Trending > Developers Github's page.

🙌 Get

Standard:

$ ghd get [username]

It'll returns to you informations from the Github > Developer's Profie.

With Repository parameter

$ ghd get [username] <--repo>
  • Repo can be:
    • --repo | -r

It'll returns to you informations from the Github > Developer's Repositories.

Examples:

$ ghd get rickbarretto
$ ghd get john-preston -r

📚 Topic

$ ghd topic [topic]

It'll returns to you informations from the Github > Topics > Topic.

With Sort parameter

$ ghd topic [topic] <--sort>
  • Sort can be:
    • --best | -b;
    • --star | -s;
    • --forks | -f;
    • --new | -n;

It'll returns to you informations from the Github > Topics > Topic sorted.

Examples:

$ ghd topic 3d
$ ghd topic bash --new

🏫 Learn

$ ghd learn

Returns all Learning content from Github > Collections > Learn To Code

📂 Open

After using a command that returns Github's links, you can use this command to automaticaly open, on standard browser, the last links showed.

$ ghd open [grep-array]
  • Grep-Array can be:
    • You must to write the link adress, or a section from this link. The program'll parse it and open.
    • You can search for multiples links, use space to separe it.

It'll returns to you the last informations showed on terminal.

Examples:

$ ghd topic bash --s
$ ghd open the-art pure-bash check

$ ghd get john-preston --repos
$ ghd open desktop macho meson

📦 Open Souce Guide (Automaticaly Opens on Browser)

OpenSource

$ ghd opensource

Opens Source Guidelines

Guide

$ ghd guide

Opens Source Guidelines