stig

Stig

Ein CLI-Tool zum Durchsuchen von GitHub vom Terminal aus.

Um

Stig ist ein CLI-Tool zum Durchsuchen von GitHub vom Terminal aus. Mit der Möglichkeit, Ergebnisse zu sortieren und zu filtern, macht Stig es Ihnen leicht, das Gesuchte zu finden. Stig kann auch ein Repository README.md auf stdout ausdrucken, sodass Sie schnell mehr über ein Projekt erfahren können.

Merkmale

• Durchsuchen Sie GitHub vom Terminal aus
• Verwenden Sie Flags und Optionen, um die Ergebnisse zu filtern
• Drucken Sie die Readme-Datei eines bestimmten Repositorys auf stdout

Ergebnisaufschlüsselung

Ein typisches Suchergebniselement sieht wie folgt aus:

 - owner
|          - repo
|          |    - stars
|          |    |   - forks
|          |    |   |  - issues
|          |    |   |  |  - language
|          |    |   |  |  |     - last updated
|          |    |   |  |  |     |  - summary
|          |    |   |  |  |     |  |
octobanana/stig *12 <3 !4 [C++] 5h
  A CLI tool for searching GitHub from the terminal.

Ein geforktes Repository zeigt ein > -Symbol anstelle des standardmäßigen < -Symbols.

Die zuletzt aktualisierten Symbole sind wie folgt zugeordnet:

 s : seconds
m : minutes
h : hours
D : days
W : weeks
M : months
Y : years

Am Ende der Ergebnisse wird eine Zusammenfassung angezeigt:

Zusammenfassende Aufschlüsselung

 - current results
|   - total results
|   |            - current page
|   |            | - total pages
|   |            | |          - requests remaining
|   |            | |          | - requests limit
|   |            | |          | |
1-5/81 results | 1/17 pages | 9/10 limit

Terminalkompatibilität

Wenn die Farbausgabe aktiviert ist, ist ein Terminalemulator erforderlich, der Ansi-Escape-Codes und True Color unterstützt. Die meisten gängigen Terminalemulatoren sollten beides unterstützen. Während die Aktivierung der farbigen Ausgabe das beste Erlebnis bietet, kann sie mit der Option --color angepasst werden, wobei entweder on , off oder auto als Eingaben verwendet werden, wobei auto der Standardwert ist.

GitHub-Token

Standardmäßig erlaubt die GitHub-API bis zu 10 Suchanfragen pro Minute. Um das Limit auf 30 Suchanfragen pro Minute zu erweitern, können Sie ein GitHub-Token mit der Option --token übergeben.

Weitere Informationen zum Erstellen eines neuen persönlichen Zugriffstokens finden Sie im folgenden GitHub-Hilfeartikel.

GitHub Enterprise-Kompatibilität

Mit der Option --host ist es möglich, einen benutzerdefinierten API-Endpunkt für die Kompatibilität mit GitHub Enterprise-Installationen zu verwenden. Der Host sollte als subdomain.domain.tld formatiert sein. Es wird erwartet, dass der Endpunkt über HTTPS an Port 443 bedient wird.

Wichtig

Wenn Sie die Option --host verwenden, verwenden Sie die Option --token nur mit einem vertrauenswürdigen benutzerdefinierten API-Endpunkt. Wenn zusammen mit einem Token ein falscher Host übergeben wird, wäre es ratsam, das Token sofort zu widerrufen und ein neues zu erstellen.

Beispiele

 # query 'stig' showing '20' results from page '1'
$ stig --query ' stig ' --number 20 --page 1

# query 'stig' with filter 'language:cpp'
$ stig --query ' stig ' --filter ' language:cpp '

# query 'stig' and pipe into less
$ stig --query ' stig ' | less

# query 'all' sorted by 'stars' with filter 'language:js'
$ stig --query ' ' --sort ' stars ' --filter ' language:js '

# query 'http server' with filters 'language:cpp' and 'stars:>10'
$ stig --query ' http server ' --filter ' language:cpp stars:>10 '

# output the README.md for 'octobanana/stig' on default branch
$ stig --readme ' octobanana/stig '

# output the README.md for 'octobanana/stig' on branch 'master'
$ stig --readme ' octobanana/stig/master '

# output the README.md for 'octobanana/stig' on default branch and pipe into less
$ stig --readme ' octobanana/stig ' | less

# output the program help
$ stig --help

# output the program version
$ stig --version

Bauen

Umfeld

• Linux (unterstützt)
• BSD (ungetestet)
• macOS (ungetestet)

Anforderungen

• C++17-Compiler
• Boost >= 1,67
• OpenSSL >= 1.1.0
• CMake >= 3.8

Abhängigkeiten

• SSL (libssl)
• Krypto (libcrypto)
• pthread (libpthread)
• Boost (libboost_system)

Bibliotheken:

• Meine Belle-Bibliothek zum Senden von HTTPS-Anfragen, enthalten als ./src/ob/belle.hh
• meine Parg-Bibliothek zum Parsen von CLI-Argumenten, enthalten als ./src/ob/parg.hh
• nlohmanns JSON-Bibliothek für die Arbeit mit JSON, enthalten als ./src/lib/json.hh

Der folgende Shell-Befehl erstellt das Projekt im Release-Modus:

./build.sh

Um im Debug-Modus zu erstellen, führen Sie das Skript mit dem Flag --debug aus.

Installieren

Der folgende Shell-Befehl installiert das Projekt im Release-Modus:

./install.sh

Um im Debug-Modus zu installieren, führen Sie das Skript mit dem Flag --debug aus.

Lizenz

Dieses Projekt ist unter der MIT-Lizenz lizenziert.

Copyright (c) 2018-2019 Brett Robinson

Hiermit wird jeder Person, die eine Kopie dieser Software und der zugehörigen Dokumentationsdateien (die „Software“) erhält, kostenlos die Erlaubnis erteilt, mit der Software ohne Einschränkung zu handeln, einschließlich und ohne Einschränkung der Rechte zur Nutzung, zum Kopieren, Ändern und Zusammenführen , Kopien der Software zu veröffentlichen, zu verteilen, unterzulizenzieren und/oder zu verkaufen und Personen, denen die Software zur Verfügung gestellt wird, dies zu gestatten, vorbehaltlich der folgenden Bedingungen:

Der obige Urheberrechtshinweis und dieser Genehmigungshinweis müssen in allen Kopien oder wesentlichen Teilen der Software enthalten sein.

DIE SOFTWARE WIRD „WIE BESEHEN“ ZUR VERFÜGUNG GESTELLT, OHNE JEGLICHE AUSDRÜCKLICHE ODER STILLSCHWEIGENDE GEWÄHRLEISTUNG, EINSCHLIESSLICH, ABER NICHT BESCHRÄNKT AUF DIE GEWÄHRLEISTUNG DER MARKTGÄNGIGKEIT, EIGNUNG FÜR EINEN BESTIMMTEN ZWECK UND NICHTVERLETZUNG. IN KEINEM FALL SIND DIE AUTOREN ODER COPYRIGHT-INHABER HAFTBAR FÜR JEGLICHE ANSPRÜCHE, SCHÄDEN ODER ANDERE HAFTUNG, WEDER AUS EINER VERTRAGLICHEN HANDLUNG, AUS unerlaubter Handlung ODER ANDERWEITIG, DIE SICH AUS, AUS ODER IN ZUSAMMENHANG MIT DER SOFTWARE ODER DER NUTZUNG ODER ANDEREN HANDELN IN DER SOFTWARE ERGEBEN SOFTWARE.