Feat: View the main README.md from the terminal as well #120
d84-n1nj4
started this conversation in
Show and tell
Replies: 0 comments
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
-
Description
Hi all,
I put together this bash script that let's you view the main README.md for GitHub repos you find with this tool. This will only work with output format
list
. Let's say you runstarcli -L list -t deep-learning -p '>=2020-11-20' -r 10 -l pytorch
and you decide you want to look at one of those ten repos and view the README.md without leaving the terminal, and one of those repos isfastai/fastbook
.You'd create a shell script, say in your
~/Downloads
path withvim viewREADME.sh
and insert the following code:This script has a couple prerequisites. You need to install a program like
glow
orgrip
to handle the markdown file. Also, you'll need to get an access token from GitHub. You can follow this guide for the token Create a personal access token. Then update the code above with your personal access token. Once that is complete, you'd run./viewREADME.sh fastai/fastbook glow
to view the README.md for that repo.I'm sure this script could be cleaned up a bit, or further customized, but it works for my purposes.
Beta Was this translation helpful? Give feedback.
All reactions