Skip to content

User guide to Extensions

Francesco Caracciolo edited this page Nov 15, 2024 · 2 revisions

Newelle extensions are simple python files that can extend Newelle capabilities in these ways:

  • Adding new handlers (for LLM, TTS or STT)
  • Adding new prompts
  • Replacing codeblocks with custom GTK widgets or text to be sent to the LLM (for example, mathematical results)

If you want to develop an extension, read Developing an Extension.

Finding extensions

You can find developed extensions in this repository.

Warning

We have no control on the extensions published. Extensions can run arbitrary code on your machine/flatpak envirnoment, so only install extensions you can trust

Installing Extensions

Extensions are simple python files.

  1. Download the file from GitHub. You can do that by going into the repository (for this example we will use Graph Extension ) immagine

Click on the python file you want to download. Then click on "Download Raw File" immagine 2. Import the extension in Newelle: Open the hamburger menu in the left sidebar, click on "Choose an Extension", pick the file you have just downloaded and it's installed. immagine

Important

Always read the README.md file in the github repository since the extension might have some warning, suggestions or required extra dependencies you might have to install on your own.

Suggested Extensions

Here is a list of suggested extensions:

Additional Information

Where can I find installed extensions files?

Installed extensions files can be found in $HOME/.var/app/io.github.qwersyk.Newelle/config/extensions

Where are extensions cache files located?

Extensions cache files can be found in $HOME/.var/app/io.github.qwersyk.Newelle/config/extensions_cache

What if an extension broke my Newelle Installation?

You should be able to get Newelle running by deleting these three folders:

rm -rf $HOME/.var/app/io.github.qwersyk.Newelle/config/extensions
rm -rf $HOME/.var/app/io.github.qwersyk.Newelle/config/extensions_cache
rm -rf $HOME/.var/app/io.github.qwersyk.Newelle/config/pip

This will delete all your installed extensions, extensions cache and dependencies that might interfere with Newelle. In extreme cases, you might need to reset Newelle.

rm -rf $HOME/.var/app/io.github.qwersyk.Newelle/