Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/wieslawsoltes/ChatGPT
A ChatGPT C# client for MacOS, Windows, Linux, Android, iOS and Browser. Powered by Avalonia UI framework.
https://github.com/wieslawsoltes/ChatGPT
ai api avalonia avaloniaui chatgpt clippy openai
Last synced: about 2 months ago
JSON representation
A ChatGPT C# client for MacOS, Windows, Linux, Android, iOS and Browser. Powered by Avalonia UI framework.
- Host: GitHub
- URL: https://github.com/wieslawsoltes/ChatGPT
- Owner: wieslawsoltes
- License: mit
- Created: 2022-12-05T20:17:08.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-06-16T17:54:31.000Z (3 months ago)
- Last Synced: 2024-07-29T09:33:21.298Z (about 2 months ago)
- Topics: ai, api, avalonia, avaloniaui, chatgpt, clippy, openai
- Language: C#
- Homepage: https://wieslawsoltes.github.io/ChatGPT/
- Size: 238 MB
- Stars: 1,365
- Watchers: 29
- Forks: 210
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
- awesome-llm-and-aigc - wieslawsoltes/ChatGPT
- awesome-dotnet-machine-learning - wieslawsoltes/ChatGPT
- awesome-ai-client - wieslawsoltes/ChatGPT - A ChatGPT C# client for MacOS, Windows, Linux, Android, iOS and Browser. Powered by Avalonia UI framework. (💻 Desktop)
- awesome-chatgpt - wieslawsoltes/ChatGPT - (SDK, Libraries, Frameworks / C#)
README
# ChatGPT
[](https://dev.azure.com/wieslawsoltes/GitHub/_build/latest?definitionId=109&repoName=wieslawsoltes%2FChatGPT&branchName=main)
[](https://github.com/wieslawsoltes/ChatGPT/actions/workflows/build.yml)
[](https://github.com/wieslawsoltes/ChatGPT/releases)
[](https://github.com/wieslawsoltes/ChatGPT/releases)
[](https://github.com/wieslawsoltes/ChatGPT/releases)
[](https://www.nuget.org/packages/ChatGPT)
[](https://www.nuget.org/packages/ChatGPT)
A ChatGPT C# client for graphical user interface runs on MacOS, Windows, Linux, Android, iOS and Browser. Powered by [Avalonia UI](https://avaloniaui.net/) framework.
To make the app work, you need to set the [OpenAI API key](https://beta.openai.com/account/api-keys) as the `OPENAI_API_KEY` environment variable or set API key directly in app settings.
You can try client using browser version [here](https://wieslawsoltes.github.io/ChatGPT/).
# Shortcuts
### Main Window
- Ctrl+Shift+A - Toggle between transparent and acrylic blur window style.
- Ctrl+Shift+S - Toggle between visible and hidden window state.
### Message Prompt
- Enter - Send prompt.
- Escape - Cancel edit.
- F2 - Edit prompt.
- Shift+Enter, Alt+Enter - Insert new line.
# Overriding OpenAI api url
```bash
To override the OpenAI api url set `OPENAI_API_URL_CHAT_COMPLETIONS` environment variable or set API url directly in app settings.
```
# OpenAI ChatGPT web version import
You can import [OpenAI ChatGPT web version](https://chat.openai.com/chat) chats backup created using [this script](https://github.com/abacaj/chatgpt-backup).
# Build
1. Install [.NET 7.0](https://dotnet.microsoft.com/en-us/download/dotnet/7.0)
2. Run `dotnet workload install ios android wasm-tools` command
3. `dotnet publish -c Release` command inside project directory (mobile/desktop) or `dotnet run` for desktop to just run
### Dependencies
- [Avalonia](https://github.com/AvaloniaUI/Avalonia)
- [Markdown.Avalonia](https://github.com/whistyun/Markdown.Avalonia)
- [Avalonia.HtmlRenderer](https://github.com/AvaloniaUI/Avalonia.HtmlRenderer)
- [CommunityToolkit.Mvvm](https://github.com/CommunityToolkit/dotnet)
# .NET tool
Install:
```bash
dotnet tool install --global ChatGPT.CLI --version 1.0.0-preview.17
```
Uninstall:
```bash
dotnet tool uninstall --global ChatGPT.CLI
```
- [ChatGPT.CLI](https://www.nuget.org/packages/ChatGPT.CLI) - An .NET ChatGPT tool.
### Usage
```
ChatGPT.CLI:
An .NET ChatGPT tool.
Usage:
ChatGPT.CLI [options]
Options:
-f, --inputFiles The relative or absolute path to the input files
-d, --inputDirectory The relative or absolute path to the input directory
-o, --outputDirectory The relative or absolute path to the output directory
--outputFiles The relative or absolute path to the output files
-p, --pattern The search string to match against the names of files in the input directory
-r, --recursive Recurse into subdirectories of input directory search
-e, --extension The output file extension
-s, --settingsFile The relative or absolute path to the settings file
--temperature What sampling temperature to use, between 0 and 2. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic.
--topP An alternative to sampling with temperature, called nucleus sampling, where the model considers the results of the tokens with top_p probability mass. So 0.1 means only the tokens comprising the top 10% probability mass are considered.
--presencePenalty Number between -2.0 and 2.0. Positive values penalize new tokens based on whether they appear in the text so far, increasing the model's likelihood to talk about new topics.
--frequencyPenalty Number between -2.0 and 2.0. Positive values penalize new tokens based on their existing frequency in the text so far, decreasing the model's likelihood to repeat the same line verbatim.
--maxTokens The maximum number of tokens to generate in the chat completion.
--apiKey Override OpenAI api key. By default OPENAI_API_KEY environment variable is used.
--apiUrl Override OpenAI api url. By default OPENAI_API_URL_CHAT_COMPLETIONS environment variable is used.
--model ID of the model to use. See the model endpoint compatibility table for details on which models work with the Chat API.
--directions The system message (directions) helps set the behavior of the assistant. Typically, a conversation is formatted with a system message first, followed by alternating user and assistant messages.
-t, --threads The number of parallel job threads
--quiet Set verbosity level to quiet
--version Show version information
-?, -h, --help Show help and usage information
```
### Examples
- Using .NET tool `chatgpt` command:
C# to VB
```bash
chatgpt -d ./ -e vb -p *.cs --directions "You are C# to VB conversion expert. Convert input code from C# to VB. Write only converted code."
```
C# to F#
```bash
chatgpt -d ./ -e fs -p *.cs --directions "You are C# to F# conversion expert. Convert input code from C# to F#. Write only code."
```
Refactor C# code
```bash
chatgpt -d ./ -e cs -p *.cs --directions "You are C# expert. Refactor C# code to use fluent api. Write only code."
```
Write API documentation
```bash
chatgpt -d ./ -e md -p *.cs --directions "You are a technical documentation writer. Write API documentation for C# code. If XML docs are missing write them."
```
- Run from source
C# to VB
```bash
dotnet run -- -d ./ -e vb -p *.cs --directions "You are C# to VB conversion expert. Convert input code from C# to VB. Write only converted code."
```
C# to F#
```bash
dotnet run -- -d ./ -e fs -p *.cs --directions "You are C# to F# conversion expert. Convert input code from C# to F#. Write only code."
```
Write API documentation
```bash
dotnet run -- -d ./ -e md -p *.cs --directions "You are a technical documentation writer. Write API documentation for C# code. If XML docs are missing write them."
```
### Settings file format
```json
{
"temperature": 0.7,
"top_p": 1,
"presence_penalty": 0,
"frequency_penalty": 0,
"maxTokens": 2000,
"apiKey": "",
"model": "gpt-3.5-turbo",
"directions": "You are a helpful assistant.",
"apiUrl": ""
}
```
# COM
In the build release directory `ChatGPT\ChatGptCom\bin\Release\net462\` run following command to register `ChatGptCom.dll`.
32-bit
```
c:\Windows\Microsoft.NET\Framework\v4.0.30319\regasmm.exe /codebase /tlb ChatGptCom.dll
```
64-bit
```
c:\Windows\Microsoft.NET\Framework64\v4.0.30319\regasm.exe /codebase /tlb ChatGptCom.dll
```
### Microsoft Work 2010
Add `ChatGPT\ChatGptCom\bin\Release\net462\ChatGptCom.tlb` to `References` using `Tools > References...` menu in `Microsoft Visual Basic for Applications`.
```vba
Option Explicit
Private WithEvents m_translateSource As Chat
Private WithEvents m_demoSource As Chat
Dim OriginalSelection As Range
Sub TranslateSelection()
Set OriginalSelection = Selection.Range
Dim ProcessedText As String
ProcessedText = OriginalSelection.Text
m_translateSource.AskAsync "You are a professional translator to English. I will provide text and you will translate it to English.", ProcessedText
End Sub
Sub Translate_Initialize()
Set m_translateSource = New ChatGptCom.Chat
End Sub
Sub m_translateSource_OnSendCompleted()
OriginalSelection.Text = m_translateSource.Result
End Sub
Sub Chat_Initialize()
Set m_demoSource = New ChatGptCom.Chat
End Sub
Sub Chat_Send()
m_demoSource.AskAsync "You are a professional translator to English.", "To jest rewolucja szutcznej inteligencji! VBA na zawsze!"
End Sub
Sub m_demoSource_OnSendCompleted()
MsgBox m_demoSource.Result
End Sub
Sub ChatGpt()
Dim myObj As ChatGptCom.Chat
Set myObj = New ChatGptCom.Chat
myObj.AskAsync "You are a professional translato to English.", "Cześć, witamy z Office VBA"
End Sub
Sub GetEnvironmentVariable()
Dim envVarName As String
Dim envVarValue As String
envVarName = "OPENAI_API_KEY"
envVarValue = Environ(envVarName)
MsgBox "The value of the " & envVarName & " environment variable is:" & vbCrLf & envVarValue
End Sub
```
Chat form:
```vba
Option Explicit
Private WithEvents m_chatSource As Chat
Private Sub UserForm_Initialize()
Set m_chatSource = New ChatGptCom.Chat
m_chatSource.Create "You are a helpful assistant", 2000, "gpt-3.5-turbo"
End Sub
Private Sub SendButton_Click()
Dim MessageText As String
MessageText = MessageTextBox.Text
MessagesListBox.AddItem MessageText
MessageTextBox.Text = ""
m_chatSource.MessageAsync MessageText, "user", True
End Sub
Sub m_chatSource_OnSendCompleted()
Dim MessageText As String
MessageText = m_chatSource.Result
MessagesListBox.AddItem MessageText
End Sub
```
Chat form:
```vba
Option Explicit
Private WithEvents m_chatSource As Chat
Private Sub UserForm_Initialize()
Set m_chatSource = New ChatGptCom.Chat
m_chatSource.Create "You are a helpful assistant", 2000, "gpt-3.5-turbo"
End Sub
Private Sub SendButton_Click()
Dim MessageText As String
MessageText = MessageTextBox.Text
ChatTextBox.Text = ChatTextBox.Text & vbCrLf & MessageText
MessageTextBox.Text = ""
m_chatSource.MessageAsync MessageText, "user", True
End Sub
Sub m_chatSource_OnSendCompleted()
Dim MessageText As String
MessageText = m_chatSource.Result
ChatTextBox.Text = ChatTextBox.Text & vbCrLf & MessageText
End Sub
```
# NuGet
- [ChatGPT](https://www.nuget.org/packages/ChatGPT) - An OpenAI api library for .NET.
- [ChatGPT.Core](https://www.nuget.org/packages/ChatGPT.Core) - An OpenAI client core library for .NET.
- [ChatGPT.UI](https://www.nuget.org/packages/ChatGPT.UI) - An OpenAI client user interface library for .NET.
- [ChatGPT.CLI](https://www.nuget.org/packages/ChatGPT.CLI) - An .NET ChatGPT tool.
- [ChatGptCom](https://www.nuget.org/packages/ChatGptCom) - An OpenAI api library for .NET COM interop.
# Docs
- [Guide Chat completions](https://platform.openai.com/docs/guides/chat)
- [API Reference](https://platform.openai.com/docs/api-reference/chat)
# License
ChatGPT is licensed under the [MIT license](LICENSE).