コマンドラインツール・リファレンス

oktavia-mkindex

$ oktavia_mkindex [options]

-i, --input [入力フォルダ/ファイル]:

検索対象としたいファイルです。.html、.csv、.txtが利用可能です。
-t, --type [タイプ]:

エクスポートタイプです。 index 、 base64 、 js (デフォルト)、 commonjs が利用可能です。indexはインデックスのみです。他のものはbase64化されたものをプログラムから利用可能な形式で保存したものになります。
-m, --mode [モード]:

処理するファイルのモードです。 ‘html’、’csv’、’text’が設定可能です。このオプションは必ず指定する必要があります。
-c, --cache-density [％]:

キャッシュの密度です。このパラメータはインデックスのファイルサイズと検索速度に影響を与えます。100%を設定すると、ベースとなるインデックスファイルの4倍の大きさになります。デフォルトは5%です。0.1% - 100%の数値を設定できます。
-n, --name [関数]:

‘js’出力時の変数名、もしくは、’commonjs’時のプロパティ名です。デフォルトは’searchIndex’です。
-q, --quiet:

詳細情報を非表示にします。
-h, --help:

ヘルプメッセージを表示します。

-r, --root [ドキュメントルート]:

ドキュメントルートフォルダです。デフォルトは現在のフォルダです。インデックスジェネレータは、このフォルダを基準にしたファイル名をインデックスに格納します。
-p, --prefix [ディレクトリプレフィックス]:

サーバのルートからドキュメントルートへのパスです。もしドメインがexample.comで、’manual’がオプションに設定されたとすると、ドキュメントのルートは http://example.com/manual/ となります。これは検索結果のURLに影響を与えます。デフォルトは ‘/’ です。
-o, --output [出力フォルダ]:

出力ファイルが保存されるディレクトリです。ルートからの相対パスを設定します。デフォルトは ‘/search’ です。
-u, --unit [検索単位]:

‘file’、’h1’-‘h6’ が利用可能です。デフォルトは ‘file’ です。
-f, --filter [ターゲットタグ]:

指定されたタグ内のコンテンツのみをインデックス化します。デフォルトは “article,#content,#main,div.body” です。
-s, --stemmer [アルゴリズム]:

ステミングアルゴリズムを選択します。

$ oktavia_search index_file [options] query