From a1f9f1d3ffb29c0475b921f45b0e91605c9de01b Mon Sep 17 00:00:00 2001 From: Justin Hayes Date: Wed, 13 Mar 2024 22:43:23 -0400 Subject: [PATCH 1/3] Explicitly set platform architecture Uses `uname -m` to get the arch. --- Makefile | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/Makefile b/Makefile index d06173c..8a2f74b 100644 --- a/Makefile +++ b/Makefile @@ -7,11 +7,11 @@ all: rm -f node_modules/@jimp/core/node_modules/.bin/mkdirp rm -f node_modules/execa/node_modules/.bin/semver rm -f node_modules/execa/node_modules/.bin/which - npm run make + npm run make -- --arch=$(shell uname -m) --platform=darwin clean: rm -rf node_modules install: - xattr -c out/open-webui-assistant-darwin-arm64/open-webui-assistant.app - mv out/open-webui-assistant-darwin-arm64/open-webui-assistant.app ~/Applications/Open\ WebUI\ Assistant.app + xattr -c out/open-webui-assistant-darwin-$(shell uname -m)/open-webui-assistant.app + mv out/open-webui-assistant-darwin-$(shell uname -m)/open-webui-assistant.app ~/Applications/Open\ WebUI\ Assistant.app From 92708347adcf768d1d959bd3b75f0d0296ccd31a Mon Sep 17 00:00:00 2001 From: Justin Hayes Date: Wed, 13 Mar 2024 22:58:33 -0400 Subject: [PATCH 2/3] Create README.md --- README.md | 45 +++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 45 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..90861bb --- /dev/null +++ b/README.md @@ -0,0 +1,45 @@ +# Open WebUI Assistant + +> [!NOTE] +> Please note that the current version of Open WebUI Assistant is compatible only with macOS systems. Support for other operating systems will be added in future releases. + +Open WebUI Assistant is a companion app that allows you to insert text generated by your Open WebUI instance anywhere on your computer using keyboard shortcuts, and offers a user interface for setting up the server URL and JWT token. The two primary keyboard shortcuts are: + +1. **Cmd+Option+i**: Use this shortcut when the text input field is active to request text completion from Open WebUI Assistant. +2. **Cmd+Option+o**: This command uses the normal chat API endpoint for interaction with your Open WebUI instance, not opening a separate chat window. + +## Prerequisites + +Before installing Open WebUI Assistant, make sure you have `make`, `node`, and `npm` installed on your system. + +If you don't have `make` or `node` installed, install them using your system package manager or refer to the [official documentation](https://www.gnu.org/software/make/download.html) and [Node.js download page](https://nodejs.org/en/download). + + Thank you for pointing that out! I apologize for the confusion caused by using `sudo` in my previous instructions. The corrected installation section of the README should look like this: + +## Installation + +1. Clone Open WebUI Assistant's GitHub repository: + ```bash + git clone https://github.com/open-webui/assistant.git + cd assistant + ``` + +2. Run `make` to prepare the build environment: + ```bash + make + ``` + +3. Install Open WebUI Assistant using the following command: + ```bash + make install + ``` + +4. Configure Open WebUI Assistant: + - After installation, find and run the Open WebUI Assistant companion app located in your user's `~/Applications` directory. + - In the settings window, enter your Open WebUI server URL and the JWT token you can get from **Settings > Account** in the WebUI. The companion app's UI is just a setting interface for these two values. + +5. Use Open WebUI Assistant: + - After configuring Open WebUI Assistant, use the keyboard shortcuts **Cmd+Option+i** to request text completion or **Cmd+Option+o** for interaction with your Open WebUI instance using the normal chat API endpoint. + +## Help Contribute +For more information, troubleshooting, or feature requests, visit [Open WebUI Assistant's GitHub repository](https://github.com/open-webui/assistant) or say hello in our [Discord server](https://discord.gg/5rJgQTnV4s). From f246d7a516cc6919a6291c3c8139e7972a09bfe2 Mon Sep 17 00:00:00 2001 From: Justin Hayes Date: Wed, 13 Mar 2024 23:01:28 -0400 Subject: [PATCH 3/3] Update README.md MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit 👀 --- README.md | 2 -- 1 file changed, 2 deletions(-) diff --git a/README.md b/README.md index 90861bb..65d2ad7 100644 --- a/README.md +++ b/README.md @@ -14,8 +14,6 @@ Before installing Open WebUI Assistant, make sure you have `make`, `node`, and ` If you don't have `make` or `node` installed, install them using your system package manager or refer to the [official documentation](https://www.gnu.org/software/make/download.html) and [Node.js download page](https://nodejs.org/en/download). - Thank you for pointing that out! I apologize for the confusion caused by using `sudo` in my previous instructions. The corrected installation section of the README should look like this: - ## Installation 1. Clone Open WebUI Assistant's GitHub repository: