Skip to content

Latest commit

 

History

History
183 lines (131 loc) · 6.33 KB

README.md

File metadata and controls

183 lines (131 loc) · 6.33 KB
Raw

ChatWizard

ChatWizard

OpenAI chat client Desktop Application (Windows, MacOS, Linux)

Declaration

This project is currently undergoing active development and has only been tested on MacOS M1. In the event of any issues, please do not hesitate to submit an issue as they arise, and I will make every effort to address them. Additionally, all contributions in the form of PRs are welcome and greatly appreciated.

  • All data will only be stored locally.
  • Chat logs and API keys will only be used for the OpenAI API and will not be sent to any other destination.
  • If concerned about API key leakage, the in-app forwarding function can be used (which enables storage of the API key on your own server, requiring only a reverse-proxy address to the OpenAI API).

Screenshots

Casual Chat

Topic Chat

Local Prompt

Prompt Market

Plugins

Setting

Tray Window

Features

  • plugin
  • stream response
  • stop replying
  • tray window
  • network proxy
  • forward api
  • lazy loading of chat records
  • export image
  • chat configuration
  • prompt market
  • local prompt
  • i18n
  • dark/light theme

Todo

  • multi user
  • shared chat
  • export pdf/image/markdown

Installation

If a 404 error page appears when clicking the download link, this may be due to the application being packaged at the moment. Please try again later or alternatively, download the most up-to-date version directly from here.

  • Mac

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

    open terminal and execute:

    xattr -cr /Applications/ChatWizard.app

  • Windows:

  • Linux

    It is not surprising for the app to fail to launch on a Linux system. This is likely because the two packages were built on the Ubuntu20. Perhaps you could consider building them locally.

  • From Source

    1. First you need to install Tauri development environment and pnpm
    2. Next, use the following command to build. 
      git clone https://github.com/lisiur/ChatWizard.git
cd ChatWizard
pnpm install
pnpm run install
pnpm run build
    3. Your local build version will be located at target/release/bundle/

Upgrade

ChatWizard has built-in upgrade support, and each time you restart the application, it automatically checks for any new releases. If a new version is available, a small red dot will be displayed in the lower left corner.

Plugin

You need to install chat-wizard-cli to use plugin.

Install chat-wizard-cli

How to use

  1. You need to rename the downloaded binary file to a more user-friendly name and add it to your environment variables. Let us assume that the binary file is named chat-wizard-cli.
  2. Then you need to install plugin in ChatWizard App. For instance, assuming the plugin named commit-summary has already been installed.
  3. And finally you can execute: chat-wizard-cli exec commit-summary in terminal.

Q&A

1. Why chat-wizard-cli is so large, almost more then 10 MB

As CLI and GUI programs are completely separate, you can easily install and use plugins with just CLI. However, the current configuration of CLI is still dependent on GUI, which will gradually be improved in the future.

2. Where is the plugin source code

Check this repo

Development

  • dev

    # root
pnpm install
pnpm run install
pnpm run dev

  • build

    pnpm run build

Contribute

i18n

Language definitions are here: web/src/i18n. Refer to the contents of template.ts to add a new language definition.