vexor-cli

Compare original and translation side by side

🇺🇸

Original

English

🇨🇳

Translation

Chinese

Vexor CLI Skill

Vexor CLI 技能

Goal

目标

Find files by intent (what they do), not exact text.

根据意图（文件用途）而非精确文本查找文件。

Use It Like This

使用方式

Use
```
vexor
```
first for intent-based file discovery.
If
```
vexor
```
is missing, follow references/install-vexor.md.

优先使用
```
vexor
```
进行基于意图的文件检索。
若未安装
```
vexor
```
，请参考references/install-vexor.md进行安装。

Command

命令

bash

vexor "<QUERY>" [--path <ROOT>] [--mode <MODE>] [--ext .py,.md] [--exclude-pattern <PATTERN>] [--top 5] [--format rich|porcelain|porcelain-z]

bash

vexor "<QUERY>" [--path <ROOT>] [--mode <MODE>] [--ext .py,.md] [--exclude-pattern <PATTERN>] [--top 5] [--format rich|porcelain|porcelain-z]

Common Flags

常用参数

```
--path/-p
```
: root directory (default: current dir)
```
--mode/-m
```
: indexing/search strategy
```
--ext/-e
```
: limit file extensions (e.g.,
```
.py,.md
```
)
```
--exclude-pattern
```
: exclude paths by gitignore-style pattern (repeatable;
```
.js
```
→
```
**/*.js
```
)
```
--top/-k
```
: number of results
```
--include-hidden
```
: include dotfiles
```
--no-respect-gitignore
```
: include ignored files
```
--no-recursive
```
: only the top directory
```
--format
```
:
```
rich
```
(default) or
```
porcelain
```
/
```
porcelain-z
```
for scripts
```
--no-cache
```
: in-memory only, do not read/write index cache

```
--path/-p
```
：根目录（默认值：当前目录）
```
--mode/-m
```
：索引/检索策略
```
--ext/-e
```
：限制文件扩展名（例如：
```
.py,.md
```
）
```
--exclude-pattern
```
：通过gitignore风格的规则排除路径（可重复使用；
```
.js
```
等效于
```
**/*.js
```
）
```
--top/-k
```
：返回结果数量
```
--include-hidden
```
：包含隐藏文件
```
--no-respect-gitignore
```
：包含被git忽略的文件
```
--no-recursive
```
：仅检索顶层目录
```
--format
```
：输出格式，
```
rich
```
（默认）或
```
porcelain
```
/
```
porcelain-z
```
（适用于脚本）
```
--no-cache
```
：仅在内存中运行，不读取/写入索引缓存

Modes (pick the cheapest that works)

检索模式（选择资源消耗最低且满足需求的模式）

```
auto
```
: routes by file type (default)
```
name
```
: filename-only (fastest)
```
head
```
: first lines only (fast)
```
brief
```
: keyword summary (good for PRDs)
```
code
```
: code-aware chunking for
```
.py/.js/.ts
```
(best default for codebases)
```
outline
```
: Markdown headings/sections (best for docs)
```
full
```
: chunk full file contents (slowest, highest recall)

```
auto
```
：根据文件类型自动选择策略（默认）
```
name
```
：仅基于文件名检索（速度最快）
```
head
```
：仅检索文件开头内容（速度快）
```
brief
```
：基于关键词摘要检索（适用于PRD文档）
```
code
```
：针对
```
.py/.js/.ts
```
文件的代码感知分块检索（代码仓库的最佳默认选项）
```
outline
```
：基于Markdown标题/章节检索（文档检索的最佳选项）
```
full
```
：分块检索文件完整内容（速度最慢，召回率最高）

Troubleshooting

问题排查

Need ignored or hidden files: add
```
--include-hidden
```
and/or
```
--no-respect-gitignore
```
.
Scriptable output: use
```
--format porcelain
```
(TSV) or
```
--format porcelain-z
```
(NUL-delimited).
Get detailed help:
```
vexor search --help
```
.
Config issues:
```
vexor doctor
```
or
```
vexor config --show
```
diagnoses API, cache, and connectivity (tell the user to set up).

若需要检索被忽略或隐藏的文件：添加
```
--include-hidden
```
和/或
```
--no-respect-gitignore
```
参数。
若需要可脚本化的输出：使用
```
--format porcelain
```
（TSV格式）或
```
--format porcelain-z
```
（空字符分隔格式）。
获取详细帮助：执行
```
vexor search --help
```
。
配置问题：执行
```
vexor doctor
```
或
```
vexor config --show
```
诊断API、缓存和连接问题（请用户完成相关配置）。

Examples

使用示例

bash

undefined

bash

undefined

Find CLI entrypoints / commands

查找CLI入口/命令

vexor search "typer app commands" --top 5


```bash

vexor search "typer app commands" --top 5


```bash

Search docs by headings/sections

根据标题/章节检索文档

vexor search "user authentication flow" --path docs --mode outline --ext .md --format porcelain


```bash

vexor search "user authentication flow" --path docs --mode outline --ext .md --format porcelain


```bash

Locate config loading/validation logic

定位配置加载/验证逻辑

vexor search "config loader" --path . --mode code --ext .py


```bash

vexor search "config loader" --path . --mode code --ext .py


```bash

Exclude tests and JavaScript files

排除测试文件和JavaScript文件

vexor search "config loader" --path . --exclude-pattern tests/** --exclude-pattern .js

undefined

vexor search "config loader" --path . --exclude-pattern tests/** --exclude-pattern .js

undefined

Tips

使用技巧

First time search will index files (may take a minute). Subsequent searches are fast. Use longer timeouts if needed.
Results return similarity ranking, exact file location, line numbers, and matching snippet preview.
Combine
```
--ext
```
with
```
--exclude-pattern
```
to focus on a subset (exclude rules apply on top).

首次检索会对文件建立索引（可能需要一分钟）。后续检索速度会很快。必要时可设置更长超时时间。
检索结果会返回相似度排名、精确文件位置、行号和匹配代码片段预览。
可将
```
--ext
```
与
```
--exclude-pattern
```
结合使用以聚焦特定文件子集（排除规则优先级更高）。