Share / Import plugins

Looking to share plugins or import shared plugins? This guide will provide the easiest steps to do so.

Share a plugin

Click on the “Share” button on the top right corner of the plugin (under the three dots menu).

To share a plugin via GitHub (check this repo as an example):

implementation.js: this file contains the JS code, it is only required if you use Javascript code implementation. It must contain a function with the name as same as the id in plugin.json file

plugin.json: a JSON file containing all configs of the plugin, please check this guide to understand more. It has the following properties:

version: number, for other users to notice to update
uuid: string, this is the unique id to distinguish plugins
iconURL: string
emoji: string, this will be used if iconURL is not available
title: string, the displayed name of the plugin
userSettings: JSON string, check details in this guide
openaiSpec: JSON string, check details in this guide
implementationType: string, "http" or "javascript"
httpAction: JSON string, required if the implementation is HTTP, check details in this guide

id: string, uuid preferred
method: string, the request method
url: string
hasHeaders: boolean
requestHeaders: JSON, required if hasHeaders is true
hasBody: boolean
requestBody: JSON, required if hasBody is true
requestBodyFormat: string, "json" or "form-data"
hasResultTransform: boolean
resultTransform: object, required if hasResultTransform is true, its shape is either of these:

json
{
  "engine": "handlebars",
  "templateString": "string template value"
}

json
{
  "engine": "jmes",
  "expression": "string expression value"
}

outputType: string, "render_markdown" or "respond_to_ai" or "render_html"

Find a plugin you'd like to use? Import it with these easy steps:

To import a plugin using its URL, follow these steps:

To import a plugin using its URL, follow these steps:

Generate a new GitHub personal access token (https://github.com/settings/tokens?type=beta). There are 2 types of tokens:

Fine-grained token (Recommended): Select that private repo and set Contents permission to Read-only

b. Classic token: select the scope repo

Another way of importing a shared plugin is to use a direct import. Here's how:

Click the “Import to TypingMind” button to import to the app and use it effortlessly