sigildocs

(sigil docs search)

(sigil docs search) - Documentation Search

Provides search functionality across all module documentation. Used by MCP tools and REPL commands.

(import (sigil docs search))

;; Search for symbols by name or description
(search-docs "string split")
;; => list of search results

;; Search within a specific module
(search-docs "read" module: "(sigil io)")

Exports

search-resultprocedure

Construct a search-result struct.

Test if a value is a search-result struct.

Get the name field of a search-result struct.

Get the module field of a search-result struct.

Get the kind field of a search-result struct.

Get the summary field of a search-result struct.

Clear the search index cache.

search-docsprocedure

Search documentation for symbols matching a query.

Query can be a symbol name or keywords from the description. Results are sorted with exact/prefix matches first.

Options:

  • module: Limit search to a specific module (e.g., "(sigil string)")
  • limit: Maximum number of results (default: 20)
(search-docs "string split")
(search-docs "read" module: "(sigil io)")

List all available modules.

Returns a list of module name strings.

Get all exports from a module.

Returns a list of search-result structs for each export.