@janhq/inference-plugin v1.0.22
Jan inference plugin
Created using Jan app example
Create a Jan Plugin using Typescript
Use this template to bootstrap the creation of a TypeScript Jan plugin. 🚀
Create Your Own Plugin
To create your own plugin, you can use this repository as a template! Just follow the below instructions:
- Click the Use this template button at the top of the repository
- Select Create a new repository
- Select an owner and name for your new repository
- Click Create repository
- Clone your new repository
Initial Setup
After you've cloned the repository to your local machine or codespace, you'll need to perform some initial setup steps before you can develop your plugin.
You'll need to have a reasonably modern version of Node.js handy. If you are using a version manager like
nodenv
ornvm
, you can runnodenv install
in the root of your repository to install the version specified inpackage.json
. Otherwise, 20.x or later should work!
:hammer_and_wrench: Install the dependencies
npm install
:building_construction: Package the TypeScript for distribution
npm run bundle
:white_check_mark: Check your artifact
There will be a tgz file in your plugin directory now
Update the Plugin Metadata
The package.json
file defines metadata about your plugin, such as
plugin name, main entry, description and version.
When you copy this repository, update package.json
with the name, description for your plugin.
Update the Plugin Code
The src/
directory is the heart of your plugin! This contains the
source code that will be run when your plugin extension functions are invoked. You can replace the
contents of this directory with your own code.
There are a few things to keep in mind when writing your plugin code:
Most Jan Plugin Extension functions are processed asynchronously. In
index.ts
, you will see that the extension function will return aPromise<any>
.import { core } from "@janhq/core"; function onStart(): Promise<any> { return core.invokePluginFunc(MODULE_PATH, "run", 0); }
For more information about the Jan Plugin Core module, see the documentation.
So, what are you waiting for? Go ahead and start customizing your plugin!
6 months ago
6 months ago
6 months ago
6 months ago
6 months ago
6 months ago
6 months ago
6 months ago
6 months ago
6 months ago
6 months ago
6 months ago
7 months ago
7 months ago
7 months ago
7 months ago
7 months ago
7 months ago
7 months ago
7 months ago
7 months ago
7 months ago