stig

Стиг

Инструмент CLI для поиска GitHub с терминала.

О

Stig — это инструмент CLI для поиска GitHub с терминала. Благодаря возможности сортировки и фильтрации результатов Стиг позволяет легко найти то, что вы ищете. Стиг также может распечатать README.md репозитория на стандартный вывод, чтобы вы могли быстро узнать больше о проекте.

Функции

• поиск GitHub из терминала
• используйте флаги и параметры для фильтрации результатов
• распечатать файл readme указанного репозитория на стандартный вывод

Разбивка результатов

Типичный элемент результатов поиска будет выглядеть следующим образом:

 - 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

Совместимость терминалов

Если включен цветной вывод, требуется эмулятор терминала, поддерживающий escape-коды ansi и true color . Большинство популярных эмуляторов терминала должны поддерживать оба варианта. Хотя включение цветного вывода обеспечивает наилучшие впечатления, его можно настроить с помощью параметра --color , принимая в качестве входных данных on , off или auto , при этом auto является значением по умолчанию.

Токен GitHub

По умолчанию API GitHub допускает до 10 поисковых запросов в минуту. Чтобы увеличить лимит до 30 поисковых запросов в минуту, вы можете передать токен GitHub с опцией --token .

Дополнительные сведения о создании нового токена личного доступа см. в следующей справочной статье GitHub.

Корпоративная совместимость с 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

Строить

Среда

• Linux (поддерживается)
• БСД (непроверено)
• macOS (непроверено)

Требования

• Компилятор С++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
• Библиотека json nlohmann для работы с JSON, включенная в файл ./src/lib/json.hh

Следующая команда оболочки соберет проект в режиме выпуска:

./build.sh

Для сборки в режиме отладки запустите скрипт с флагом --debug .

Установить

Следующая команда оболочки установит проект в режиме выпуска:

./install.sh

Для установки в режиме отладки запустите скрипт с флагом --debug .

Лицензия

Этот проект распространяется по лицензии MIT.

Copyright (c) 2018-2019 Бретт Робинсон

Настоящим бесплатно любому лицу, получившему копию этого программного обеспечения и связанных с ним файлов документации («Программное обеспечение»), предоставляется разрешение на работу с Программным обеспечением без ограничений, включая, помимо прочего, права на использование, копирование, изменение, объединение. публиковать, распространять, сублицензировать и/или продавать копии Программного обеспечения, а также разрешать лицам, которым предоставлено Программное обеспечение, делать это при соблюдении следующих условий:

Вышеупомянутое уведомление об авторских правах и данное уведомление о разрешении должны быть включены во все копии или существенные части Программного обеспечения.

ПРОГРАММНОЕ ОБЕСПЕЧЕНИЕ ПРЕДОСТАВЛЯЕТСЯ «КАК ЕСТЬ», БЕЗ КАКИХ-ЛИБО ГАРАНТИЙ, ЯВНЫХ ИЛИ ПОДРАЗУМЕВАЕМЫХ, ВКЛЮЧАЯ, НО НЕ ОГРАНИЧИВАЯСЬ, ГАРАНТИЯМИ ТОВАРНОЙ ЦЕННОСТИ, ПРИГОДНОСТИ ДЛЯ ОПРЕДЕЛЕННОЙ ЦЕЛИ И НЕНАРУШЕНИЯ ПРАВ. НИ ПРИ КАКИХ ОБСТОЯТЕЛЬСТВАХ АВТОРЫ ИЛИ ОБЛАДАТЕЛИ АВТОРСКИХ ПРАВ НЕ НЕСУТ ОТВЕТСТВЕННОСТИ ЗА ЛЮБЫЕ ПРЕТЕНЗИИ, УБЫТКИ ИЛИ ДРУГУЮ ОТВЕТСТВЕННОСТЬ, БУДЬ В ДЕЙСТВИЯХ ПО КОНТРАКТУ, ПРАВОНАРУШЕНИЮ ИЛИ ДРУГИМ ОБРАЗОМ, ВОЗНИКАЮЩИЕ ОТ, ИЗ ИЛИ В СВЯЗИ С ПРОГРАММНЫМ ОБЕСПЕЧЕНИЕМ ИЛИ ИСПОЛЬЗОВАНИЕМ ИЛИ ДРУГИМИ СДЕЛКАМИ, ПРОГРАММНОЕ ОБЕСПЕЧЕНИЕ.