https://github.com/holmanb/grok
a silly tool to query Github repository metadata
https://github.com/holmanb/grok
Last synced: over 1 year ago
JSON representation
a silly tool to query Github repository metadata
- Host: GitHub
- URL: https://github.com/holmanb/grok
- Owner: holmanb
- Created: 2024-02-08T18:14:33.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-02-08T18:23:11.000Z (over 2 years ago)
- Last Synced: 2025-01-20T06:19:00.517Z (over 1 year ago)
- Language: Python
- Size: 17.6 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# grok
*a silly tool to query Github repository metadata*
## Getting started
### Create a personal access token
Generate a public read-only [personal access token](https://github.com/settings/personal-access-tokens/new). Back up the token somewhere safe, then use it in our configuration in the next step
### Create a configuration `~/.config/grok.tolm`
```bash
cat << EOF > ~/.config/grok.toml
[system]
auth_key = "your key goes here"
default_org = "holmanb"
default_repo = "grok"
default_mode = "all"
EOF
```
Be sure to set your key, default organization, and default repo in the configuration.
### Install grok
```bash
pip install --user grk
```
4. Run grok
```bash
grok
```