2011年10月29日

用 gist 指令快速建立程式碼剪貼簿(code snippets)


Gist 是 GitHub (時下最受歡迎的免費原始碼託管/版本控制平台)的程式碼剪貼簿服務,類似 Pastebin,但是更好、更棒(拍胸脯保證)!

Gist 有以下功能:
  1. 可以快速貼上一或多筆程式碼,如果是多筆,就會變成群組
  2. 可以手動選擇程式碼類型(哪一種程式語言),或輸入檔名,由系統自動依照副檔名判斷類型
  3. 漂亮的語法色彩標示(Syntax Highlighting)
  4. 建立的 Gist 程式碼群組,可以用 Git 版本控制系統 Clone 到不同電腦
  5. 可以內嵌(透過 JavaScript 語法)到部落格或網站
  6. 可以打包,一次下載整個檔案群組(.tar.gz 格式)
Gist 可以這樣用:
  1. 撰寫測試、練習用的程式碼,貼到 Gist 當筆記
  2. 不再使用的程式碼,但仍然有參考價值,貼到 Gist 備忘
  3. 將用過即丟的一次性程式碼,貼到 Gist 分享,給有緣人取用
  4. 程式碼出現 Bug,需要找人幫忙除錯,先貼到 Gist 再將 URL 放到 E-Mail
  5. 當好人,寫一段範例程式給別人參考,貼到 Gist 當 FAQ
也許你覺得,寫好程式碼還要複製到瀏覽器,還要用滑鼠按幾個按鈕很麻煩!

我也這樣覺得,所以並不是很常貼 Gist,直到發現 gist 這個好用的指令。

安裝 gist command line 工具 

Mac OS X

最簡單的安裝方式,就是買一部  MacBook Pro,然後安裝 Homebrew,只要使用 brew 指令就能完成安裝。

brew install gist

Ubuntu Linux

次簡單的安裝方式,就是買一部 PC 或 NB,然後灌 Ubuntu Linux 作業系統,接著只要使用 apt-get 及 gem 就能完成安裝。

sudo apt-get install ruby rubygems libopenssl-ruby
sudo gem install gist

*環境變數 $PATH 必須包含 /var/lib/gems/1.8/bin 路徑

Windows

Who cares??? 請自行參考 https://github.com/defunkt/gist

設定 gist 的 User 及 Token

使用 git 指令設定,user 就是登入 GitHub 的帳號名稱(不是電子郵件),token 可以在 GitHub 網站的「Account Settings / Account Admin / API Token」找到。

git config --global github.user "github-username"
git config --global github.token "github-token"

在 Account Admin 設定畫面,可以看到 API Token 的訊息如下:

API Token
Your API token is **************** — keep it secret! Changing your password will generate a new token.

其中打星號的部份就是 token,請不要洩漏出去。

使用 gist 快速剪貼程式碼

假設你有三個檔案,分別是 test1.js、test2.rb、test3.py,可以使用 gist 群組上傳。

gist test1.js test2.rb test3.py

如果看到以下訊息,表示 user 及 token 設定可能不正確:

Creating gist failed: 200 OK

如果執行結果是一段網址,則表示 Gist 已建立成功:

https://gist.github.com/代碼

除了將已經存在的程式碼檔案上傳外,也可以透過終端機自行打字輸入新的程式碼:

gist -t js -

其中參數 -t 是指令程式碼類型,通常只要用一般常見的副檔名即可。最後的 - 符號,則表示從 STDIN (終端機輸入)讀取。這行指令執行後,在終端機輸入的任何文字(包含換行),最後都會被上傳到 Gist。

當程式碼輸入完成(或複製貼上)後,按下 Ctrl + D (Control + D)就會執行上傳動作。

Gist 真是太方便啦!!!

延伸閱讀:
  1. Gist
  2. GitHub

沒有留言:

張貼留言

lyhcode by lyhcode
歡迎轉載,請務必註明出處!