https://github.com/qwersyk/Newelle
Newelle - Your Ultimate Virtual Assistant
https://github.com/qwersyk/Newelle
adwaita app gnome gtk gtk4 linux
Last synced: 10 months ago
JSON representation
Newelle - Your Ultimate Virtual Assistant
- Host: GitHub
- URL: https://github.com/qwersyk/Newelle
- Owner: qwersyk
- License: gpl-3.0
- Created: 2023-06-11T07:43:48.000Z (almost 3 years ago)
- Default Branch: master
- Last Pushed: 2024-10-07T15:21:00.000Z (over 1 year ago)
- Last Synced: 2024-10-10T22:15:47.065Z (over 1 year ago)
- Topics: adwaita, app, gnome, gtk, gtk4, linux
- Language: Python
- Homepage: https://flathub.org/apps/io.github.qwersyk.Newelle
- Size: 4.51 MB
- Stars: 137
- Watchers: 6
- Forks: 16
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- License: COPYING
Awesome Lists containing this project
- awesome-opensource-ai - Newelle - GNOME/Linux desktop virtual assistant with integrated file editor, global hotkeys, and profile manager.  (12. User Interfaces & Self-hosted Platforms)
- awesome-gnome - Newelle - Virtual assistant (local, based on GPT4All) that interacts with the system by running shell commands and execute Python code. (Applications / Productivity and Time)
- awesome-gtk - Newelle - Virtual assistant (based on GPT4All) that interacts with the system by running shell commands and execute Python code `#python` `#gtk4` `#libadwaita`. (Productivity / Chat Bots and Virtual assistants)
README
Newelle - Your Ultimate Virtual Assistant
https://github.com/user-attachments/assets/909edf0e-5a79-40c2-a3ef-cb5b2b18abfc
# Features
- 🎨 **Advanced Customization**: Tailor the application with a wide range of settings
- 🚀 **Flexible Model Support**: Choose from mutliple AI models and providers to fit your specific needs
- 💻 **Terminal Command Exection**: Execute commands suggested by the AI on the fly
- 🧩 **Extensions**: Add your own functionalities and models to Newelle
- 🗣 **Voice support**: Chat hands free with Newelle, supporting many Speech To Text and TTS models, with translation options
- 🧠 **Long Term Memory**: Remember conversations from previous chats
- 💼 **Chat with documents**: Chat with your own documents
- 🔎 **Web Search**: Provide reliable answers using Web Search
- 🌐 **Website Reading**: Scrap informations from websites by appending the prefix #https://.. in the prompt
- 👤 **Profile Manager**: Create settings profiles and switch between them
- 📁 **Builtin File Manager**: Manage you files with the help of AI
- 📝 **Rich Formatting**: Supports both Markdown and LaTeX
- ✏️ **Chat editing**: Edit or remove any message and manage your prompts easily
# Extensions
Newelle supports extensions to extend its functionality. You can either
use [existing extensions](https://github.com/topics/newelle-extension) or create your own to add new features to the
application.
## Mini Window Mode
A lightweight version of Newelle that can be triggered via keyboard shortcuts.
### Configuration
#### 1. Setup Hotkeys
As an example, to set the mini window launch's hotkey to Ctrl+Space, execute this command:
```bash
/bin/bash -c 'flatpak run --command=gsettings io.github.qwersyk.Newelle set io.github.qwersyk.Newelle startup-mode "mini" && flatpak run io.github.qwersyk.Newelle'
```
After that, enable the hotkey in settings.
#### 2. Enable Window Centering
For GNOME desktop environment users, you may need to enable automatic window centering:
```bash
gsettings set org.gnome.mutter center-new-windows true
```
# Installation
There are two ways of doing this
* `install.sh`
1. Install the latest Gnome SDK
2. Run `sh install.sh`
3. Profit!
* Gnome Builder
1. Install GNOME Builder on your system.
2. Clone the Newelle repository from GitHub.
3. Open the project in GNOME Builder and compile it.
4. Once compiled, you can run the program from the compiled executable.
With nix, you can run the app without installing by executing this command:
```sh
nix run github:qwersyk/Newelle
```
If you want the latest commit version, you can clone this repository and execute `nix run .` to start the program or `nix develop .` to start a developer shell
> [!WARNING]
> Localizations will not work on these builds! If you want your language to work, go to the
> "Builder" section instead
1. Download the latest release from the [Github Actions](https://github.com/qwersyk/Newelle/actions)
2. Extract the downloaded package.
3. Install a flatpak package.
1. Ensure you have set up both flatpak and flathub
2. Install Newelle by executing: `flatpak install flathub io.github.qwersyk.Newelle`
# Permission
> [!IMPORTANT]
> The Flathub version of Newelle is restricted to the `.var/app/io.github.qwersyk.Newelle` folder and operates within a
> Flatpak virtualized environment, limiting its capabilities.
To extend Newelle's permissions, either execute this command to temporarily grant its access:
```sh
flatpak run --talk-name=org.freedesktop.Flatpak --filesystem=home io.github.qwersyk.Newelle
```
or adjust the permissions permanently using [Flatseal](https://flathub.org/apps/details/com.github.tchx84.Flatseal):
- Open Flatseal, find "newelle" and enable both "All user files" and "Session Bus"
- Add `org.freedesktop.Flatpak` to run outside the sandbox.
> [!WARNING]
> Be cautious when enabling these options. They reduce security by exposing your data and terminal. Avoid sharing
> personal information, and understand that we can't guarantee the privacy of your chat data or prevent potential risks
> from proprietary models.
# Honorable Mentions of Newelle's forks
**[Newelle Lite](https://github.com/qwersyk/Newelle/tree/aarch64)** - Your Virtual Assistant for aarch64
**[Nyarch Assistant](https://github.com/NyarchLinux/NyarchAssistant)** - Your ultimate Waifu AI Assistant
