post Image
コンソールでGithubのReadme.mdを取得するコマンドを作ってみた

コマンドのヘルプを表示するには「man」を使うと便利です。

しかしmanが用意されていないコマンドも多く、まだインストールしていないツールのインストール方法などは、manでは調べることができません。
いわゆる「服を買いに行くための服がない」状態です。

というわけで、GithubのReadme.mdをコンソールから簡単に取得するコマンド「gman」を作ってみました。
これならばまだインストールしていないツールでも使い方やインストール方法をサクッと調べることができます。

curlでいいじゃん とても便利です。

gman

gman

コンソールで

 $ gman kurehajime/gman

と打てばreadmeを取得できます。

 $ gman node

このようにユーザー名を省略した場合は、一番人気のあるスターのついたリポジトリが選択されます。

-l オプションでその名称のリポジトリの一覧を確認することもできます。

 $ gman -l node

nodejs/node
atom/node
goerlang/node
oVirt/Node
nwjs/node
openwsn/node
MiniProfiler/node
kissyteam/node
tutumcloud/node

-o オプションを使えばブラウザが起動してリポジトリのページを表示します。

 $ gman nodejs/node

Github API

このgmanコマンドではGithubのAPIを利用しています。
Githubは開発者向けサービスだけあって、APIがとても充実しています。
公開情報の取得だけならばAPIキーも不要なので楽チンです。

検索

検索する場合は、q=KEYWORDに任意の単語を入れて以下のURLにアクセスします。

https://api.github.com/search/repositories?q=KEYWORD

するとJSONファイルが返ってくるので、それを利用します。
返されるJSONの形式についてはこちらのドキュメントが詳しいです。

リポジトリの情報の取得

リポジトリ情報の取得も簡単です。

https://api.github.com/repos/USERNAME/REPOSITORY

というように、USERNAMEとREPOSITORYをURLに埋め込めば、リポジトリの情報が一式取得できます。

返されるJSONの形式はこちらのドキュメントから。

・・・

このように、Github APIの利用は非常に簡単です。
何よりAPIキーや認証が不要なところが敷居が低くて捗ります。

まとめ

gmanはこちらからダウンロードできます。
Windows,Linux,Mac…いろんなOSで動きます。


『 Go 』Article List
Category List

Eye Catch Image
Read More

Androidに関する現役のエンジニアのノウハウ・トレンドのトピックなど技術的な情報を提供しています。コード・プログラムの丁寧な解説をはじめ、初心者にもわかりやすいように写真や動画を多く使用しています。

Eye Catch Image
Read More

AWSに関する現役のエンジニアのノウハウ・トレンドのトピックなど技術的な情報を提供しています。コード・プログラムの丁寧な解説をはじめ、初心者にもわかりやすいように写真や動画を多く使用しています。

Eye Catch Image
Read More

Bitcoinに関する現役のエンジニアのノウハウ・トレンドのトピックなど技術的な情報を提供しています。コード・プログラムの丁寧な解説をはじめ、初心者にもわかりやすいように写真や動画を多く使用しています。

Eye Catch Image
Read More

CentOSに関する現役のエンジニアのノウハウ・トレンドのトピックなど技術的な情報を提供しています。コード・プログラムの丁寧な解説をはじめ、初心者にもわかりやすいように写真や動画を多く使用しています。

Eye Catch Image
Read More

dockerに関する現役のエンジニアのノウハウ・トレンドのトピックなど技術的な情報を提供しています。コード・プログラムの丁寧な解説をはじめ、初心者にもわかりやすいように写真や動画を多く使用しています。

Eye Catch Image
Read More

GitHubに関する現役のエンジニアのノウハウ・トレンドのトピックなど技術的な情報を提供しています。コード・プログラムの丁寧な解説をはじめ、初心者にもわかりやすいように写真や動画を多く使用しています。

Eye Catch Image
Read More

Goに関する現役のエンジニアのノウハウ・トレンドのトピックなど技術的な情報を提供しています。コード・プログラムの丁寧な解説をはじめ、初心者にもわかりやすいように写真や動画を多く使用しています。

Eye Catch Image
Read More

Javaに関する現役のエンジニアのノウハウ・トレンドのトピックなど技術的な情報を提供しています。コード・プログラムの丁寧な解説をはじめ、初心者にもわかりやすいように写真や動画を多く使用しています。

Eye Catch Image
Read More

JavaScriptに関する現役のエンジニアのノウハウ・トレンドのトピックなど技術的な情報を提供しています。コード・プログラムの丁寧な解説をはじめ、初心者にもわかりやすいように写真や動画を多く使用しています。

Eye Catch Image
Read More

Laravelに関する現役のエンジニアのノウハウ・トレンドのトピックなど技術的な情報を提供しています。コード・プログラムの丁寧な解説をはじめ、初心者にもわかりやすいように写真や動画を多く使用しています。

Eye Catch Image
Read More

Pythonに関する現役のエンジニアのノウハウ・トレンドのトピックなど技術的な情報を提供しています。コード・プログラムの丁寧な解説をはじめ、初心者にもわかりやすいように写真や動画を多く使用しています。

Eye Catch Image
Read More

Rubyに関する現役のエンジニアのノウハウ・トレンドのトピックなど技術的な情報を提供しています。コード・プログラムの丁寧な解説をはじめ、初心者にもわかりやすいように写真や動画を多く使用しています。

Eye Catch Image
Read More

Scalaに関する現役のエンジニアのノウハウ・トレンドのトピックなど技術的な情報を提供しています。コード・プログラムの丁寧な解説をはじめ、初心者にもわかりやすいように写真や動画を多く使用しています。

Eye Catch Image
Read More

Swiftに関する現役のエンジニアのノウハウ・トレンドのトピックなど技術的な情報を提供しています。コード・プログラムの丁寧な解説をはじめ、初心者にもわかりやすいように写真や動画を多く使用しています。

Eye Catch Image
Read More

Unityに関する現役のエンジニアのノウハウ・トレンドのトピックなど技術的な情報を提供しています。コード・プログラムの丁寧な解説をはじめ、初心者にもわかりやすいように写真や動画を多く使用しています。

Eye Catch Image
Read More

Vue.jsに関する現役のエンジニアのノウハウ・トレンドのトピックなど技術的な情報を提供しています。コード・プログラムの丁寧な解説をはじめ、初心者にもわかりやすいように写真や動画を多く使用しています。

Eye Catch Image
Read More

Wordpressに関する現役のエンジニアのノウハウ・トレンドのトピックなど技術的な情報を提供しています。コード・プログラムの丁寧な解説をはじめ、初心者にもわかりやすいように写真や動画を多く使用しています。

Eye Catch Image
Read More

機械学習に関する現役のエンジニアのノウハウ・トレンドのトピックなど技術的な情報を提供しています。コード・プログラムの丁寧な解説をはじめ、初心者にもわかりやすいように写真や動画を多く使用しています。