Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
135 changes: 72 additions & 63 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,87 +4,103 @@

![BitFun](./png/BitFun_title.png)

**AI assistant with personality and memory**

Hand over the work, keep the life

AI Agent workspace for coding and knowledge work

</div>
<div align="center">

[![GitHub release](https://img.shields.io/github/v/release/GCWing/BitFun?style=flat-square&color=blue)](https://github.com/GCWing/BitFun/releases)
[![Website](https://img.shields.io/badge/Website-openbitfun.com-6f42c1?style=flat-square)](https://openbitfun.com/)
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow?style=flat-square)](https://github.com/GCWing/BitFun/blob/main/LICENSE)
[![Platform](https://img.shields.io/badge/platform-Windows%20%7C%20macOS-blue?style=flat-square)](https://github.com/GCWing/BitFun)

</div>

---
## Introduction

## A Word Up Front
In the age of AI, true human-machine collaboration is not just a ChatBox, but a partner that understands you, works with you, keeps evolving, and gets things done anytime, anywhere. That is where BitFun begins.

In the age of AI, true human–machine collaboration isn't just a ChatBox — it's a partner that knows you, accompanies you, and gets things done for you anywhere, anytime. That's where BitFun's exploration begins.
BitFun is a next-generation AI assistant with built-in **Code Agent** and **Cowork Agent**. It has memory, personality, and the ability to evolve over time. You can remotely control the desktop through mobile QR pairing or Telegram / Feishu bots, send instructions, and watch each execution step in real time while the Agent keeps working in the background.

## What Is BitFun
Built with **Rust + TypeScript** for an ultra-lightweight, fluid, cross-platform experience.

BitFun is a next-generation Agent system built around the idea of **"AI assistants with personality and memory"**.
![BitFun](./png/first_screen_screenshot.png)

Every user has their own Agent assistant — one that remembers your habits and preferences, carries a unique personality, and keeps growing over time. On top of this assistant, BitFun ships with two built-in capabilities: **Code Agent** (coding assistant) and **Cowork Agent** (knowledge work assistant), along with a unified extension mechanism to define additional Agent roles as needed.
---

Your assistant isn't confined to the desktop — it can be reached through multiple channels, such as Telegram, WhatsApp, and other social platforms, letting you issue instructions anytime, anywhere. Tasks keep running in the background, and you check in or give feedback whenever convenient.
## Dual Modes

Built with **Rust + TypeScript** for an ultra-lightweight, fluid, cross-platform experience.
BitFun provides two modes for different kinds of work:

![BitFun](./png/first_screen_screenshot.png)
- **Assistant Mode**: warmer, preference-aware, and backed by long-term memory. Best for ongoing collaboration, such as maintaining a project or preserving your writing and design style.
- **Professional Mode**: token-efficient, execution-first, and context-clean. Best for short, focused tasks like fixing a bug or updating a small feature.

### Agent System
---

| Agent | Role | Core Capabilities |
|---|---|---|
| **Personal Assistant (WIP🚧)** (default) | Your dedicated AI companion | Long-term memory, personality settings, cross-scenario orchestration, continuous growth |
| **Code Agent** | Coding assistant | Conversation-driven coding, multi-mode task execution, autonomous read / edit / run / verify |
| **Cowork Agent** | Knowledge work assistant | File management, document generation, report organization, autonomous multi-step task execution |
| **Custom Agent** | Domain specialist | Quickly define a domain-specific Agent with Markdown |
## Remote Control

### Code Agent Working Modes
With QR pairing, your phone instantly becomes a remote command center for the desktop Agent. Send one message and the desktop AI starts working right away.

Code Agent is built for software development, offering multiple modes that cover the full cycle from day-to-day coding to deep debugging, with deep integration into MCP, Skills, and Rules:
The desktop generates a QR code, and the mobile browser opens the remote interface after scanning it, with no app installation required.

| Mode | Scenario | Characteristics |
|------|----------|-----------------|
| **Agentic** | Day-to-day coding | Conversation-driven; AI autonomously reads, edits, runs, and verifies. |
| **Plan** | Complex tasks | Plan first, then execute; align on critical changes upfront. |
| **Debug** | Hard problems | Instrument & trace → compare paths → root-cause analysis → verify fix. |
| **Review** | Code review | Review code based on key repository conventions. |
Besides mobile QR pairing, BitFun also supports Telegram / Feishu bots for remote instructions and real-time progress tracking.

### Cowork Agent Workflow
| Feature | Description |
|---|---|
| **QR Pairing** | Scan a QR code generated by the desktop, complete key exchange, and bind a long-lived connection |
| **Full Control** | View sessions, switch modes, send instructions, and control the desktop workflow remotely |
| **Real-time Streaming** | Every Agent step and tool call can be viewed live on your phone |

Cowork Agent is designed for everyday work, following a "clarify first, execute next, stay trackable" collaboration principle, with built-in office Skills and access to the Skill marketplace:
## Agent System

| Skill | Trigger | Core Capabilities |
| Agent | Role | Core Capabilities |
|---|---|---|
| **PDF** | Working with .pdf files | Read/extract text & tables, merge/split/rotate, watermark, fill forms, encrypt/decrypt, OCR scanned PDFs |
| **DOCX** | Create or edit Word documents | Create/edit .docx, styles/TOC/headers & footers, image insertion, comments & tracked changes |
| **XLSX** | Working with spreadsheets | Create/analyze .xlsx/.csv, formulas & formatting, financial model standards (color coding, formula validation) |
| **PPTX** | Build presentations | Create/edit .pptx from scratch, visual design guidelines, automated visual QA |
| **agent-browser** | Browser interaction needed | Browser automation: open pages, click/fill forms, screenshot, scrape data, web app testing |
| **skill-creator** | Creating a custom Skill | Guides authoring new Skills to extend the Agent's domain-specific capabilities |
| **find-skills** | Looking for ready-made capabilities | Discover and install community-contributed reusable Skills from the Skill marketplace |
| **Personal Assistant** (Beta) | Your dedicated AI companion | Long-term memory and personality settings; can orchestrate Code / Cowork / custom Agents on demand, and continuously evolve |
| **Code Agent** | Coding assistant | Four modes: Agentic (autonomous read / edit / run / verify) / Plan (plan first, then execute) / Debug (instrumentation to root cause) / Review (repository-aware code review) |
| **Cowork Agent** | Knowledge work assistant | Built-in PDF / DOCX / XLSX / PPTX handling, and can fetch and extend suitable capability packages from the Skill marketplace |
| **Custom Agent** | Domain specialist | Quickly define a domain-specific Agent with Markdown |

---

### Extensibility
## Ecosystem

- **MCP Protocol**: Extend with external tools and resources via MCP servers; supports MCP Apps.
- **Skills**: Markdown/script-based capability packages that teach the Agent specific tasks (auto-reads Cursor, Claude Code, Codex configs).
- **Agent Customization**: Quickly define a specialized Agent's personality, memory scope, and capabilities with Markdown.
- **Rules**: Project/global-level convention injection; auto-reads Cursor and other mainstream tool configs.
- **Hooks (WIP🚧)**: Inject deterministic automation logic at key task milestones.
> It keeps growing.

Mini Apps emerge from conversations, Skills evolve in the community, and Agents improve through collaboration.

| Layer | Description |
|---|---|
| **Mini Apps** | Generate runnable interfaces from a prompt and package them into desktop apps with one click |
| **Skill Marketplace** | Install community capability packs so Agents can learn new skills quickly |
| **MCP Protocol** | Connect external tools and resources to extend Agent capabilities beyond the local system |
| **Custom Agents** | Define roles, memory, and capability boundaries with Markdown |
| **ACP Protocol (WIP)** | A structured multi-Agent communication standard for interoperating with mainstream AI tools |

---

## Platform Support

The project is built with Rust + TypeScript for cross-platform reuse, keeping your Agent available wherever you work.

| Form Factor | Supported Platforms | Status |
|---|---|---|
| **Desktop** | Windows, macOS | ✅ Supported (Tauri) |
| **Remote Control** | Mobile browser, Telegram, Feishu | ✅ Supported |

---

## Quick Start

### Use Directly
### Download and Use

Download the latest installer for the desktop app from [Release](https://github.com/GCWing/BitFun/releases). After installation, configure your model and you're ready to go.
Download the latest desktop installer from [Releases](https://github.com/GCWing/BitFun/releases). After installation, configure your model and start using BitFun.

Other form factors are currently only specification drafts and not yet developed. If needed, please build from source.
> CLI, Server, and native mobile apps are still in planning or development. Desktop and remote control are already supported.

### Build from Source

Expand All @@ -106,38 +122,31 @@ pnpm run desktop:dev
pnpm run desktop:build
```

For more details, see the [Contributing Guide](./CONTRIBUTING.md).

## Platform Support

The project uses a Rust + TypeScript tech stack, supporting cross-platform and multi-form-factor reuse — keeping your Agent assistant always online and reachable everywhere.

| Form Factor | Supported Platforms | Status |
|-------------|---------------------|--------|
| **Desktop** (Tauri) | Windows, macOS | ✅ Supported |
| **CLI** | Windows, macOS, Linux | 🚧 In Development |
| **Server** | - | 🚧 In Development |
| **Mobile** (Native App) | iOS, Android | 🚧 In Development |
| **Social Platform Integration** | Telegram, WhatsApp, Discord, etc. | 🚧 In Development |

For more details, see the [Chinese Contributing Guide](./CONTRIBUTING_CN.md).

---

## Contributing
We welcome great ideas and code contributions. We are maximally accepting of AI-generated code. Please submit PRs to the dev branch first; we will periodically review and sync to the main branch.

We welcome great ideas and code contributions. We are maximally accepting of AI-generated code. Please submit PRs to the `dev` branch first; we will periodically review and sync to the main branch.

Key contribution areas we focus on:
1. Contributing good ideas/creativity (features, interactions, visuals, etc.), submit issues
2. Optimizing the Agent system and its effectiveness
1. Contributing good ideas and creativity in features, interaction, and visual design via Issues
2. Optimizing the Agent system and overall quality
3. Improving system stability and foundational capabilities
4. Expanding the ecosystem (Skills, MCP, LSP plugins, or better support for specific vertical development scenarios)
4. Expanding the ecosystem, including Skills, MCP, LSP plugins, and support for vertical development scenarios

---

## Disclaimer
1. This project is built in spare time for exploring and researching next-generation human–machine collaborative interaction, not for commercial profit.
2. 97%+ of this project was built with Vibe Coding. Feedback on code issues is also welcome—refactoring and optimization can be done via AI.

1. This project is built in spare time for exploring and researching next-generation human-machine collaboration, not for commercial profit.
2. 97%+ of this project was built with Vibe Coding. Feedback on code issues is also welcome, and refactoring or optimization through AI is encouraged.
3. This project depends on and references many open-source projects. Thanks to all open-source authors. **If your rights are affected, please contact us for rectification.**

---
<div align="center">
The world is being rewritten—this time, we are all holding the pen.

The world is being rewritten, and this time, we are all holding the pen.

</div>
Loading
Loading