chatbox README

The project's README from github.com/chatboxai/chatbox. As one markdown file: README.md.

English | 简体中文

Chatbox (Community Edition)

Your Ultimate AI Copilot on the Desktop.
Chatbox is a desktop client for ChatGPT, Claude and other LLMs, available on Windows, Mac, Linux

macOS Windows Linux Downloads Privacy

Chatbox - Better UI & Desktop App for ChatGPT, Claude and other LLMs. | Product Hunt chatboxai%2Fchatbox | Trendshift


This is the repository for the Chatbox Community Edition, open-sourced under the GPLv3 license.

Chatbox is going open-source Again!

We regularly sync code from the pro repo to this repo, and vice versa.

Download

Desktop

Windows MacOS Linux

Setup.exe

Intel

Apple Silicon

AppImage

iOS/Android

.APK

For more information: chatboxai.app

Quick Start

For End Users

  1. Download the appropriate installer for your platform from the releases page
  2. Install and launch Chatbox
  3. Configure your AI provider (OpenAI, Claude, etc.) in settings
  4. Start chatting!

System Requirements

Platform Minimum Version Architecture
Windows Windows 10 x64
macOS macOS 11 (Big Sur) Intel/Apple Silicon
Linux Ubuntu 20.04+ / AppImage supported distros x64

Features

🤖 AI Model Support

🖥️ User Experience

📄 Content & Formatting

👥 Collaboration & Sharing

🌐 Platform Availability

🌍 Localization

✨ More Features

FAQ

How to Contribute

We welcome contributions from the community! Here's how you can help make Chatbox better:

🐛 Reporting Issues

🔧 Pull Requests

  1. Fork the repository and create your branch from main
  2. Make your changes and ensure the code follows our coding standards
  3. Test your changes thoroughly
  4. Update documentation if needed
  5. Submit a pull request with a clear description of the changes

🌍 Translations

Help make Chatbox accessible to more people by contributing translations:

📖 Documentation

🌟 Other Ways to Contribute

Thank you for contributing! 🙏

Development

Prerequisites

Before you begin, ensure you have the following installed:

Quick Setup

  1. Clone the repository

    git clone https://github.com/chatboxai/chatbox.git
    cd chatbox
    
  2. Install dependencies

    pnpm install
    
  3. Start development server

    pnpm run dev
    

    The application will start in development mode with hot-reload enabled.

Build Commands

Command Description
pnpm run dev Start development server with hot-reload
pnpm run package Build and package for current platform
pnpm run package:all Build and package for all platforms
pnpm run build Build for production without packaging
pnpm run lint Run Biome to check code quality
pnpm run test Run Vitest test suite

Project Structure

chatbox/
├── src/
│   ├── main/               # Electron main process
│   ├── renderer/           # React renderer (UI)
│   ├── preload/            # Electron preload scripts
│   └── shared/             # Shared utilities
├── doc/                    # Documentation and assets
├── resources/              # App resources and icons
├── team-sharing/           # Team collaboration features
└── package.json            # Project configuration

Development Tips

Troubleshooting

Issue: pnpm install fails

Issue: Build fails on Windows

Issue: Changes not reflecting in development

Star History

Star History Chart

Contact

Email

License

LICENSE

chatbox (chatboxai/chatbox)

Searching Database…

42.1K ·GitHub
这是什么?Chatbox 是一款桌面 AI 客户端,让你在同一个应用里与 ChatGPT、Claude、Gemini、本地 Ollama 模型以及其他大语言模型聊天,支持 Windows、Mac、Linux、iOS、Android 和网页版。
这是浏览器扩展、独立应用,还是在任何地方都能用?它是一款跨平台的独立应用:提供 Windows、Mac、Linux 的原生桌面版,iOS、Android 的原生手机应用,以及可在任何浏览器中使用的单独网页版。
我该怎么让它运行起来?从 releases 页面下载适合你平台的安装包,安装并启动 Chatbox,然后在开始聊天前,在设置中配置你的 AI 服务商(如 OpenAI、Claude 等)。
我需要自己的 OpenAI 或 Claude API 密钥吗?需要,你要在设置中配置自己的 AI 服务商(如 OpenAI、Azure OpenAI、Claude、Gemini、ChatGLM-6B 等);如果使用本地模型,则需要将它连接到正在运行的 Ollama 实例。
它需要什么系统版本?最低支持版本为 Windows 10、macOS 11(Big Sur)和 Ubuntu 20.04+(或兼容 AppImage 的发行版),均为 x64 架构(Mac 也支持 Apple Silicon)。
我能不把数据发送到云端就使用它吗?可以,Chatbox 能连接本地 Ollama 模型(如 Llama 2、Mistral、Mixtral、codellama),因此对话可以完全在你自己的电脑上运行。
我的聊天数据会存到哪里?聊天数据存储在你的设备本地,而不是远程服务器上,项目方将此视为一项隐私优势。
Chatbox 除了文字,还能生成图片吗?可以,它在聊天界面中直接集成了 DALL-E-3 来生成图片。
它支持团队或共享 API 使用吗?支持,它提供团队协作功能,可在团队内共享 OpenAI API 资源;该功能被描述为核心开源应用之外的一项单独的“了解更多”功能。
回复支持哪些格式?它可以渲染 Markdown 和 LaTeX,为代码提供语法高亮,并支持边生成边显示的流式回复。
界面是否支持英语以外的语言?支持,界面提供英语、简体中文/繁体中文、日语、韩语、法语、德语、俄语和西班牙语。
Creator
chatboxai
Size
52.8 MB
Stars
42.1K
Age
3y
Commits · 90 Days