Comprehensive documentation for the mdfind-node library
Each macOS Spotlight command has its own dedicated documentation:
- mdfind - File search functionality
- mdls - Metadata listing
- mdutil - Index management
- mdimport - File import and plugin management
- Query Builder - Type-safe query construction
- Basic search operations
- Advanced query patterns
- Content type filtering
- Date and time queries
- Size and metadata filters
- Camera and image properties
- Music and audio attributes
- Batch Operations - Running multiple operations
- Extended Metadata - Working with EXIF, XMP, and basic metadata
- Content Types - Understanding Spotlight's type system
- Attribute Discovery - Finding and using metadata attributes
- Advanced Topics
- Performance optimization and memory management
- Error recovery and resilience patterns
- Integration with other tools
- Security considerations
- Testing strategies
- Troubleshooting guide
- Migration from raw commands
The examples directory contains working code samples demonstrating various features:
- basic.ts - Basic search operations
- query-builder.ts - Query builder basics
- live-search.ts - Live search monitoring
- advanced.ts - Advanced search patterns
- advanced-search.ts - Complex search scenarios
- batch.ts - Batch operations
- date-queries.ts - Date-based queries
- date-queries-live.ts - Live date monitoring
- metadata.ts - Basic metadata handling
- extended-metadata.ts - Extended metadata operations
- content-types.ts - Content type operations
- discover.ts - Attribute discovery
- mdimport.ts - Import operations
- mdutil-status.ts - Index status checking
- mdutil-advanced.ts - Advanced index management
- remove-from-spotlight.ts - Excluding content from Spotlight
See the examples directory for the complete collection of working code samples.