Modules§
Structs§
- File
Collection Options - Configuration for file collection during indexing and search operations. This struct encapsulates all settings related to which files should be included or excluded when traversing a directory tree.
- File
Metadata - Include
Pattern - Json
Search Result - Jsonl
Search Result - Search
Options - Search
Result - Search
Results - Enhanced search results that include near-miss information for threshold queries
- Search
Signals - Span
Enums§
Constants§
- INDEX_
DIR_ ENV - Environment variable that relocates ck’s per-root index directories out of
the source tree. See
index_dir.
Functions§
- build_
exclude_ patterns - Build exclusion patterns with proper priority ordering
- check_
index_ root_ marker - Verify that an existing relocated index directory belongs to
root. - compute_
chunk_ hash - Compute blake3 hash of chunk content for incremental indexing This enables us to detect which chunks have changed and only re-embed those
- compute_
file_ hash - create_
ckignore_ if_ missing - Create .ckignore file with default content if it doesn’t exist
- get_
default_ ckignore_ content - Get default .ckignore file content
- get_
default_ exclude_ patterns - Get default exclusion patterns for directories that should be skipped during search. These are common cache, build, and system directories that rarely contain user code.
- get_
sidecar_ path - index_
dir - Returns the directory that holds ck’s index and sidecar files for a search root.
- index_
exists - Returns
trueif the index directory forroot(seeindex_dir) exists. - read_
ckignore_ patterns - Read and parse .ckignore file, returning patterns
- write_
index_ root_ marker - Record which search root a relocated index directory belongs to.