Quick Start

The fastest way to create a Sliprail extension is to start from the official template.

Prerequisites

• Node.js 22 or later
• npm
• A GitHub account for public extensions
• Sliprail desktop with Developer Mode enabled for local testing

Use the Official Template

Extension Template: sliprail-extension-template

1. Create a repository from the template and clone it locally
2. Install the template's development dependencies as described in its README
3. Register an extension in the Sliprail Developer Portal and copy the extension ID
4. Update manifest.json with the registered ID, display name, description, icon, and built entry file
5. Implement at least one shortcut and build the project
6. In Sliprail Settings > Extensions, enable Developer Mode and choose Load Unpacked Extension
7. Select the directory containing manifest.json

Continue with Creating Your First Extension for a minimal manifest and implementation, then use Running and Debugging while iterating.