stig

Stig

Alat CLI untuk mencari GitHub dari terminal.

Tentang

Stig adalah alat CLI untuk mencari GitHub dari terminal. Dengan kemampuan mengurutkan dan memfilter hasil, Stig memudahkan Anda menemukan apa yang Anda cari. Stig juga dapat mencetak repositori README.md ke stdout, sehingga Anda dapat dengan cepat mempelajari lebih lanjut tentang suatu proyek.

Fitur

• cari GitHub dari terminal
• gunakan tanda dan opsi untuk memfilter hasilnya
• cetak readme dari repo yang ditentukan ke stdout

Perincian Hasil

Item hasil pencarian tipikal akan terlihat seperti berikut:

 - 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.

Repositori bercabang akan menampilkan simbol > , bukan simbol < default.

Simbol yang terakhir diperbarui dipetakan sebagai berikut:

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

Di akhir hasil, ringkasan akan ditampilkan:

Rincian Ringkasan

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

Kompatibilitas Terminal

Emulator terminal yang mendukung kode escape ansi dan warna asli diperlukan saat keluaran berwarna diaktifkan. Mayoritas emulator terminal populer seharusnya mendukung keduanya. Meskipun mengaktifkan keluaran berwarna memberikan pengalaman terbaik, hal ini dapat disesuaikan menggunakan opsi --color , dengan menggunakan masukan on , off , atau auto , dengan auto sebagai nilai default.

Token GitHub

Secara default, GitHub API mengizinkan hingga 10 kueri penelusuran per menit. Untuk memperluas batas hingga 30 kueri penelusuran per menit, Anda dapat meneruskan token GitHub dengan opsi --token .

Untuk informasi selengkapnya mengenai pembuatan token akses pribadi baru, lihat artikel bantuan GitHub berikut.

Kompatibilitas Perusahaan GitHub

Dimungkinkan untuk menggunakan titik akhir API khusus untuk kompatibilitas dengan instalasi GitHub Enterprise menggunakan opsi --host . Host harus diformat sebagai, subdomain.domain.tld . Titik akhir diharapkan dilayani melalui HTTPS pada port 443 .

Penting

Saat menggunakan opsi --host , hanya gunakan opsi --token dengan titik akhir API kustom tepercaya. Jika host yang salah diteruskan bersama dengan token, sebaiknya segera mencabut token tersebut dan membuat yang baru.

Contoh

 # 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

Membangun

Lingkungan

• Linux (didukung)
• BSD (belum teruji)
• macOS (belum teruji)

Persyaratan

• Kompiler C++17
• Peningkatan >= 1,67
• OpenSSL >= 1.1.0
• Pembuatan C >= 3.8

Ketergantungan

• ssl (libssl)
• kripto (libcrypto)
• benang p (libpthread)
• peningkatan (libboost_system)

Perpustakaan:

• perpustakaan primadona saya, untuk membuat permintaan HTTPS, disertakan sebagai ./src/ob/belle.hh
• perpustakaan parg saya, untuk parsing argumen CLI, disertakan sebagai ./src/ob/parg.hh
• Pustaka json nlohmann, untuk bekerja dengan JSON, disertakan sebagai ./src/lib/json.hh

Perintah shell berikut akan membangun proyek dalam mode rilis:

./build.sh

Untuk membangun mode debug, jalankan skrip dengan tanda --debug .

Memasang

Perintah shell berikut akan menginstal proyek dalam mode rilis:

./install.sh

Untuk menginstal dalam mode debug, jalankan skrip dengan tanda --debug .

Lisensi

Proyek ini dilisensikan di bawah Lisensi MIT.

Hak Cipta (c) 2018-2019 Brett Robinson

Izin dengan ini diberikan, secara gratis, kepada siapa pun yang memperoleh salinan perangkat lunak ini dan file dokumentasi terkait ("Perangkat Lunak"), untuk menggunakan Perangkat Lunak tanpa batasan, termasuk tanpa batasan hak untuk menggunakan, menyalin, memodifikasi, menggabungkan , mempublikasikan, mendistribusikan, mensublisensikan, dan/atau menjual salinan Perangkat Lunak, dan mengizinkan orang yang menerima Perangkat Lunak untuk melakukan hal tersebut, dengan tunduk pada ketentuan berikut:

Pemberitahuan hak cipta di atas dan pemberitahuan izin ini akan disertakan dalam semua salinan atau sebagian besar Perangkat Lunak.

PERANGKAT LUNAK INI DISEDIAKAN "APA ADANYA", TANPA JAMINAN APA PUN, TERSURAT MAUPUN TERSIRAT, TERMASUK NAMUN TIDAK TERBATAS PADA JAMINAN KELAYAKAN UNTUK DIPERDAGANGKAN, KESESUAIAN UNTUK TUJUAN TERTENTU, DAN TIDAK ADA PELANGGARAN. DALAM KEADAAN APA PUN PENULIS ATAU PEMEGANG HAK CIPTA TIDAK BERTANGGUNG JAWAB ATAS KLAIM, KERUSAKAN, ATAU TANGGUNG JAWAB LAINNYA, BAIK DALAM TINDAKAN KONTRAK, HUKUM ATAU LAINNYA, YANG TIMBUL DARI, ATAU SEHUBUNGAN DENGAN PERANGKAT LUNAK ATAU PENGGUNAAN ATAU HAL-HAL LAIN DALAM PERANGKAT LUNAK.