開発者ドキュメント

FastFind は 自分の PC の中に小さな検索サーバーを立ち上げることができます。そのため、ほかのプログラムが検索結果を受け取れます。

0.81 から、Web 接続は既定でオフです。 設定 → ウェブ接続でオンにして初めて、下の REST API が開きます。オンにせずに接続する方法もあります — 名前付きパイプ をご覧ください。

• PowerShell・Python スクリプトからファイル一覧を取得
• 自作のランチャー・ツールに検索を組み込む
• 結果の右クリックメニューに 自分の機能を差し込む (プラグイン)

索引はご自身の PC の中だけにあり、外に出ません。サーバーも 127.0.0.1 にしか応答しません。

既定は 9090 番です。設定で変更できます。

ただし、Web 接続をオンにしないと開きません。 オフのときは、プログラムが動いていてもそのポートは存在しません — 待ち受けソケットをそもそも作らないからです。

できます。q にそのまま入れてください — 検索欄に打つのと同じ文法です。

GET /api/search?q=dupe:내용 ext:jpg
GET /api/search?q=dupe: path:D:\사진
GET /api/search?q=empty:

結果は 同じもの同士が並んで 返ります。かたまりの順序は常に同じなので、同じ問い合わせを二度送っても順番が入れ替わりません。

dupe:内容 はファイルを実際に読むため、他の問い合わせより時間がかかります。候補が 2 万件を超えると中身までは比べず、error に案内を入れて返します — 結果が全部だと思って消してはいけないからです。

http://127.0.0.1:9090

プログラムが終了していればサーバーもありません。先に /api/status で起動を確かめてから使うほうが安全です。

誰でもファイル一覧を取れてはいけないので、トークンなしでは応答しません。

次の二つのいずれかで送ってください。

トークンは /login 画面で受け取ります。この二つのアドレスだけがトークンなしで開きます。

POST /api/local-auth/login

curl -H "Authorization: Bearer $TOKEN" \
  "http://127.0.0.1:9090/api/search?q=견적서%20ext:pdf&max=50"

送るもの

真偽値は 1 0 true false on off yes no をすべて受け付けます。値を書かない &raw もオンとみなします。

ext: の使い方

⚠ プログラムから呼ぶときは raw=1 を付けてください。

既定ではいくつかの語を 人が使いやすいように解釈します。 人には便利ですが、プログラムから呼ぶときは 予告なく問い合わせが変わることので、結果がおかしく見えます。

ただし語を一つだけ送った場合は種類を推測しません。 q=photo は名前に photo が入ったファイルを探します。下の表は 語が二つ以上のとき（例： photo 찾아줘）に適用されます。

GET /api/search?q=photo             → 이름에 photo 가 든 파일 (낱말 하나 — 짐작 안 함)
GET /api/search?q=photo 찾아줘      → 이미지 파일 전부 (낱말 둘 — 짐작함)
GET /api/search?q=photo 찾아줘&raw=1 → 이름에 photo 가 든 파일

ext: path: size: などの構文は raw=1 をオンにしてもそのまま効きます。 それは推測ではなく、書かれたそのものだからです。オフにするのは推測だけです。

何と解釈したかは応答に含まれます。

"interpreted": {
  "keyword": null,                 // 실제로 찾은 낱말 (짐작으로 사라지면 null)
  "extensions": ["jpg","png", …],  // 걸린 확장자
  "guessed": true,                 // ← 참이면 짐작이 낱말을 삼킨 것입니다
  "guessed_words": ["photo"],      // 무엇 때문에 바뀌었는지
  "raw": false
}

guessed true 면 raw=1 で呼び直せば できます。

受け取るもの

{
  "results": [
    {
      "name": "견적서_한빛건설.pdf",
      "path": "C:\\작업\\2026\\견적서_한빛건설.pdf",
      "size": 284915,
      "ext": "pdf",
      "modified": 1786012800,
      "is_dir": false
    }
  ],
  "total": 12,
  "time_ms": 5.3,
  "query": "견적서 ext:pdf"
}

total は 条件に合う全体の件数 で、results はそのうち返した分です。modified は 1970 年からの秒です。

索引が準備できているか、何件入っているかを見ます。検索を送る前にこれを先に確認 すれば、プログラムが終了している場合やまだ索引中の場合を見分けられます。

{
  "indexed_files": 4663246,
  "version": "0.86.0",
  "status": "ready"
}

応答には engine engine_gen mem のような項目も一緒に来ますが、それは 私たちが問題を探すときに使う値 なので予告なく変わります。頼らないでください。

入力中に見せる候補を受け取ります。文字列の配列を一つだけ返します。

GET /api/suggest?q=견적

["견적서_한빛건설.pdf", "견적서_양식.hwp", "견적_2026.xlsx"]

$t = "여기에 토큰"
$r = Invoke-RestMethod -Uri "http://127.0.0.1:9090/api/search?q=ext:log" `
     -Headers @{ Authorization = "Bearer $t" }
$r.results | Select-Object name, path, size | Format-Table

import requests, urllib.parse

TOKEN = "여기에 토큰"
q = urllib.parse.quote("견적서 ext:pdf")
r = requests.get(f"http://127.0.0.1:9090/api/search?q={q}&max=20",
                 headers={"Authorization": f"Bearer {TOKEN}"})
for f in r.json()["results"]:
    print(f["size"], f["path"])

下記も開いています。ただし 私たちのウェブ画面が使うために作ったもの なので予告なく変わります。使うとしても 壊れうると承知のうえで お使いください。

この中でよく使うものがあれば お知らせください。使う方がいるものから約束の一覧へ移します。

プログラムはユーザーが終了すると一緒に消え、 ウェブ接続をオンにしなければ、そもそも起動もしません。 常に起動していると考えないでください。呼び出す前に /api/status で確認し、だめなら静かに次へ進むようにしておくのが安全です。

ユーザーに「設定でオンにしてください」とお願いしたくない場合は、 名前付きパイプ をお使いください。ウェブ接続とは関係なく、常に開いています。

既定は 9090 ですが、利用者が設定で変えられます。配布するツールなら ポートを尋ねるか設定できるように 作っておいてください。

設定ファイルから読むこともできます。

%LOCALAPPDATA%\FastFind\settings.json

/api/status の中にあります。 /api/version · /api/health · /api/info は ありません(404).

機能が使えるかを判定するときは /api/status 의 version をご覧ください。

既定で 取り込まないフォルダーがあります。一時ファイルとシステムフォルダーなので、取り込むと結果が散らかり索引も大きくなります。

拡張子も tmp · temp · bak · old · lnk · url も取り込みません。

利用者が 設定 → 索引範囲 でこの一覧を変更できるため、PC ごとに異なることがあります。

0.81 から、Web 接続は既定でオフです。そのため REST API を使うにはユーザーに設定をオンにしてもらう必要がありますが、それはいいお願いではありません。

ではなく 名前付きパイプがあります。Web 接続とは関係なく は常に開いていて、ポートを開きません。

\\.\pipe\FastFind

パイプの上に のような REST ルーターがそのまま載っています。ですからパスもパラメータも応答も、上で説明したものとまったく同じです。 変わるのは通り道だけです — パイプに HTTP リクエストを書き込んで応答を読むだけです。

Windows ではパイプを ただのファイルのように を開くだけです。特別なライブラリは必要ありません。

GET /api/search?q=견적서 HTTP/1.1
Host: 127.0.0.1
Connection: close

Host は 必ず数字のアドレスでなければなりません。名前を書くと拒否します（DNS リバインディングを防ぐためです）。値を変える要求であれば、 Sec-Fetch-Site: same-origin も付けてください。読み取りだけの要求には必要ありません。

Connection: close 를 を忘れないでください。 なければ接続が維持され、最後まで読もうとする側がいつまでも待ち続けます。「できない」ではなく「止まる」という形で現れるため、見つけにくいのです。

パイプはインスタンス 1 つにつき接続 1 つです。あらかじめ複数を開いていますが、要求が集中すると一時的に足りなくなることがあります。

2 番は「ない」と読んで諦めてしまいがちですが、 ここでは「少し待ってほしい」という意味であることが多いです。どちらの場合も、短い間隔で数回再試行してください(10ms ごとに 5 回で十分です)。それでも 2 が出続けるなら、そのときが本当に「FastFind がない」ときです。

この PC に今ログインしているユーザーだけ だけが接続できます。同じ PC の別のアカウントも、ネットワーク越しも接続できません。

ID やパスワードを入れるものはありません — 接続してきた相手が誰なのかを Windows が教えてくれるので、こちらはパイプを作るときに「このユーザーのみ」と一度書いておくだけです。

検索結果を右クリックしたときに出るメニューに 自分の機能を差し込む ものです。

プラグインは 別の実行ファイル です。DLL としてアプリの中に入れません — 他人のコードが誤っても FastFind まで落ちてはいけないからです。だから どんな言語でも 作れます。

FastFind → 플러그인 :  myplugin.exe --path "C:\\file.txt"
플러그인 → FastFind :  표준출력으로 JSON 한 덩어리

{"action":"message","title":"줄 수","text":"1,284줄"}
{"action":"copy","text":"복사할 내용"}
{"action":"open","path":"C:\\어딘가"}

選んだファイルが何行かを数えて知らせるものです。

import sys, json
path = sys.argv[sys.argv.index("--path") + 1]
n = sum(1 for _ in open(path, encoding="utf-8", errors="ignore"))
print(json.dumps({"action": "message", "title": "줄 수",
                  "text": f"{n:,}줄"}, ensure_ascii=False))

これを exe にして下の場所に置き、隣に plugin.json を置きます。

%LOCALAPPDATA%\\FastFind\\plugins\\linecount\\
    run.exe
    plugin.json

{
  "id": "linecount",
  "name": "줄 수 세기",
  "description": "고른 파일의 줄 수를 셉니다",
  "version": "1.0.0",
  "author": "내 이름"
}

FastFind を立ち上げ直すと、結果の右クリックメニューに 行数を数える が出ます。

四つが一緒にインストールされます。作るときの参考にどうぞ。

• ファイル情報 — サイズ・時刻・属性
• ハッシュ — SHA-256 を計算
• 画像情報 — サイズ・形式
• 文字統計 — 行・単語・文字数

正直に書きます。このページに書いたものだけ を約束します。

プログラムの中にはこれより多くのパスがありますが、ほとんどは私たちのウェブ画面が使うものです。公開すると簡単には変えられない約束になるので、安定したものだけを選んで ここに書きました。

新しい項目が 増える ことはあります。それは既存のものを壊さないので、知らない項目が来たら無視するように作っておいてください。

• 公式ライブラリがありません。 HTTP で直接呼んでいただく必要があります
• 変更通知 (ウェブフック) がありません。 ファイルができたときに知らせる手段がないので、必要なら問い直していただく必要があります
• プラグインが結果一覧を変えることはできません。 今は右クリックメニューから一つの仕事をするところまでです

必要なものがあれば お知らせください。使う方がいれば作ります。

サーバーを使わずに実行ファイルを直接呼んでも構いません。

FastFind.exe --console ext:log > list.txt

詳しくは 使い方のコマンドライン の項にあります。