Overview

Sliprail extensions add commands and workflows to the desktop launcher. Extension code runs in Sliprail's Electron main process and can use Node.js built-in modules together with capabilities exposed through the shortcut context.

Core Technologies

• JavaScript or TypeScript - Sliprail loads an ES module selected by manifest.json. TypeScript projects must build to JavaScript before loading
• Node.js APIs - Extensions can use Node.js built-in modules for files, processes, networking, and other system tasks
• Sliprail SDK types - @sliprail/sdk provides TypeScript definitions for extension objects, shortcuts, settings, windows, AI access, activities, and the shortcut context
• Shortcut context - Runtime capabilities such as clipboard access, notifications, file selection, windows, storage, and logging are passed to shortcut handlers through context

The SDK package is primarily a type package. Import SDK declarations with import type and use the runtime methods supplied by Sliprail through the context object.

For the complete type reference, open the API documentation.

Extension Requirements

A loadable extension needs:

• A registered extension ID
• A valid manifest.json
• A JavaScript or ES module file referenced by the manifest's main field
• A default export that matches the SDK Extension type
• Bundled third-party dependencies when external packages are used

Continue with the Developer Quick Start and Creating Your First Extension.