{"id":25629798,"url":"https://github.com/LitoMore/raycast-cross-extension-conventions","last_synced_at":"2026-06-10T14:30:20.164Z","repository":{"id":239865249,"uuid":"800760269","full_name":"LitoMore/raycast-cross-extension-conventions","owner":"LitoMore","description":"Defines the development approach for cross-extension in Raycast","archived":false,"fork":false,"pushed_at":"2024-12-20T09:33:07.000Z","size":51,"stargazers_count":21,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-02-19T21:35:56.701Z","etag":null,"topics":["conventions","cross-extension","extensions","raycast"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"cc0-1.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/LitoMore.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"github":"LitoMore"}},"created_at":"2024-05-15T00:13:45.000Z","updated_at":"2025-01-29T19:48:39.000Z","dependencies_parsed_at":"2024-05-15T21:04:11.543Z","dependency_job_id":"2c01a012-ed8b-44b9-ab54-3b0bf4469d5f","html_url":"https://github.com/LitoMore/raycast-cross-extension-conventions","commit_stats":null,"previous_names":["litomore/raycast-cross-extension-conventions"],"tags_count":5,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/LitoMore%2Fraycast-cross-extension-conventions","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/LitoMore%2Fraycast-cross-extension-conventions/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/LitoMore%2Fraycast-cross-extension-conventions/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/LitoMore%2Fraycast-cross-extension-conventions/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/LitoMore","download_url":"https://codeload.github.com/LitoMore/raycast-cross-extension-conventions/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":240222497,"owners_count":19767467,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["conventions","cross-extension","extensions","raycast"],"created_at":"2025-02-22T19:17:42.085Z","updated_at":"2026-06-10T14:30:18.067Z","avatar_url":"https://github.com/LitoMore.png","language":"TypeScript","funding_links":["https://github.com/sponsors/LitoMore"],"categories":["TypeScript"],"sub_categories":[],"readme":"# Raycast Cross-Extension Conventions\n\nDefines the development approach for cross-extension in Raycast\n\n[![raycast-cross-extension-badge]][raycast-cross-extension-link]\n\n## Background\n\nRaycast has tons of extensions so far. But most of them are standalone, it’s hard to use their ability from other extensions.\n\n## Install\n\n```shell\nnpm i raycast-cross-extension\n```\n\n## Usages\n\n### Consumer Usage\n\nAdd your target extension handle to the `crossExtensions` list of package.json.\nThis field allows providers to get to know who is using their extension. See [maintenance](#maintenance).\n\n```json\n{\n\t\"crossExtensions\": [\"target-extensions-author-name/target-extension-name\"]\n}\n```\n\nWe recommend always using the `crossLaunchCommand()` API to launch cross-extensions even your extension doesn't use the callback launch feature.\n\nYou may need to catch exceptions from `crossLaunchCommand()` if the target command is not installed.\nThe [`open()`](https://developers.raycast.com/api-reference/utilities#open) redirects to the Store when `crossLaunchCommand()` errored.\n\n#### Example\n\n```typescript\nimport { LaunchType, open } from \"@raycast/api\";\nimport { crossLaunchCommand } from \"raycast-cross-extension\";\n\ncrossLaunchCommand({\n\tname: \"target-command-name\",\n\ttype: LaunchType.UserInitiated,\n\textensionName: \"target-extension-name\",\n\townerOrAuthorName: \"target-extension-author-name\",\n\tcontext: {\n\t\tfoo: \"foo\",\n\t\tbar: \"bar\",\n\t},\n}).catch(() =\u003e {\n\topen(\n\t\t\"raycast://extensions/target-extension-author-name/target-extension-name\",\n\t);\n});\n```\n\n### Provider Usage\n\nIncoming parameters can be received from [`LaunchContext`](https://developers.raycast.com/api-reference/command#launchcontext).\n\nThe `callbackLaunchOptions` is used for running the callback `launchCommand()` to the source extension.\n\nPlease note passing parameters through [`Arguments`](https://developers.raycast.com/information/lifecycle/arguments) is not recommneded since it supports string only.\n\nBut a command with arguments is still useful if you want to reuse your existing arguments-based commands as the cross-extension entrance.\nFor example, the [Say](https://raycast.com/litomore/say) extension is using the `typeToSay` arguments-based command for receiving cross-extension parameters.\n\n#### Example\n\n```typescript\nimport { LaunchProps } from \"@raycast/api\";\nimport { callbackLaunchCommand, LaunchOptions } from \"raycast-cross-extension\";\n\ntype LaunchContext = {\n\tfoo?: string;\n\tbar?: string;\n\tcallbackLaunchOptions?: LaunchOptions;\n};\n\nexport default function Command({\n\tlaunchContext = {},\n}: LaunchProps\u003c{ launchContext?: LaunchContext }\u003e) {\n\tconst { foo, bar, callbackLaunchOptions } = launchContext;\n\t// ...\n\tcallbackLaunchCommand(callbackLaunchOptions, {\n\t\tresult: \"hello, world\",\n\t});\n}\n```\n\n## API\n\n### crossLaunchCommand(options, callbackOptions?)\n\n#### options\n\nType: `LaunchOptions`\n\nOptions for launch the target command.\n\n#### callbackOptions\n\nType: `Partial\u003cLaunchOptions\u003e | false`\n\nOptional. Options for launch the callback command. It will be used in the callback stage with default values below:\n\n- `name` defaults to `environment.commandName`\n- `extensionName` defaults to `environment.extensionName`\n- `ownerOrAuthorName` defaults to `environment.ownerOrAuthorName` or the field in `package.json`\n- `type` defaults to `LaunchType.UserInitiated`\n\nYou can set it to `false` to disable command callback.\n\n### callbackLaunchCommand(options, payload?)\n\n#### options\n\nType: `LaunchOptions`\n\nPass in `launchContext.callbackLaunchOptions`. This is used to load options for callback.\n\n#### payload\n\nType: `LaunchOptions['context']`\n\nOptional. Context data for sending back to consumer command.\n\n## Maintenance\n\nWhen you make breaking changes, keep an eye out for other projects using your API.\n\nYou can search for your extension handle `your-author-name/your-extension-name` from the [`raycast/extensions`](https://github.com/search?q=repo%3Araycast%2Fextensions+language%3AJSON+crossExtensions\u0026type=code) to find that extension using your extension.\n\n## Badges\n\nShow the world your extension implemented Cross-Extension.\n\n[![raycast-cross-extension-badge]][raycast-cross-extension-link]\n\n```markdown\n[![](https://shields.io/badge/Raycast-Cross--Extension-eee?labelColor=FF6363\u0026logo=raycast\u0026logoColor=fff\u0026style=flat-square)](https://github.com/LitoMore/raycast-cross-extension-conventions)\n```\n\n## Who's using Cross-Extension\n\n### Consumers\n\n- [Badges - shields.io](https://raycast.com/litomore/badges) - Concise, consistent, and legible badges\n- [Cursor Directory](https://raycast.com/escwxyz/cursor-directory) - Your cursor.directory in Raycast\n- [Pomodoro](https://www.raycast.com/asubbotin/pomodoro) - Pomodoro extension with menu-bar timer\n- [Steam](https://raycast.com/KevinBatdorf/steam) - Search and view any Steam games\n- [United Nations](https://raycast.com/litomore/united-nations) - Peace, dignity and equality on a healthy planet\n\n### Providers\n\n- [Brand Icons - simpleicons.org](https://raycast.com/litomore/simple-icons) - Browse, search, and copy free SVG icons for popular brands\n- [Color Picker](https://raycast.com/thomas/color-picker) - A simple system-wide color picker\n- [Cursor](https://raycast.com/degouville/cursor-recent-projects) - Control Cursor, Cursor \u0026 Codium directly from Raycast\n- [Do Not Disturb](https://raycast.com/yakitrak/do-not-disturb) - Disable notifications on your Apple devices\n- [PM2](https://raycast.com/litomore/pm2) - Manage even run your Node.js processes through Raycast\n- [ProtonDB](https://raycast.com/litomore/protondb) - Game information for Proton, Linux, Steam Deck, and SteamOS\n- [Raycast Port](https://raycast.com/litomore/raycast-port) - Allows you to use Raycast features out of Raycast\n- [Raycast Notification](https://raycast.com/maxnyby/raycast-notification) - Makes it easy to display notifications via a quicklink\n- [Say - Text to Speech](https://raycast.com/litomore/say) - macOS built-in TTS interface\n- [SteamGridDB](https://raycast.com/litomore/steamgriddb) - Browse SteamGridDB images in Raycast\n\n### Utilities\n\n- [raycast-hid](https://github.com/LitoMore/raycast-hid) - Access USB HID devices from Raycast\n- [raycast-notifier](https://github.com/LitoMore/raycast-notifier) - Send cross platform native notifications using Raycast\n- [raycast-pm2](https://github.com/LitoMore/raycast-pm2) - PM2 utilities for Raycast Extensions\n\n## License\n\nCC0-1.0\n\n[raycast-cross-extension-badge]: https://shields.io/badge/Raycast-Cross--Extension-eee?labelColor=FF6363\u0026logo=raycast\u0026logoColor=fff\u0026style=flat-square\n[raycast-cross-extension-link]: https://github.com/LitoMore/raycast-cross-extension-conventions\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FLitoMore%2Fraycast-cross-extension-conventions","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FLitoMore%2Fraycast-cross-extension-conventions","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FLitoMore%2Fraycast-cross-extension-conventions/lists"}