stig

史蒂格

用於從終端機搜尋 GitHub 的 CLI 工具。

關於

Stig 是一個用於從終端機搜尋 GitHub 的 CLI 工具。憑藉對結果進行排序和過濾的功能，Stig 可以輕鬆找到您要查找的內容。 Stig 還可以將儲存庫 README.md 列印到 stdout，以便您可以快速了解有關專案的更多資訊。

特徵

• 從終端機搜尋 GitHub
• 使用標誌和選項來過濾結果
• 將指定儲存庫的自述文件列印到標準輸出

結果細目

典型的搜尋結果項目如下所示：

 - 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 轉義碼和真彩色的終端模擬器。大多數流行的終端模擬器都應該支援兩者。雖然啟用彩色輸出可以提供最佳體驗，但可以使用--color選項進行調整，將on 、 off或auto作為輸入，其中 auto 是預設值。

GitHub 令牌

預設情況下，GitHub API 每分鐘最多允許10 個搜尋查詢。若要將限制擴展到每分鐘30 個搜尋查詢，您可以使用--token選項傳遞 GitHub 令牌。

有關創建新的個人訪問令牌的更多信息，請參閱以下 GitHub 幫助文章。

GitHub 企業相容性

可以透過--host選項使用自訂 API 端點來與 GitHub Enterprise 安裝相容。主機的格式應為subdomain.domain.tld 。預計端點透過連接埠443上的HTTPS提供服務。

重要的

使用--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

建造

環境

• Linux（支援）
• BSD（未經測試）
• macOS（未經測試）

要求

• C++17編譯器
• 提升 >= 1.67
• OpenSSL >= 1.1.0
• CMake >= 3.8

依賴關係

• ssl（libssl）
• 加密（libcrypto）
• pthread（libpthread）
• 升壓（libboost_system）

圖書館：

• 我的 Belle 庫，用於發出 HTTPS 請求，包含為./src/ob/belle.hh
• 我的 parg 函式庫，用於解析 CLI 參數，包含為./src/ob/parg.hh
• nlohmann 的 json 庫，用於處理 JSON，包含為./src/lib/json.hh

以下 shell 命令將以發布模式建置專案：

./build.sh

要在偵錯模式下構建，請使用--debug標誌運行腳本。

安裝

以下 shell 指令將以發佈模式安裝專案：

./install.sh

若要在偵錯模式下安裝，請使用--debug標誌執行腳本。

執照

該項目已獲得 MIT 許可證的許可。

版權所有 (c) 2018-2019 布雷特羅賓遜

特此免費授予任何獲得本軟體和相關文件文件（「軟體」）副本的人不受限制地使用本軟體，包括但不限於使用、複製、修改、合併的權利、發布、分發、再授權和/或銷售軟體的副本，並允許向其提供軟體的人員這樣做，但須滿足以下條件：

上述版權聲明和本授權聲明應包含在本軟體的所有副本或主要部分中。

本軟體以「現況」提供，不提供任何明示或暗示的保證，包括但不限於適銷性、特定用途的適用性和不侵權的保證。 IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE軟體.