History

fix(magicoder): correct the id and update parameters (#1448 )

fix(capybara): change description + parameters

fix(codeninja): update description + add parameters

delete(magicoder): this model is failed to load due to gguf

fix(deepseek-1.3b): update description + add parameters

fix(deepseek-34b): update description + add parameters

fix(dolphin8x7b): update description + parameters

fix(llama2-chat-7b): update description + add parameters

fix(llama2-chat-70b): update description + add parameters

fix(mistral-7b): update description + add parameters

fix(mistral): degrade to v0.1 due to giberish output from v0.2

fix(mixtral): update desciption + parameters

fix(noromaid): update description + parameters

fix(mistral7b): correct the prompt template

update(openchat): add parameters

fix(openhermesneural): update parameter + description

fix(openhermesneural): update max_tokens

delete(pandora): remove pandora

fix(phi2): update parameter

update(phind34b): update description + change to q4 + add parameter

update(solar-slerp): update parameter

fix(starling): update description + parameter

fix(openchat): add to recommended

fix(stealth): add parameters

fix(tinyllama): update description + parameters

fix(trinity): update description + parameters

fix(tulu2): update description + parameters

fix(stealth): change max_tokens to 4096

update(wizardcoder): update parameter + description

update(wizardcoder): update  description

update(wizardcoder): change to q4

fix(yarn-mistral): update parameters

fix(yarn-mistral): change to q4

update(wizardcoder): correct the size of q4 model

fix(model-extension): pump to 1.0.20

fix(tinyllama): change to q8

fix(phi-2): change to q8

fix(deepseek34b): change to q4

fix(mistral7b): update the stop token

fix(starling): remove recommended

2024-01-08 23:00:01 +07:00

src

chore: clean up use os hook (#1418 )

2024-01-07 13:16:56 +07:00

.prettierrc

refactor: jan extensions (#799 )

2023-12-01 11:30:29 +07:00

package.json

fix(magicoder): correct the id and update parameters (#1448 )

2024-01-08 23:00:01 +07:00

README.md

refactor: jan extensions (#799 )

2023-12-01 11:30:29 +07:00

tsconfig.json

refactor: jan extensions (#799 )

2023-12-01 11:30:29 +07:00

webpack.config.js

fix: migrate new models (#1034 )

2023-12-15 16:14:52 +07:00

README.md

Jan Model Management 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.

Note

You'll need to have a reasonably modern version of Node.js handy. If you are using a version manager like nodenv or nvm, you can run nodenv install in the root of your repository to install the version specified in package.json. Otherwise, 20.x or later should work!

🛠️ Install the dependencies
```
npm install
```
🏗️ Package the TypeScript for distribution
```
npm run bundle
```
✅ 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 a Promise<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!