Module paths

Module paths 

Source
Expand description

Centralized index storage paths following XDG Base Directory Specification

Index storage location:

  • Linux: ~/.local/share/plaid/indices/
  • macOS: ~/Library/Application Support/plaid/indices/
  • Windows: C:\Users{user}\AppData\Roaming\plaid\indices\

Structs§

ParentIndexInfo
Information about a discovered parent index
ProjectMetadata
Metadata about the project stored alongside the index

Functions§

find_index_for_project
Find an existing index for a project path Returns None if no index exists
find_parent_index
Find if the given path is a subdirectory of any existing indexed project. Returns the most specific (longest-matching) parent index if found.
get_index_dir_for_project
Get the index directory for a project path Creates the directory structure if it doesn’t exist
get_plaid_data_dir
Get the base plaid data directory (XDG_DATA_HOME/plaid or platform equivalent)
get_state_path
Get the path to the state.json file within an index directory
get_vector_index_path
Get the path to the vector index within an index directory
index_exists
Check if an index exists for the given project