CLIツール#

sphinx-sqlite3fts は検索結果を簡易的に確認するためのCLIを提供しています。

動作環境#

CLIツールを使うには、通常のインストールに加えて Click が必要です。sphinx-sqlite3fts の追加パッケージとして登録されています。

pip install 'sphinx-sqlite3fts[cli]'

使用例#

CLIツールの実行前に、 sphinx-build を使ってデータベースを作成する必要があります。

sphinx-build -b sqlite . _build

データベースから検索するためには、データベースのパスと検索キーワードを指定して実行してください。

sphinx-sqlite3fts _build/db.sqlite Hello

cli-tool
     Simple CLI tool

getting-started
     Getting started

コマンドは、検索にヒットしたドキュメントの「ページ名」と「タイトル」を出力します。