Skip to content

Commit f8b3033

Browse files
authored
Merge pull request #162 from GCWing/gcwing/dev
feat: redesign assistant workspace item and update UI polish
2 parents e6db53e + cba1f24 commit f8b3033

File tree

11 files changed

+904
-511
lines changed

11 files changed

+904
-511
lines changed

README.md

Lines changed: 72 additions & 63 deletions
Original file line numberDiff line numberDiff line change
@@ -4,87 +4,103 @@
44

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

7+
**AI assistant with personality and memory**
8+
9+
Hand over the work, keep the life
10+
11+
AI Agent workspace for coding and knowledge work
12+
713
</div>
814
<div align="center">
915

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

1421
</div>
1522

1623
---
24+
## Introduction
1725

18-
## A Word Up Front
26+
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.
1927

20-
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.
28+
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.
2129

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

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

26-
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.
34+
---
2735

28-
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.
36+
## Dual Modes
2937

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

32-
![BitFun](./png/first_screen_screenshot.png)
40+
- **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.
41+
- **Professional Mode**: token-efficient, execution-first, and context-clean. Best for short, focused tasks like fixing a bug or updating a small feature.
3342

34-
### Agent System
43+
---
3544

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

43-
### Code Agent Working Modes
47+
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.
4448

45-
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:
49+
The desktop generates a QR code, and the mobile browser opens the remote interface after scanning it, with no app installation required.
4650

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

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

56-
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:
59+
## Agent System
5760

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

6868
---
6969

70-
### Extensibility
70+
## Ecosystem
7171

72-
- **MCP Protocol**: Extend with external tools and resources via MCP servers; supports MCP Apps.
73-
- **Skills**: Markdown/script-based capability packages that teach the Agent specific tasks (auto-reads Cursor, Claude Code, Codex configs).
74-
- **Agent Customization**: Quickly define a specialized Agent's personality, memory scope, and capabilities with Markdown.
75-
- **Rules**: Project/global-level convention injection; auto-reads Cursor and other mainstream tool configs.
76-
- **Hooks (WIP🚧)**: Inject deterministic automation logic at key task milestones.
72+
> It keeps growing.
73+
74+
Mini Apps emerge from conversations, Skills evolve in the community, and Agents improve through collaboration.
75+
76+
| Layer | Description |
77+
|---|---|
78+
| **Mini Apps** | Generate runnable interfaces from a prompt and package them into desktop apps with one click |
79+
| **Skill Marketplace** | Install community capability packs so Agents can learn new skills quickly |
80+
| **MCP Protocol** | Connect external tools and resources to extend Agent capabilities beyond the local system |
81+
| **Custom Agents** | Define roles, memory, and capability boundaries with Markdown |
82+
| **ACP Protocol (WIP)** | A structured multi-Agent communication standard for interoperating with mainstream AI tools |
7783

7884
---
7985

86+
## Platform Support
87+
88+
The project is built with Rust + TypeScript for cross-platform reuse, keeping your Agent available wherever you work.
89+
90+
| Form Factor | Supported Platforms | Status |
91+
|---|---|---|
92+
| **Desktop** | Windows, macOS | ✅ Supported (Tauri) |
93+
| **Remote Control** | Mobile browser, Telegram, Feishu | ✅ Supported |
94+
95+
---
8096

8197
## Quick Start
8298

83-
### Use Directly
99+
### Download and Use
84100

85-
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.
101+
Download the latest desktop installer from [Releases](https://github.com/GCWing/BitFun/releases). After installation, configure your model and start using BitFun.
86102

87-
Other form factors are currently only specification drafts and not yet developed. If needed, please build from source.
103+
> CLI, Server, and native mobile apps are still in planning or development. Desktop and remote control are already supported.
88104
89105
### Build from Source
90106

@@ -106,38 +122,31 @@ pnpm run desktop:dev
106122
pnpm run desktop:build
107123
```
108124

109-
For more details, see the [Contributing Guide](./CONTRIBUTING.md).
110-
111-
## Platform Support
112-
113-
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.
114-
115-
| Form Factor | Supported Platforms | Status |
116-
|-------------|---------------------|--------|
117-
| **Desktop** (Tauri) | Windows, macOS | ✅ Supported |
118-
| **CLI** | Windows, macOS, Linux | 🚧 In Development |
119-
| **Server** | - | 🚧 In Development |
120-
| **Mobile** (Native App) | iOS, Android | 🚧 In Development |
121-
| **Social Platform Integration** | Telegram, WhatsApp, Discord, etc. | 🚧 In Development |
122-
125+
For more details, see the [Chinese Contributing Guide](./CONTRIBUTING_CN.md).
123126

127+
---
124128

125129
## Contributing
126-
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.
130+
131+
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.
127132

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

139+
---
134140

135141
## Disclaimer
136-
1. This project is built in spare time for exploring and researching next-generation human–machine collaborative interaction, not for commercial profit.
137-
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.
142+
143+
1. This project is built in spare time for exploring and researching next-generation human-machine collaboration, not for commercial profit.
144+
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.
138145
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.**
139146

140147
---
141148
<div align="center">
142-
The world is being rewritten—this time, we are all holding the pen.
149+
150+
The world is being rewritten, and this time, we are all holding the pen.
151+
143152
</div>

0 commit comments

Comments
 (0)