เครื่องมือ CLI สำหรับการค้นหา GitHub จากเทอร์มินัล
Stig เป็นเครื่องมือ CLI สำหรับค้นหา GitHub จากเทอร์มินัล ด้วยความสามารถในการจัดเรียงและกรองผลลัพธ์ Stig ทำให้การค้นหาสิ่งที่คุณกำลังมองหาเป็นเรื่องง่าย Stig ยังสามารถพิมพ์ที่เก็บข้อมูล README.md ไปยัง stdout เพื่อให้คุณสามารถเรียนรู้เพิ่มเติมเกี่ยวกับโปรเจ็กต์ได้อย่างรวดเร็ว
รายการผลการค้นหาทั่วไปจะมีลักษณะดังนี้:
- 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.
พื้นที่เก็บข้อมูลแบบแยกจะแสดงสัญลักษณ์ >
แทนที่จะเป็นสัญลักษณ์ <
เริ่มต้น
สัญลักษณ์ที่อัปเดตล่าสุดจะถูกแมปดังต่อไปนี้:
s : seconds
m : minutes
h : hours
D : days
W : weeks
M : months
Y : years
เมื่อสิ้นสุดผลลัพธ์ จะมีการสรุปดังนี้
- current results
| - total results
| | - current page
| | | - total pages
| | | | - requests remaining
| | | | | - requests limit
| | | | | |
1-5/81 results | 1/17 pages | 9/10 limit
เทอร์มินัลอีมูเลเตอร์ที่รองรับ โค้ด ansi Escape และ สีจริง จำเป็นเมื่อเปิดใช้งานเอาต์พุตสี เทอร์มินัลอีมูเลเตอร์ยอดนิยมส่วนใหญ่ควรรองรับทั้งสองอย่าง แม้ว่าการเปิดใช้งานเอาต์พุตสีจะให้ประสบการณ์ที่ดีที่สุด แต่ก็สามารถปรับได้โดยใช้ตัวเลือก --color
โดย on
off
หรือ auto
เป็นอินพุต โดยที่ auto เป็นค่าเริ่มต้น
ตามค่าเริ่มต้น GitHub API อนุญาตให้ใช้คำค้นหาได้สูงสุด 10 รายการต่อนาที หากต้องการขยายขีดจำกัดเป็น 30 คำค้นหาต่อนาที คุณสามารถส่งโทเค็น GitHub ด้วยตัวเลือก --token
สำหรับข้อมูลเพิ่มเติมเกี่ยวกับการสร้างโทเค็นการเข้าถึงส่วนบุคคลใหม่ โปรดดูบทวิธีใช้ GitHub ต่อไปนี้
คุณสามารถใช้ตำแหน่งข้อมูล API แบบกำหนดเองเพื่อให้เข้ากันได้กับการติดตั้ง GitHub Enterprise โดยใช้ตัวเลือก --host
โฮสต์ควรได้รับการจัดรูปแบบเป็น subdomain.domain.tld
คาดว่าปลายทางจะให้บริการผ่าน HTTPS บนพอร์ต 443
สำคัญ
เมื่อใช้ตัวเลือก
--host
ให้ใช้ตัวเลือก--token
กับจุดสิ้นสุด API ที่กำหนดเองที่เชื่อถือได้เท่านั้น หากโฮสต์ที่ไม่ถูกต้องถูกส่งไปพร้อมกับโทเค็น ก็ควรที่จะเพิกถอนโทเค็นทันทีและสร้างโทเค็นใหม่
# 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
./src/ob/belle.hh
./src/ob/parg.hh
./src/lib/json.hh
คำสั่งเชลล์ต่อไปนี้จะสร้างโปรเจ็กต์ในโหมดรีลีส:
./build.sh
หากต้องการสร้างในโหมดดีบัก ให้รันสคริปต์ด้วยแฟล็ก --debug
คำสั่งเชลล์ต่อไปนี้จะติดตั้งโปรเจ็กต์ในโหมดรีลีส:
./install.sh
หากต้องการติดตั้งในโหมดดีบัก ให้รันสคริปต์ด้วยแฟล็ก --debug
โครงการนี้ได้รับอนุญาตภายใต้ใบอนุญาต MIT
ลิขสิทธิ์ (c) 2018-2019 เบรตต์ โรบินสัน
อนุญาตให้บุคคลใดก็ตามที่ได้รับสำเนาของซอฟต์แวร์นี้และไฟล์เอกสารที่เกี่ยวข้อง ("ซอฟต์แวร์") อนุญาตโดยไม่เสียค่าใช้จ่าย เพื่อจัดการกับซอฟต์แวร์โดยไม่มีข้อจำกัด รวมถึงแต่ไม่จำกัดเพียงสิทธิ์ในการใช้ คัดลอก ปรับเปลี่ยน ผสาน เผยแพร่ แจกจ่าย ให้อนุญาตช่วง และ/หรือขายสำเนาของซอฟต์แวร์ และอนุญาตให้บุคคลที่ได้รับซอฟต์แวร์นี้สามารถทำได้ ภายใต้เงื่อนไขต่อไปนี้:
ประกาศเกี่ยวกับลิขสิทธิ์ข้างต้นและประกาศการอนุญาตนี้จะรวมอยู่ในสำเนาทั้งหมดหรือส่วนสำคัญของซอฟต์แวร์
ซอฟต์แวร์นี้มีให้ "ตามที่เป็น" โดยไม่มีการรับประกันใดๆ ทั้งโดยชัดแจ้งหรือโดยนัย ซึ่งรวมถึงแต่ไม่จำกัดเพียงการรับประกันความสามารถในการค้าขาย ความเหมาะสมสำหรับวัตถุประสงค์เฉพาะ และการไม่ละเมิด ไม่ว่าในกรณีใดผู้เขียนหรือผู้ถือลิขสิทธิ์จะต้องรับผิดต่อการเรียกร้องค่าเสียหายหรือความรับผิดอื่นใดไม่ว่าในการกระทำของสัญญาการละเมิดหรืออย่างอื่นที่เกิดขึ้นจากหรือเกี่ยวข้องกับซอฟต์แวร์หรือการใช้งานหรือข้อตกลงอื่น ๆ ใน ซอฟต์แวร์.