Docs

FAQ

Can my extension use native Node.js modules?

Native modules that require platform-specific compilation are not supported as portable Sliprail extension dependencies. Use JavaScript or TypeScript packages that can be bundled across supported operating systems.

What APIs are available?

Extensions can use Node.js built-in modules. Sliprail runtime capabilities are exposed through the shortcut context, including clipboard access, notifications, file selection, windows, storage, AI, activities, and debug logging. @sliprail/sdk provides the corresponding TypeScript definitions.

How do users discover my extension?

A public extension with Published status can appear in the Sliprail Store and SearchExtensions results. You can also share its store page or GitHub repository directly.

Do I need to handle dependencies myself?

Yes. Sliprail does not run npm install for extensions. Bundle every third-party runtime dependency into the generated JavaScript.

Why does my local extension fail to load?

Check that the ID is registered, all required manifest fields are present, the main file exists, and the entry module has a valid default export. The debug log contains the detailed loading error.

How are updates delivered?

GitHub extensions are updated from repository commits. Sliprail performs a daily automatic check for eligible extensions unless the user disables automatic updates, and the extension manager also provides a manual update action.