使用方法 

テンプレートのレポジトリは GitHub 上では .g8 で終わる名前を使う規約を勝手に作った。 Wiki にテンプレートのリストがあるので見てほしい。

例えば、unfiltered/unfiltered.g8 というテンプレートを適用するには以下を実行する:

$ g8 unfiltered/unfiltered.g8

Giter8 はこれを GitHub 上の unfiltered/unfiltered.g8 というレポジトリだと解決してプロジェクトのテンプレートやパラメータを問い合わせる。 他に、git レポジトリをフルネームで指定することも可能だ。

$ g8 https://github.com/unfiltered/unfiltered.g8.git

テンプレートを実行すると、各パラメータへのプロンプトが表示される。 このときデフォルト値は角括弧で表示される:

name [My Web Project]: 

何らかの値を書き込むか、エンターキーを押してデフォルト値をそのまま使う。 全ての値が渡されると Giter8 はテンプレートを読み込んで、パラメータを適用して、 ファイルシステムに書き込みを行う。

テンプレートに name というパラメータがあると、それはカレントディレクトリ以下のベースディレクトリ名として使われる (新プロジェクトを生成するときには通常この方法を使う)。 name が無ければ、Giter8 はカレントディレクトリにファイルやディレクトリの書き込みを行うが、既存のファイルがある場合はスキップされる。

テンプレートのパラメータに慣れてくるとコマンドライン上から直接指定してプロンプトを回避することも可能だ:

$ g8 unfiltered/unfiltered.g8 --name=my-new-website

このとき未指定のパラメータはデフォルト値が代入されるので注意。

プライベートリポジトリ 

Giter8 は、git 同様に ssh キーを使ってプライベートリポジトリにアクセスすることができる。