📖README

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

<table style="width: 100%"> <tr> <td width="25%" align="center"> <b>Windows</b> </td> <td width="25%" align="center" colspan="2"> <b>MacOS</b> </td> <td width="25%" align="center"> <b>Linux</b> </td> </tr> <tr style="text-align: center"> <td align="center" valign="middle"> <a href='https://chatboxai.app/?c=download-windows'> <img src='./doc/statics/windows.png' style="height:24px; width: 24px" /> <br /> <b>Setup.exe</b> </a> </td> <td align="center" valign="middle"> <a href='https://chatboxai.app/?c=download-mac-intel'> <img src='./doc/statics/mac.png' style="height:24px; width: 24px" /> <br /> <b>Intel</b> </a> </td> <td align="center" valign="middle"> <a href='https://chatboxai.app/?c=download-mac-aarch'> <img src='./doc/statics/mac.png' style="height:24px; width: 24px" /> <br /> <b style="white-space: nowrap;">Apple Silicon</b> </a> </td> <td align="center" valign="middle"> <a href='https://chatboxai.app/?c=download-linux'> <img src='./doc/statics/linux.png' style="height:24px; width: 24px" /> <br /> <b>AppImage</b> </a> </td> </tr> </table>

iOS/Android

<a href='https://apps.apple.com/app/chatbox-ai/id6471368056' style='margin-right: 4px'> <img src='./doc/statics/app_store.webp' style="height:38px;" /> </a> <a href='https://play.google.com/store/apps/details?id=xyz.chatboxapp.chatbox' style='margin-right: 4px'> <img src='./doc/statics/google_play.png' style="height:38px;" /> </a> <a href='https://chatboxai.app/install?download=android_apk' style='margin-right: 4px; display: inline-flex; justify-content: center'> <img src='./doc/statics/android.png' style="height:28px; display: inline-block" /> .APK </a>

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

• Support for Multiple LLM Providers

• Image Generation with Dall-E-3

• Enhanced Prompting

🖥️ User Experience

• Local Data Storage

• No-Deployment Installation Packages

• Ergonomic UI & Dark Theme

• Keyboard Shortcuts

• Streaming Reply

📄 Content & Formatting

• Markdown, Latex & Code Highlighting

• Prompt Library & Message Quoting

👥 Collaboration & Sharing

• Team Collaboration

🌐 Platform Availability

• Cross-Platform Desktop

• Web Version

• Mobile Apps

🌍 Localization

• Multilingual Support

✨ More Features

• And More...

FAQ

• Frequently Asked Questions

How to Contribute

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

🐛 Reporting Issues

• Use GitHub Issues to report bugs or request features
• Before creating a new issue, please search existing issues to avoid duplicates
• Provide detailed information including steps to reproduce, expected behavior, and screenshots if applicable

🔧 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

• Translation files are located in the src/locales directory
• Follow the existing translation format
• Submit a PR with your translation improvements

📖 Documentation

• Improve README, API documentation, or user guides
• Fix typos or clarify unclear instructions
• Add examples and tutorials

🌟 Other Ways to Contribute

• Star the repository to show your support
• Share Chatbox with others
• Answer questions in GitHub Discussions
• Provide feedback and suggestions

Thank you for contributing! 🙏

Development

Prerequisites

Before you begin, ensure you have the following installed:

• Node.js (v20.x – v22.x) - Download here
• pnpm (v10.x or later) - Install via corepack enable && corepack prepare pnpm@latest --activate
• Git - Download here

Quick Setup

1. Clone the repository

   git clone https://github.com/chatboxai/chatbox.git
   cd chatbox

1. Install dependencies

   pnpm install

1. Start development server

   pnpm run dev

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

• Use pnpm run lint before committing to ensure code quality
• Follow the existing code style and patterns
• Test your changes on both light and dark themes
• Ensure cross-platform compatibility when making UI changes

Troubleshooting

Issue: pnpm install fails <ul><li><strong>Solution</strong>: Ensure you&#39;re using pnpm (not npm or yarn) and Node.js version is within the required range. Run <code>corepack enable</code> if pnpm is not found.</li></ul>

Issue: Build fails on Windows <ul><li><strong>Solution</strong>: Run <code>pnpm config set script-shell &quot;C:\\Program Files\\git\\bin\\bash.exe&quot;</code> if using Git Bash</li></ul>

Issue: Changes not reflecting in development <ul><li><strong>Solution</strong>: Stop the dev server, delete <code>node_modules/.vite</code>, and restart</li></ul>

Star History

[[image: Star History Chart]](https://star-history.com/#chatboxai/chatbox&Date)

Contact

Email

License

LICENSE