https://github.com/leehuwuj/refiner

Translate or improve your text using LLM!
https://github.com/leehuwuj/refiner

llm macos tauri text-rewriting translation windows

Last synced: 10 days ago
JSON representation

Translate or improve your text using LLM!

• Host: GitHub
• URL: https://github.com/leehuwuj/refiner
• Owner: leehuwuj
• License: mit
• Created: 2024-04-28T03:14:17.000Z (9 months ago)
• Default Branch: main
• Last Pushed: 2024-10-12T09:30:08.000Z (3 months ago)
• Last Synced: 2024-12-23T06:06:21.097Z (16 days ago)
• Topics: llm, macos, tauri, text-rewriting, translation, windows
• Language: TypeScript
• Homepage:
• Size: 3.12 MB
• Stars: 11
• Watchers: 1
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

README

        
## Introduction



***Refiner***: A simple AI-powered application for translating or refining text.

Features:

 - [x] Translation: Translate inputted text to a target language.

 - [x] Local LLM: Use Ollama as local LLM (offline mode).

 - [x] Providers: OpenAI, Ollama, Claude (WIP).

 - [x] Hot key: Quickly translate a selected text via shortcut key (Currently is: `Cmd + E`)

 - [] Linux support.

 - [] Windows support.

 - [WIP] Custom prompt: Adjust the translation or text refining in different style.

***Note***: This app is still in development

## Screenshots:

- Home:

![Refiner Home](./docs/images/home_sc.png)

- Settings:

![Refiner settings](./docs/images/setting_sc.png)

## Installation

1. Download the released file (.dmg for MacOS) in the [Released page](https://github.com/leehuwuj/refiner/releases)

2. Install the app.

3. Setting API key (required for OpenAI provider).

   - Click the Setting button in the bottom right cornor of the app.

   - Chose OpenAI provider and select a model.

   - Add your OpenAI's API key

   - Click `Save` to save the settings.

5. If you use `Hot key` feature that pressing `Cmd + E` to quick translate the selected text then Accessibility permission for Refiner app must be enable. Here are the steps to enable Accessibility permissions for an app on a Mac:

    - Open System Preferences (you can do this by clicking on the Apple logo in the top-left corner of your screen and selecting "System Preferences").

    - Click on "Security & Privacy".

    - Click on the "Privacy" tab.

    - Scroll down and click on "Accessibility" in the left-hand menu.

    - Click the lock icon in the bottom-left corner to make changes. You'll need to enter your password.

    - Find the app you want to grant Accessibility permissions to in the list. If it's not there, you can add it by clicking the '+' button.

    - Check the box next to the app to grant it Accessibility permissions.

    - Click the lock again to prevent further changes.

    Remember to only grant Accessibility permissions to apps you trust, as they will have increased control over your system.

> MacOS users may encounter this problem: "Refiner.app" is damaged and can't be opened. You should move it to the Trash.

 open terminal and execute:

 `xattr -c /Applications/Refiner.app`