Fast file search over a persistent inverted index
moonsearch index -r ~/Documents
moonsearch 'ext:pdf size:>1mb' -n 20moon install q2316367743/moonsearch/cmd/moonsearch| 平台 | 文件 |
|---|---|
| Linux x86_64 | moonsearch-<version>-linux-x86_64.tar.gz |
| macOS arm64 | moonsearch-<version>-macos-arm64.tar.gz |
| Windows x86_64 | moonsearch-<version>-windows-x86_64.zip |
moon build --target native --release
./_build/native/release/build/cmd/moonsearch/moonsearch.exe --version# 建立索引,可指定多个根目录
moonsearch index -r ~/Documents -r ~/Downloads
# 查询(search 是默认子命令)
moonsearch 'ext:pdf size:>1mb'
moonsearch 'report dm:lastweek' --sort size --reverse -n 20
# 只输出命中数量
moonsearch count 'ext:mp4'
# 检查数据库完整性并查看统计
moonsearch info --verifymoonsearch <command> [options] [query...]| 命令 | 用途 |
|---|---|
| index | 扫描根目录并写入索引数据库 |
| update | 重新扫描根目录并替换索引数据库 |
| search | 查询索引(默认子命令) |
| count | 输出命中数量 |
| info | 显示数据库统计信息;--verify 校验每个段 |
| 选项 | 说明 |
|---|---|
| -D, --database <PATH> | 数据库路径(MOONSEARCH_DATABASE) |
| --config <PATH> | 预留:配置文件尚未读取(MOONSEARCH_CONFIG) |
| --no-config | 预留:保留解析但不生效 |
| -v, --verbose / -q, --quiet | 详细进度 / 只输出结果与错误 |
| --stats | 向 stderr 输出耗时与索引体积 |
| --explain | 向 stderr 输出解析后的查询与执行计划 |
| -h, --help / -V, --version | 帮助 / 版本 |
moonsearch search --live --root ~/Documents 'ext:jpg;png size:>1mb'
moonsearch count --live --root ~/Documents 'dm:lastweek ext:mp4'moonsearch index -r ~/Documents ~/Downloads # 位置参数也可以
moonsearch update ~/Documents # 重新扫描并原子替换| 选项 | 说明 |
|---|---|
| -r, --root <PATH> | 根目录,可重复;也可写成位置参数 |
| -x, --exclude <RULE> | 排除规则,可重复 |
| --exclude-scope <SCOPE> | 规则匹配对象:full_path(默认)或 basename |
| --exclude-target <T> | 规则作用对象:both(默认)、files 或 folders |
| --exclude-hidden | 跳过以点开头的名称 |
| --no-default-excludes | 不跳过 /proc、/sys、/dev、/run |
| --allow-nested-roots | 允许根目录相互嵌套 |
| --fast-fields <LIST> | 预建区间字段,默认 size,mtime;可选 size、mtime、depth、childcount、parent |
| --no-trigram | 不构建 trigram 倒排;名称查询将退化为全扫描 |
| --one-file-system | 不跨文件系统;当前纯 MoonBit 后端上为空操作并打印警告 |
moonsearch index -r ~/Projects -x 'glob:*/node_modules' -x 'glob:*.tmp' --exclude-hiddenroots: 1
folders: 4
files: 3
bytes: 6moonsearch report # 名称包含 report
moonsearch '"annual report"' # 单个词项内含空格时用引号
moonsearch docs/report # 路径包含 docs/report
moonsearch '*.pdf' # glob:以 .pdf 结尾
moonsearch -r '^report.*\.pdf$' # 正则:整条查询作为正则| 选项 | 说明 |
|---|---|
| -c, --case-sensitive | 大小写敏感 |
| -e, --exact | 整名精确匹配 |
| -p, --search-path | 按完整路径匹配 |
| -r, --regex | 整条查询作为正则 |
| --type <any\|file\|folder> | 限制结果类型,默认 any |
| --engine <scan\|bitmap> | 执行引擎,默认 scan |
| --root <PATH> | --live / --auto-index 使用的根目录,可重复 |
| --live | 跳过数据库,直接扫描 --root |
| --auto-index | 数据库缺失时先按 --root 建库 |
| --compat | 兼容上游错误恢复:未知字段、非法值变成空集 |
moonsearch 'report AND pdf'
moonsearch '(report OR summary) NOT draft'
moonsearch 'file:(pdf OR doc) dm:lastweek'| 字段 | 含义 | 示例 |
|---|---|---|
| ext: | 扩展名,; 分隔;空值表示无扩展名 | ext:jpg;png、ext: |
| size: | 大小(文件与目录;目录为子树总量) | size:>1mb、size:1kb..2mb |
| dm: | 修改时间(别名 datemodified:) | dm:today、dm:2024-03 |
| depth: | 深度,根目录为 0(别名 parents:) | depth:<=2 |
| childcount: | 直接子项数(目录) | childcount:0 |
| childfilecount: | 直接子文件数(目录) | childfilecount:>10 |
| childfoldercount: | 直接子目录数(目录) | childfoldercount:1..3 |
| parent: | 父目录完整路径(不展开 ~) | parent:/home/user/Documents |
| empty: | 空目录(不带值) | empty: |
| contenttype: | MIME 类型;只写主类型或子类型均可 | contenttype:pdf、contenttype:text |
| 修饰符 | 作用 |
|---|---|
| case: / nocase: | 大小写敏感 / 不敏感 |
| exact: | 整名精确匹配 |
| path: / nopath: | 匹配完整路径 / 仅匹配名称 |
| regex: / noregex: | 正则 / 关闭正则 |
| file: / files: | 仅文件 |
| folder: / folders: | 仅目录 |
| hidden: | 仅隐藏条目 |
| nohidden: / visible: | 仅非隐藏条目 |
| 分类 | 扩展名 |
|---|---|
| app: | app, appimage, deb, desktop, dmg, exe, flatpak, msi, pkg, rpm, snap |
| archive: | 7z, bz2, cab, gz, gzip, iso, jar, lz4, lzma, rar, tar, tbz2, tgz, txz, xz, zip, zst |
| audio: | aac, ac3, aiff, alac, ape, au, flac, m4a, mka, mp3, oga, ogg, opus, wav, wma, wv |
| doc: | c, cc, chm, cpp, csv, cxx, doc, docx, epub, go, h, hpp, htm, html, ini, java, js, json, log, lua, md, mobi, mbt, odt, pdf, ppt, pptx, py, rb, rs, rtf, sh, tex, toml, ts, tsv, txt, xls, xlsx, xml, yaml, yml |
| pic: | avif, bmp, gif, heic, ico, jpeg, jpg, png, psd, svg, tif, tiff, webp, xcf |
| video: | 3gp, avi, flv, m4v, mkv, mov, mp4, mpeg, mpg, ogv, rmvb, vob, webm, wmv |
# 大于 1 MB 的 PDF
moonsearch 'ext:pdf size:>1mb'
# 最近一周修改过的图片和视频
moonsearch 'pic: OR video: dm:lastweek'
# 两层以内的目录
moonsearch 'folder: depth:<=2' --sort path
# docs 目录下的非隐藏文件,按大小排序
moonsearch 'parent:/home/user/Documents/docs nohidden:file:' --sort size --reverse
# 空目录
moonsearch 'folder: empty:'
# 整个索引按名称列出前 20 条(空查询)
moonsearch '' -n 20
# 只统计数量
moonsearch count 'ext:mp4 dm:last30days'| 选项 | 说明 |
|---|---|
| --sort <name\|path\|size\|mtime\|ext\|type> | 排序键,默认 name |
| --reverse | 反转整个顺序(含平局判定) |
| --folders-first | 目录排在文件之前,组内保持所选键与方向 |
| -n, --limit <N> | 最多输出 N 条;0 表示不限,默认 0 |
| --basename | 只输出名称 |
| --json | 每行一个 JSON 对象 |
| --format <TEMPLATE> | 自定义每条结果的格式 |
| -0, --null | 每条记录以 NUL 结尾(含最后一条),便于 xargs -0 |
| --relative-to <DIR> | 输出相对该目录的路径 |
moonsearch --stats 'ext:pdf' # 条目数、命中数、耗时;读库时还有 load,实时扫描为 scan
moonsearch --explain 'report pdf' # 解析后的查询 + 执行计划
moonsearch info --verify # 数据库各段校验| 码 | 含义 |
|---|---|
| 0 | 成功、帮助或版本 |
| 1 | 无命中 |
| 2 | 参数、查询、IO 或数据库错误 |
| 130 | 被 SIGINT 中断 |
| 文档 | 内容 |
|---|---|
| docs/modules/cli.md | 命令解析、执行编排、输出规则 |
| docs/modules/query.md | 词法、语法与查询 AST |
| docs/modules/exec.md | 扫描引擎、查询编译与位图执行 |
| docs/modules/index.md | 扫描器、字典、区间索引、trigram 倒排、持久化 |
| docs/db-format.md | MSDB v2 数据库格式 |
| docs/benchmarks.md | 基准口径、实测结果与调优待办 |
| MIGRATION_PLAN.md | 迁移计划与设计取舍 |
moon check --target native --deny-warn
moon test --target native
moon fmt
moon info
moon testcli test tests/cli.md --target native