Chercher dans un dossier de documentation

Ce guide montre comment chercher dans les fichiers texte d'un dossier — Markdown, AsciiDoc, texte brut — à la main avec /docs, ou en laissant le modèle chercher avec son outil search_docs avant de répondre. La recherche classe les passages avec BM25 et ne charge aucun modèle.

Chercher à la main

Activez la commande et nommez les dossiers, dans le YAML de l'agent :
```
docSearch:
  searchDocs: true
  dirs: [docs]
  extensions: [.md]
```

Lancez mm — le terminal, la fenêtre (mm -tui) ou un éditeur — et tapez les mots que vous cherchez :

/docs liststate

🔎 5 passage(s) for "liststate" — 10 file(s) in docs

── docs/04-lists.md:5 · Lists and selection › Keep the selection with ListState
## Keep the selection with ListState

`ListState` remembers which item is selected and how far the list is scrolled. …

Chaque passage commence par son lien, chemin:ligne, qu'un éditeur ouvre et que read_file lit. Le modèle n'est pas appelé et la conversation n'est pas modifiée.

Laisser le modèle chercher

Déclarez l'outil :

docSearch:
  autoSearchDocs: true
  dirs: [docs]
  extensions: [.md]

Dites au modèle, dans son prompt system, quand l'appeler et comment citer ce qu'il trouve. Ce qui a marché sur un modèle de 4B :

system: |
  For any question the documentation may cover, call search_docs first, with English
  words — type and function names work best. Answer from the passages it returns,
  and end with the link of the passage you used (path:line).

Les deux interrupteurs sont indépendants : searchDocs seul vous donne la commande et aucun outil au modèle ; autoSearchDocs seul l'inverse.

Variantes

Plusieurs dossiers, plusieurs formats. dirs: [docs, guides, /shared/handbook], extensions: [.md, .adoc, .txt]. Seules les extensions listées sont lues.
En ACP. Les dossiers relatifs sont résolus par rapport au cwd de la session : le projet ouvert dans l'éditeur.
Gros fichiers. Les fichiers au-delà de maxFileSize (1MB par défaut) sont ignorés ; augmentez la limite, ou découpez le fichier.
Questions dans une autre langue. La recherche porte sur les mots, pas sur le sens. Une documentation en anglais cherchée avec des mots français ne donne rien — demandez au modèle de chercher avec les mots de la documentation (voir le prompt ci-dessus), ce qu'un petit modèle a fait de façon fiable dans demos/docs-search/.

Voir aussi

Référence de la configuration — docSearch
Référence des commandes — /docs
Référence des outils — search_docs
Pourquoi la recherche dans la documentation fonctionne ainsi
demos/docs-search/ — une démo mesurée : un assistant qui répond à partir de neuf tutoriels Ratatui

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68


# Chercher dans un dossier de documentation

Ce guide montre comment chercher dans les fichiers texte d'un dossier — Markdown, AsciiDoc, texte brut — à la main avec `/docs`, ou en laissant le modèle chercher avec son outil `search_docs` avant de répondre. La recherche classe les passages avec BM25 et ne charge aucun modèle.

## Chercher à la main

1. Activez la commande et nommez les dossiers, dans le YAML de l'agent :

   ```yaml
   docSearch:
     searchDocs: true
     dirs: [docs]
     extensions: [.md]
   ```

2. Lancez mm — le terminal, la fenêtre (`mm -tui`) ou un éditeur — et tapez les mots que vous cherchez :

   ```text
   /docs liststate
   ```

   ```text
   🔎 5 passage(s) for "liststate" — 10 file(s) in docs

   ── docs/04-lists.md:5 · Lists and selection › Keep the selection with ListState
   ## Keep the selection with ListState

   `ListState` remembers which item is selected and how far the list is scrolled. …
   ```

Chaque passage commence par son lien, `chemin:ligne`, qu'un éditeur ouvre et que `read_file` lit. Le modèle n'est pas appelé et la conversation n'est pas modifiée.

## Laisser le modèle chercher

1. Déclarez l'outil :

   ```yaml
   docSearch:
     autoSearchDocs: true
     dirs: [docs]
     extensions: [.md]
   ```

2. Dites au modèle, dans son prompt `system`, quand l'appeler et comment citer ce qu'il trouve. Ce qui a marché sur un modèle de 4B :

   ```yaml
   system: |
     For any question the documentation may cover, call search_docs first, with English
     words — type and function names work best. Answer from the passages it returns,
     and end with the link of the passage you used (path:line).
   ```

Les deux interrupteurs sont indépendants : `searchDocs` seul vous donne la commande et aucun outil au modèle ; `autoSearchDocs` seul l'inverse.

## Variantes

- **Plusieurs dossiers, plusieurs formats.** `dirs: [docs, guides, /shared/handbook]`, `extensions: [.md, .adoc, .txt]`. Seules les extensions listées sont lues.
- **En ACP.** Les dossiers relatifs sont résolus par rapport au `cwd` de la session : le projet ouvert dans l'éditeur.
- **Gros fichiers.** Les fichiers au-delà de `maxFileSize` (`1MB` par défaut) sont ignorés ; augmentez la limite, ou découpez le fichier.
- **Questions dans une autre langue.** La recherche porte sur les mots, pas sur le sens. Une documentation en anglais cherchée avec des mots français ne donne rien — demandez au modèle de chercher avec les mots de la documentation (voir le prompt ci-dessus), ce qu'un petit modèle a fait de façon fiable dans `demos/docs-search/`.

## Voir aussi

- [Référence de la configuration](../reference/configuration.md#clés-de-docsearch) — `docSearch`
- [Référence des commandes](../reference/slash-commands.md) — `/docs`
- [Référence des outils](../reference/tools.md#search_docs) — `search_docs`
- [Pourquoi la recherche dans la documentation fonctionne ainsi](../explanation/document-search.md)
- `demos/docs-search/` — une démo mesurée : un assistant qui répond à partir de neuf tutoriels Ratatui