https://github.com/kyoshidajp/ghkw
Search how many keywords in GitHub Code tool
https://github.com/kyoshidajp/ghkw
git github golang
Last synced: about 1 month ago
JSON representation
Search how many keywords in GitHub Code tool
- Host: GitHub
- URL: https://github.com/kyoshidajp/ghkw
- Owner: kyoshidajp
- License: mit
- Created: 2018-02-03T07:54:52.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2020-02-29T07:46:30.000Z (about 5 years ago)
- Last Synced: 2025-03-29T11:09:51.013Z (about 1 month ago)
- Topics: git, github, golang
- Language: Go
- Homepage:
- Size: 38.1 KB
- Stars: 607
- Watchers: 9
- Forks: 7
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Changelog: Changes
- License: LICENSE
Awesome Lists containing this project
README
# ghkw
[][release]
[](https://travis-ci.org/kyoshidajp/ghkw)
[][godocs]
[][license]
[release]: https://github.com/kyoshidajp/ghkw/releases
[license]: https://github.com/kyoshidajp/ghkw/blob/master/LICENSE
[godocs]: http://godoc.org/github.com/kyoshidajp/ghkw
**ghkw** is **G**it**H**ub **K**ey**W**ord.
Search how many keywords in GitHub Code by GitHub API.
## Usage
```
$ ghkw [options...] [keyword ...]
```
### Example
Output markdown format.
```
$ ghkw exclusion_condition exclude_condition excluded_condition
| RANK | KEYWORD | TOTAL |
|------|---------------------|-------|
| 1 | exclude_condition | 272 |
| 2 | exclusion_condition | 64 |
| 3 | excluded_condition | 2 |
```
A search condition is in the file contents, language is javascript and file size is over 1,000bytes.
```
$ ghkw --in=file --language=javascript --size=">1000" exclude_condition exclusion_condition
```
### Options
```
--in Add in to search term.
--language Add language to search term.
--fork Add fork to search term.
--size Add size to search term.
--path Add path to search term.
--filename Add filename to search term.
--extension Add extension to search term.
--user Add user to search term.
--repo Add repo to search term.
-d, --debug Enable debug mode.
Print debug log.
-f, --format Output format (markdown, json).
default: markdown
-h, --help Show this help message and exit.
-v, --version Print current version.
```
*NOTE*: Set Github Access Token which has "Full control of private repositories" scope as an environment variable `GITHUB_TOKEN`. If not set, `ghkw` requires your Github username and password(and two-factor auth code if you are setting). Because of using [GitHub API v3](https://developer.github.com/v3/).
## Install
### Homebrew
If you have already installed [Homebrew](http://brew.sh/); then can install by brew command.
```
$ brew tap kyoshidajp/ghkw
$ brew install ghkw
```
### go get
If you are a Golang developper/user; then execute `go get`.
```
$ go get -u github.com/kyoshidajp/ghkw
```
### Manual
1. Download binary which meets your system from [Releases](https://github.com/kyoshidajp/ghkw/releases).
1. Unarchive it.
1. Put `ghkw` where you want.
1. Add `ghkw` path to `$PATH`.
## Author
[Katsuhiko YOSHIDA](https://github.com/kyoshidajp)