Overview

A connector lets Gety index content from a source outside your normal local file index, such as a web service, an internal tool, or another workflow.

What connectors are for

Gety searches files on your computer. A connector adds another searchable source. It pulls records from that source, turns them into searchable documents, and sends them to Gety on a schedule.

Use a connector when you want to:

• Search external tools together with your local files
• Keep source data in place instead of copying it into files
• Give AI tools connected to Gety more local search context

Install only trusted connectors

A connector is code that runs locally on your computer. It reads the configuration values you enter for it, and it can use the network, files, and programs that its permissions allow.

Most connectors run in a sandbox: they can only do what their author declares in the connector's manifest, and you review those permissions before you install. A connector that declares no permissions runs with full access to everything you can access. See Review permissions.

Install only connectors you trust

Only install connectors from sources you trust. Before installing, check what source the connector accesses and which permissions it requests. A connector can send the data it reads to any host its permissions allow. Gety itself doesn't upload connector data to Gety servers.

Install a connector

note

Featured connectors, installing from GitHub or npm, and the permission review require Gety 0.7.0 or later.

Open Gety → Settings → Connectors. Under Install Connector, choose how to install:

Option	Use it to install
Featured connectors	A connector from Gety or the community, picked from a list
Install from remote	A connector published as a GitHub release or an npm package
Install from local folder	A connector folder on your computer, such as one you're building

Every option shows the same permission review before Gety installs anything. After you allow the permissions, fill in any configuration fields the connector needs, such as an API key, and click Install. Gety then starts indexing in the background.

Install a featured connector

1. Click Featured connectors.
2. Choose the Official tab for connectors maintained by Gety, or the Community tab for connectors published by other authors.
3. Click Install next to the connector you want.
4. Review its permissions, fill in its configuration, and click Install.

Each entry shows the connector's version and when it was published. Gety installs exactly that version from npm. After installation, it's an npm connector like any other, so you can update it when its author publishes a newer version. See Update a connector.

Community entries show the author's GitHub avatar and name. Click them to open the author's GitHub profile. Gety maintainers review each listed version before it appears, but a community connector is still its author's code, and it can request full access. Check its permissions before you install it.

Can't find the connector you need? Click Build and publish your own at the bottom of the Community tab, or see Build a connector.

Gety maintains these official connectors:

Connector	npm package	What it indexes
Linear	@gety-connectors/linear	Cloud Linear issues as Markdown documents, with optional comments.
Codex	@gety-connectors/codex	Local Codex session JSONL logs as Markdown documents.
Google Chrome	@gety-connectors/chrome	Local Chrome bookmarks and browsing history.
Claude Code	@gety-connectors/claude-code	Local Claude Code session JSONL logs as Markdown documents, with optional subagent sessions.
Notion	@gety-connectors/notion	Notion pages shared with your integration, as Markdown documents.
Feishu (Lark)	@gety-connectors/lark	Feishu and Lark cloud documents and chat history, through a locally authenticated lark-cli.

Install from GitHub or npm

1. Click Install from remote.
2. Choose the GitHub or npm tab and enter the connector's address.
3. Click Continue.
4. Review its permissions, fill in its configuration, and click Install.

Source	Accepted addresses	Installs by default
GitHub	owner/repo, a repository link such as https://github.com/owner/repo, or a release link such as https://github.com/owner/repo/releases/tag/v1.2.0	The repository's latest release
npm	name, @scope/name, name@version, or a package page link such as https://www.npmjs.com/package/name	The package's latest version

To install another version, such as a pre-release, enter the link of that release on GitHub, or name@version for npm.

The GitHub repository or npm package must be public, and its author must publish it following Gety's publishing convention. Gety downloads the connector into its own folder, checks the download, and runs the connector from there.

Install from a local folder

1. Click Install from local folder.
2. Select the folder that contains the connector's manifest.json. If you downloaded the connector as a ZIP file, unzip it first.
3. Review its permissions, fill in its configuration, and click Install.

Gety runs the connector's code from that folder, so keep the folder in place. After you rebuild the connector's code, click More actions (⋯) → Restart to load it. Gety reads manifest.json only when you install, so after you change the manifest, delete the connector and install it again.

Review permissions

Before installing, Gety shows Review name Permissions. The dialog shows where the connector comes from (a GitHub repository and release, an npm package and version, or a local folder) and lists what the connector may do, grouped under Network, File System Read, Environment Variables, and Run Programs.

• For a sandboxed connector, Permissions not listed here are denied by default.
• A permission marked From the "field" setting follows the value you enter in that configuration field. If you change the field later, the access changes with it, without another review.
• The color shows the risk: green when the connector only reaches the listed hosts or reads the listed folders, yellow for high-risk access, and red for full access.

Gety asks you to confirm again, with Grant high-risk access?, before you can install a connector that:

• Runs programs. Programs a connector runs aren't limited by the sandbox and can access what you can access.
• Can communicate with any host, so data can be sent anywhere.
• Can read all files in your home folder.
• Declares no permissions. Gety shows This connector runs without a sandbox and can access everything you can access.

If you click Cancel at any step, Gety installs nothing and saves none of the settings you entered.

To check an installed connector's permissions later, click the Permissions shield on its row. The shield is yellow for high-risk connectors and red for connectors with full access. Connectors that don't declare permissions, including connectors you installed before Gety 0.7.0, keep running with full access.

Know what every sandboxed connector can do

Every sandboxed connector has some access it doesn't need to declare. The review dialog doesn't list it. A sandboxed connector can always:

• Read its own code.
• Read and write its own data folder, which persists between syncs, and a temporary folder that Gety deletes after each sync.
• Read the TMPDIR, TMP, and TEMP environment variables, which point to that temporary folder.
• Read basic system information: your home folder path, processor count, memory, operating system version, uptime, system load, and disk space.
• Use its own local storage and cache.

A sandboxed connector can never write files outside those folders, load native libraries, read your computer's name, network interfaces, or user account, or load code from outside its installed package.

Manage installed connectors

Your connectors are listed under Installed Connectors, with their version and sync status. Each row has these controls:

Control	What it does
Permissions	Shows the permissions the connector has.
Configure	Changes the connector's configuration and sync schedule.
More actions (⋯)	Opens a menu with the actions below.
Switch	Enables or disables the connector. A disabled connector doesn't sync, and Gety keeps its configuration.

The More actions (⋯) menu lists:

Action	What it does
Sync now	Runs a sync immediately, without waiting for the next scheduled sync.
Restart	Stops the connector and starts it again. Use it when a connector appears stuck, or after you rebuild a connector installed from a local folder.
Manage versions	Updates the connector or switches it to another version. Only for connectors installed from npm. See Update a connector.
Rebuild index	Deletes the connector's documents and syncs everything again. See Rebuild the index.
Delete	Uninstalls the connector and permanently deletes all its indexed data. For a connector installed from GitHub or npm, Gety also deletes its copy of the code. A local folder stays in place.

Restart and Rebuild index appear only while the connector is enabled. Sync now appears only while the connector is enabled and running, and isn't already syncing.

If Gety can't load a connector, its row shows the reason and a Delete button instead.

Configure a connector

Connectors with required configuration fields, such as an API key, a server URL, or a folder path, must be configured before installation completes. To change the configuration later, click Configure on the connector's row, edit the fields, and save. Gety saves the configuration and restarts the connector.

Choose a sync schedule

Each connector declares its default schedule. To change it, click Configure and choose a Sync schedule:

Schedule	Behavior
Manual	Only syncs when you click More actions (⋯) → Sync now.
Interval (seconds)	Syncs repeatedly after a fixed number of seconds, such as every 3600 seconds.
Daily	Syncs once a day at the Daily time (HH:mm:ss) you set, in your local time.

Rebuild the index

If a connector's results stay wrong or incomplete after a sync, click More actions (⋯) → Rebuild index. Gety deletes all documents of this connector, then syncs everything again from the start. Search results may be incomplete until it finishes.

Update a connector

Gety manages versions of connectors installed from npm, including featured connectors. Each time you open the Connectors settings page, Gety checks them for updates. Click Check for updates to check again. When an update is available, a dot appears on More actions (⋯), and hovering over it shows Update version available. Gety doesn't install updates automatically.

To update a connector or switch to another version:

1. Click More actions (⋯) → Manage versions.
2. Select a version. Gety shows its Release notes and what switching changes.
3. Click Switch to this version.

The version list uses these labels:

Label	Meaning
Current	The version the connector runs.
Latest	The version the author marked as latest on npm.
Pre-release	A preview version, such as 1.3.0-beta.1.
Deprecated	The author withdrew this version. You can still switch to it.
Needs Gety version	This version needs a newer Gety. Update Gety first.
Unusable	This version doesn't follow the connector publishing convention and can't be installed.

Gety offers the highest version that is newer than yours, isn't a pre-release or deprecated, and works with your Gety version as the update. To install a pre-release or an older version, select it in the list.

When you switch versions:

• Your settings carry over. If the new version adds a required setting, removes a setting, or resets one to its default, Gety lists it before you switch and asks you to fill in what's needed.
• If the new version needs more permissions, you review the added permissions before switching.
• Synced documents are kept. When you downgrade, or when the new version changes its sync format or indexed fields, Gety deletes the connector's documents and syncs from scratch. Gety tells you before you switch.
• The connector's own data folder is kept.
• If downloading or checking the new version fails, the connector stays on its current version. If Gety shows Switched to version, but it failed to start, the new version is already installed. Click More actions (⋯) → Restart to start it again.

Connectors installed from GitHub or a local folder don't have version management. To move a GitHub connector to another release, delete it and install that release. For a local folder, update the code in the folder and click More actions (⋯) → Restart.

Troubleshooting

The connector won't install

The install dialog shows the reason. Common causes:

• This connector is already installed. Gety identifies a connector by the ID in its manifest, whatever source it comes from. To install the same connector from another source, for example from Featured connectors instead of a folder you downloaded before, delete the installed one first.
• This version needs Gety version or newer. Update Gety, or install an older version of the connector.
• The release or package doesn't follow the connector publishing convention. Report the message to the connector's author.
• For a local folder, make sure you selected the connector's root folder, which is the folder that contains manifest.json.

The connector has no results

• Confirm the connector is enabled.
• Check that all required configuration fields are filled in correctly, especially API keys.
• Click More actions (⋯) → Sync now, wait for the sync to finish, and search again.
• If the status shows a permission error, see A sync fails with a permission error.

Results are out of date

Click More actions (⋯) → Sync now to run a sync. If the connector still appears stuck, click More actions (⋯) → Restart. If results stay wrong after a sync, rebuild the index.

A sync fails with a permission error

The connector tried to do something its permissions don't allow. The status shows what, for example permission denied: net access to "api.example.com:443" is not granted by the connector's manifest.

If the permission comes from a configuration field, such as a server URL, check the value you entered. Otherwise, report the message to the connector's author. The author needs to declare the permission and publish a new version.

A search result doesn't open

For your security, Gety doesn't open these document links from connectors:

• Files inside any connector's folders, including its code and data folders. Gety shows For your security, Gety doesn't open files inside connector folders.
• Files that don't exist.
• file: links that name another computer instead of a local path.
• On Windows, files that aren't on a local drive.

To find a file inside a connector's folder, use Open file directory instead.

The connector indexes different content than expected

If the indexed content doesn't match what you expect, report an issue to the connector author. Include the connector version, configuration that is safe to share, what you expected, and an example of the unexpected result.

Build your own connector

Need a source Gety doesn't cover yet? See Build a connector.