limelight

KO | EN

gitlite — search

#chatgpt #java #php #graphql #svg #kotlin #web #macos #proxy #swift

(★ 10)

No description available.

File Explorer

ZIP Download

- - README.md
  - spotlight_index_client.py
- - package-lock.json
  - package.json
  - README.md
  - tsconfig.json
  - tsconfig.test.json
- - limelight-hero.png
- API.md
- CAPABILITY_MATRIX.md
- INSTALLATION.md
- PROVIDERS.md
- PYTHON_CLIENT.md
- TYPESCRIPT_CLIENT.md
- - [email protected]
- - Info.plist.in
  - Limelight.entitlements.plist
- dmg-layout.conf
- ensure-local-signing-identity.sh
- generate-capability-matrix.sh
- install-local-app.sh
- package-release.sh
- probe-acceptance.sh
- probe-files.sh
- verify-todo-complete.sh
- - AppIconLookup.swift
  - main.swift
  - PermissionsWindowController.swift
  - RecentSearchesWindowController.swift
  - SettingsWindowController.swift
  - StatusBarApp.swift
  - UpdateService.swift
  - VersionUtils.swift
- - APIHealthModels.swift
  - APIItemModels.swift
  - APIOCRExtractionModels.swift
  - APIProviderModels.swift
  - APIRecordModels.swift
  - APISearchModels.swift
  - ContactsProvider.swift
  - CoreSpotlightAppEntityProvider.swift
  - EntityExtractor.swift
  - JSONValue.swift
  - LocalCalendarProvider.swift
  - LocalRemindersProvider.swift
  - MailSQLiteProvider.swift
  - MessagesSQLiteProvider.swift
  - NotesSQLiteProvider.swift
  - PermissionBootstrapper.swift
  - PhotosAssetResolver.swift
  - PhotosSQLiteProvider.swift
  - ProviderCatalog.swift
  - ProviderReadinessDetector.swift
  - SafariHistoryProvider.swift
  - SearchProvider.swift
  - SpotlightFileProvider.swift
  - SpotlightHTTPServer.swift
  - SpotlightMetadataReader.swift
  - SpotlightQueryBuilder.swift
  - SpotlightRecordNormalizer.swift
  - SpotlightSearchService.swift
  - SQLiteDatabase.swift
  - TextOCRService.swift
- - FallbackProviderTests.swift
  - HTTPRequestTests.swift
  - MockMetadataReader.swift
  - SpotlightQueryBuilderTests.swift
  - SpotlightRecordNormalizerTests.swift
  - SpotlightSearchServiceIntegrationTests.swift
  - TextOCRServiceTests.swift
.gitignore
Makefile
Package.swift
README.md

# Use via CDN

jsDelivr

jsDelivr serves any public GitHub repository as a CDN with zero setup. Pick a version and a file to get a ready-to-paste link and snippet.

Version

File

Link

Example

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

Limelight gives Codex and local agents a searchable window into your Mac's context: files, photos, mail, messages, notes, calendar, contacts, reminders, and Safari history.

It runs locally on your Mac and exposes a small loopback HTTP API so any agent or model can utilise it.

![Limelight preview](https://raw.githubusercontent.com/b-nnett/limelight/main/docs/assets/limelight-hero.png)

## Contents

- [Install](#install)
- [Use With Codex](#use-with-codex)
- [Use With Agents](#use-with-agents)
- [What It Can Search](#what-it-can-search)
- [Developer Quick Start](#developer-quick-start)
- [Documentation](#documentation)
- [Project Layout](#project-layout)

## Install

Download the latest pre-built `.dmg` from [GitHub Releases](https://github.com/b-nnett/limelight/releases), open it, and drag Limelight into your Applications folder.

After installing:

1. Launch Limelight.
2. Grant the macOS permissions it asks for.
3. Grant Full Disk Access to Limelight in System Settings for protected sources such as Mail, Messages, Notes, Safari, and some Calendar/Reminders stores.

Once running, Limelight listens on `127.0.0.1:8765` by default.

See [Installation](docs/INSTALLATION.md) for local development installs, signing, and LaunchAgent setup.

## Use With Codex

Install the [Limelight Codex Plugin](https://github.com/b-nnett/limelight-codex-plugin#install) to use Limelight directly from Codex.

## Use With Agents

Agents can query Limelight through its local HTTP API. A basic search looks like this:

```sh
curl -s http://127.0.0.1:8765/v1/search \
  -H 'X-Origin: Example Agent' \
  -H 'Content-Type: application/json' \
  -d '{"query":"passport","sources":["photos"],"types":["image"],"limit":5}'
```

For deeper integrations, see [API Reference](docs/API.md), the [Python client](docs/PYTHON_CLIENT.md), and the [TypeScript client](docs/TYPESCRIPT_CLIENT.md).

## What It Can Search

Limelight can search:

- files through native Spotlight metadata
- Photos library search/person indexes
- Contacts, Calendar, and Reminders through macOS frameworks and local fallbacks
- Notes, Mail, and Safari through local protected stores when Full Disk Access is granted

It does not persist a search cache and does not expose full document text by default. See [Providers](docs/PROVIDERS.md) for provider behavior, permissions, and caveats.

## Developer Quick Start

Requirements:

- macOS 14 or newer
- Swift 6 toolchain
- `jq` for probe scripts

Run the service directly:

```sh
swift run spotlight-index --host 127.0.0.1 --port 8765
```

Check that it is listening:

```sh
curl http://127.0.0.1:8765/health
```

Run tests:

```sh
swift test
```

Build a signed release DMG with `scripts/package-release.sh`.

Use the scripts in `scripts/` for validation probes, packaging, and local app builds.

## Documentation

- [Installation](docs/INSTALLATION.md): DMG install, local app install, signing, and LaunchAgent.
- [Providers](docs/PROVIDERS.md): searchable sources, permissions, readiness, and limitations.
- [API Reference](docs/API.md): endpoints, request examples, toolbox endpoints, and origin headers.
- [Capability Matrix](docs/CAPABILITY_MATRIX.md): generated local runtime provider capability snapshot.
- [Python Client](docs/PYTHON_CLIENT.md): dependency-free Python client for the local HTTP API.
- [TypeScript Client](docs/TYPESCRIPT_CLIENT.md): typed `fetch` client for Node 18+ and browsers.

## Project Layout

```text
Sources/SpotlightIndexCore/   Core search providers, HTTP API, models, and permission helpers
Sources/spotlight-index/      CLI entry point and menu bar app shell
Tests/                        Swift tests for query building, normalization, providers, and integration behavior
scripts/                      Local install, signing, probes, and validation utilities
clients/python/               Small Python SDK for the local HTTP API
clients/typescript/           TypeScript SDK for Node 18+ and browsers
docs/                         Installation, API, provider, development, and capability docs
```

limelight

Owner Repos

File Explorer

# Use via CDN

Was this content helpful?

Recent Feedback

limelight

Owner Repos

File Explorer

# Use via CDN

Was this content helpful?

Recent Feedback

Download README