Spotlight# PRO

Spotlight lets scripts add their own resources to the system Spotlight index. When the user taps one of those results, Scripting runs the same script's spotlight.tsx file.

Spotlight indexing requires Scripting PRO.

#Index Items

await Spotlight.index({
  id: "note-42",
  title: "Project Notes",
  subtitle: "Pinned note",
  description: "Open the project note from Spotlight.",
  keywords: ["notes", "project"],
  parameters: {
    noteID: "42",
    source: "spotlight"
  }
})

id is local to the current script. Calling Spotlight.index again with the same id updates the existing item.

await Spotlight.indexItems([
  {
    id: "task-1",
    title: "Follow up"
  },
  {
    id: "task-2",
    title: "Send invoice",
    parameters: { invoiceID: "2026-001" }
  }
])

#Handle Taps

Create a spotlight.tsx file in the script project:

const item = Spotlight.current

if (item) {
  console.log(item.id)
  console.log(JSON.stringify(item.parameters))
}

Spotlight.current is null in other script environments. It is available when spotlight.tsx is launched from a Spotlight result.

Spotlight tap parameters are not exposed through Script.queryParameters.

#Manage Items

const items = await Spotlight.getItems()

await Spotlight.delete("note-42")
await Spotlight.deleteItems(["task-1", "task-2"])
await Spotlight.deleteAll()

Users can also manage indexed items from Tools > Spotlight, including deleting entries whose script or spotlight.tsx file no longer exists.