用于从终端搜索 GitHub 的 CLI 工具。
Stig 是一个用于从终端搜索 GitHub 的 CLI 工具。凭借对结果进行排序和过滤的功能,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 转义码和真彩色的终端仿真器。大多数流行的终端模拟器都应该支持两者。虽然启用彩色输出可以提供最佳体验,但可以使用--color
选项进行调整,将on
、 off
或auto
作为输入,其中 auto 是默认值。
默认情况下,GitHub API 每分钟最多允许10 个搜索查询。要将限制扩展到每分钟30 个搜索查询,您可以使用--token
选项传递 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
./src/ob/belle.hh
./src/ob/parg.hh
./src/lib/json.hh
以下 shell 命令将以发布模式构建项目:
./build.sh
要在调试模式下构建,请使用--debug
标志运行脚本。
以下 shell 命令将以发布模式安装项目:
./install.sh
要在调试模式下安装,请使用--debug
标志运行脚本。
该项目根据 MIT 许可证获得许可。
版权所有 (c) 2018-2019 布雷特·罗宾逊
特此免费授予获得本软件和相关文档文件(“软件”)副本的任何人不受限制地使用本软件,包括但不限于使用、复制、修改、合并的权利、发布、分发、再许可和/或销售软件的副本,并允许向其提供软件的人员这样做,但须满足以下条件:
上述版权声明和本许可声明应包含在本软件的所有副本或主要部分中。
本软件按“原样”提供,不提供任何明示或暗示的保证,包括但不限于适销性、特定用途的适用性和不侵权的保证。在任何情况下,作者或版权持有者均不对因本软件或本软件中的使用或其他交易而产生或与之相关的任何索赔、损害或其他责任负责,无论是合同、侵权行为还是其他行为。软件。