Docs

Running and Debugging

Use Developer Mode to load an extension directly from a local directory and reload it while developing.

Load an Unpacked Extension

  1. Open Sliprail Settings > Extensions
  2. Enable Developer Mode and accept the security warning
  3. Open the developer file menu
  4. Select Load Unpacked Extension
  5. Choose the directory containing manifest.json

Sliprail validates the registered ID, manifest fields, entry file, and default export. Loading errors are shown in the interface and written to the debug log.

After changing code, rebuild the entry file when necessary and select Reload Extensions in the Developer Mode controls.

Debug Logging

Use context.debugLog inside a shortcut or extension lifecycle handler.

handle: (context) => {
  context.debugLog('Shortcut started', {
    parameter: context.parameter,
  })
}

To open the log:

  1. Open Sliprail Settings
  2. Select Debug Log near the bottom of the settings window
  3. Sliprail opens the current log file with the default text editor

The log includes Sliprail and extension messages, so include a clear extension or shortcut name in each entry you write.

Common Loading Problems

  • The extension ID has not been registered
  • A required manifest field is missing
  • The main file does not exist
  • The entry module does not default-export an extension object
  • A third-party dependency was not bundled
  • A native Node.js dependency is incompatible with Sliprail's runtime