Deeplinks Support

Vyre IDE supports custom OS-level URL protocols. Learn how to trigger agent runs, open specific files, or configure workspaces directly using `vyre://` deeplinks from web browsers, Slack, or documentation pages.

URL Protocol

Vyre registers the vyre:// protocol on installation. When clicked, these links open Vyre IDE and trigger the requested actions.

The general structure of a Vyre deeplink is:

code
vyre://[action]?[parameters]

Action Types

ActionParametersDescription
openpath, lineOpen a local file at a specific line.
agenttask, projectLaunch an agent task in a given folder.
cloneurlClone a git repository and open it.
settingspageNavigate to a specific IDE settings screen.

Common Integrations

CLI Link Trigger

You can also trigger deeplinks from the terminal shell via the CLI:

bash
vyre open-link "vyre://open?path=src/main.ts&line=12"
Browser Warnings

When opening vyre:// links from browser environments, a system prompt asking "Open Vyre?" is typically shown for security reasons. Users must accept to proceed.

Security Restrictions

To prevent malicious execution, Vyre blocks dangerous command flags when launched via deeplinks. Tasks containing write operations always require manual user confirmation before starting.