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)

chat
Searching Database…

42K ·GitHub
Chatbox
What is this?Chatbox is a desktop AI client that lets you chat with ChatGPT, Claude, Gemini, local Ollama models and other LLMs from one unified app, available on Windows, Mac, Linux, iOS, Android and the web.
Is this a browser extension, a standalone app, or does it work everywhere?It is a cross-platform standalone app: native desktop builds for Windows/Mac/Linux, native mobile apps for iOS/Android, and a separate web version usable in any browser.
How do I get it running?Download the installer for your platform from the releases page, install and launch Chatbox, then configure your AI provider (OpenAI, Claude, etc.) in settings before chatting.
Do I need my own OpenAI or Claude API key?Yes, you configure your own AI provider (OpenAI, Azure OpenAI, Claude, Gemini, ChatGLM-6B, etc.) in the settings; for local models you instead connect it to a running Ollama instance.
What system versions does it need?Minimum supported versions are Windows 10, macOS 11 (Big Sur) and Ubuntu 20.04+ (or an AppImage-compatible distro), all on x64 (Mac also supports Apple Silicon).
Can I use it without sending data to the cloud?Yes, Chatbox can connect to local Ollama models (like Llama 2, Mistral, Mixtral, codellama) so conversations can run entirely on your own machine.
Where does my chat data go?Chat data is stored locally on your device rather than on a remote server, which the project frames as a privacy benefit.
Can Chatbox generate images, not just text?Yes, it integrates DALL-E-3 for image generation directly inside the chat interface.
Does it support team or shared API usage?Yes, it has a team collaboration feature for sharing OpenAI API resources among a team, described as a separate 'learn more' feature beyond the core open-source app.
What formatting does it support in replies?It renders Markdown and LaTeX with syntax highlighting for code, and supports streaming responses as they're generated.
Is the interface available in languages other than English?Yes, the UI supports English, Simplified/Traditional Chinese, Japanese, Korean, French, German, Russian and Spanish.
What are similar projects?NextChat, LibreChat, gpt4free, open-codesign, brigade, AstrBot, easyread, repomix
Which topics is it in?gpt-5, assistant, copilot, chat, gpt, chatgpt, multilingual, local-llm, image-generation, ollama, electron, chatbot
Creator
chatboxai
Size
52.8 MB
Stars
42K
Updated
CommitSep 24Releasev1.23.5Sep 24
Age
3y
Commits · 90 Days