From 998783d7486af537a18ef92810eb197381ddd977 Mon Sep 17 00:00:00 2001 From: uiharuayako <2451602772@qq.com> Date: Fri, 18 Sep 2026 12:17:14 +0800 Subject: [PATCH] docs: add reviewable OpenBitFun 1.0 wiki text sources --- docs/wiki/README.md | 87 +++++++++++++++++++ docs/wiki/README.zh-CN.md | 47 ++++++++++ docs/wiki/check-links.mjs | 67 ++++++++++++++ docs/wiki/pages/Agent-Modes.md | 37 ++++++++ .../pages/Agent-\346\250\241\345\274\217.md" | 37 ++++++++ docs/wiki/pages/Coding-Workspace.md | 34 ++++++++ docs/wiki/pages/Cowork-and-Creation.md | 37 ++++++++ ...k-\344\270\216\345\210\233\344\275\234.md" | 37 ++++++++ docs/wiki/pages/Customize-and-Extend.md | 41 +++++++++ docs/wiki/pages/Detached-Dispatch.md | 34 ++++++++ docs/wiki/pages/FAQ.md | 71 +++++++++++++++ docs/wiki/pages/Getting-Started.md | 44 ++++++++++ docs/wiki/pages/Home.md | 31 +++++++ docs/wiki/pages/Mini-Apps-and-Pages.md | 44 ++++++++++ .../pages/Mini-Apps-\344\270\216-Pages.md" | 44 ++++++++++ ...r-Device-Mode-\344\270\255\346\226\207.md" | 31 +++++++ docs/wiki/pages/Peer-Device-Mode.md | 31 +++++++ docs/wiki/pages/Personal-Assistant.md | 31 +++++++ docs/wiki/pages/Product-Overview.md | 42 +++++++++ docs/wiki/pages/Remote-and-Multi-device.md | 44 ++++++++++ docs/wiki/pages/Screenshot-Checklist.md | 57 ++++++++++++ docs/wiki/pages/Security-and-Privacy.md | 46 ++++++++++ docs/wiki/pages/Sessions-and-Goals.md | 35 ++++++++ docs/wiki/pages/Tasks-and-Automation.md | 33 +++++++ docs/wiki/pages/Voice-and-Realtime.md | 35 ++++++++ docs/wiki/pages/_Footer.md | 3 + docs/wiki/pages/_Sidebar.md | 50 +++++++++++ ...52\344\272\272\345\212\251\346\211\213.md" | 31 +++++++ ...47\345\223\201\345\205\250\346\231\257.md" | 42 +++++++++ ...32\346\227\266\344\273\273\345\212\241.md" | 33 +++++++ ...01\347\273\255\347\233\256\346\240\207.md" | 35 ++++++++ ...50\344\270\216\351\232\220\347\247\201.md" | 46 ++++++++++ ...70\350\247\201\351\227\256\351\242\230.md" | 71 +++++++++++++++ ...53\351\200\237\345\274\200\345\247\213.md" | 44 ++++++++++ ...52\345\233\276\346\270\205\345\215\225.md" | 57 ++++++++++++ ...13\345\267\245\344\275\234\345\217\260.md" | 34 ++++++++ ...11\344\270\216\346\211\251\345\261\225.md" | 41 +++++++++ ...36\346\227\266\351\200\232\350\257\235.md" | 35 ++++++++ ...16\345\244\232\350\256\276\345\244\207.md" | 44 ++++++++++ ...73\345\212\241\346\264\276\345\217\221.md" | 34 ++++++++ "docs/wiki/pages/\351\246\226\351\241\265.md" | 31 +++++++ 41 files changed, 1708 insertions(+) create mode 100644 docs/wiki/README.md create mode 100644 docs/wiki/README.zh-CN.md create mode 100644 docs/wiki/check-links.mjs create mode 100644 docs/wiki/pages/Agent-Modes.md create mode 100644 "docs/wiki/pages/Agent-\346\250\241\345\274\217.md" create mode 100644 docs/wiki/pages/Coding-Workspace.md create mode 100644 docs/wiki/pages/Cowork-and-Creation.md create mode 100644 "docs/wiki/pages/Cowork-\344\270\216\345\210\233\344\275\234.md" create mode 100644 docs/wiki/pages/Customize-and-Extend.md create mode 100644 docs/wiki/pages/Detached-Dispatch.md create mode 100644 docs/wiki/pages/FAQ.md create mode 100644 docs/wiki/pages/Getting-Started.md create mode 100644 docs/wiki/pages/Home.md create mode 100644 docs/wiki/pages/Mini-Apps-and-Pages.md create mode 100644 "docs/wiki/pages/Mini-Apps-\344\270\216-Pages.md" create mode 100644 "docs/wiki/pages/Peer-Device-Mode-\344\270\255\346\226\207.md" create mode 100644 docs/wiki/pages/Peer-Device-Mode.md create mode 100644 docs/wiki/pages/Personal-Assistant.md create mode 100644 docs/wiki/pages/Product-Overview.md create mode 100644 docs/wiki/pages/Remote-and-Multi-device.md create mode 100644 docs/wiki/pages/Screenshot-Checklist.md create mode 100644 docs/wiki/pages/Security-and-Privacy.md create mode 100644 docs/wiki/pages/Sessions-and-Goals.md create mode 100644 docs/wiki/pages/Tasks-and-Automation.md create mode 100644 docs/wiki/pages/Voice-and-Realtime.md create mode 100644 docs/wiki/pages/_Footer.md create mode 100644 docs/wiki/pages/_Sidebar.md create mode 100644 "docs/wiki/pages/\344\270\252\344\272\272\345\212\251\346\211\213.md" create mode 100644 "docs/wiki/pages/\344\272\247\345\223\201\345\205\250\346\231\257.md" create mode 100644 "docs/wiki/pages/\344\273\273\345\212\241\346\235\277\344\270\216\345\256\232\346\227\266\344\273\273\345\212\241.md" create mode 100644 "docs/wiki/pages/\344\274\232\350\257\235\344\270\216\346\214\201\347\273\255\347\233\256\346\240\207.md" create mode 100644 "docs/wiki/pages/\345\256\211\345\205\250\344\270\216\351\232\220\347\247\201.md" create mode 100644 "docs/wiki/pages/\345\270\270\350\247\201\351\227\256\351\242\230.md" create mode 100644 "docs/wiki/pages/\345\277\253\351\200\237\345\274\200\345\247\213.md" create mode 100644 "docs/wiki/pages/\346\210\252\345\233\276\346\270\205\345\215\225.md" create mode 100644 "docs/wiki/pages/\347\274\226\347\250\213\345\267\245\344\275\234\345\217\260.md" create mode 100644 "docs/wiki/pages/\350\207\252\345\256\232\344\271\211\344\270\216\346\211\251\345\261\225.md" create mode 100644 "docs/wiki/pages/\350\257\255\351\237\263\344\270\216\345\256\236\346\227\266\351\200\232\350\257\235.md" create mode 100644 "docs/wiki/pages/\350\277\234\347\250\213\344\270\216\345\244\232\350\256\276\345\244\207.md" create mode 100644 "docs/wiki/pages/\350\277\234\347\250\213\344\273\273\345\212\241\346\264\276\345\217\221.md" create mode 100644 "docs/wiki/pages/\351\246\226\351\241\265.md" diff --git a/docs/wiki/README.md b/docs/wiki/README.md new file mode 100644 index 0000000000..1a78ecb6d7 --- /dev/null +++ b/docs/wiki/README.md @@ -0,0 +1,87 @@ +# GitHub Wiki text sources + +[中文](README.zh-CN.md) + +This directory contains reviewable OpenBitFun 1.0 Wiki text. The publishable +Markdown is in `pages/`; `_Sidebar.md` and `_Footer.md` are Wiki navigation files. +There are no screenshot assets in this update. The bilingual screenshot checklist +records pending topics and capture requirements for a later contribution. + +## Read and review + +- [Home](pages/Home.md) / [中文首页](pages/首页.md) +- [Harness selection](pages/Agent-Modes.md) / [Harness 与智能体](pages/Agent-模式.md) +- [Sessions and goals](pages/Sessions-and-Goals.md) / [会话与持续目标](pages/会话与持续目标.md) +- [Scheduling](pages/Tasks-and-Automation.md) / [定时任务](pages/任务板与定时任务.md) +- [Remote guide](pages/Remote-and-Multi-device.md) / [远程指南](pages/远程与多设备.md) +- [Peer Device Mode](pages/Peer-Device-Mode.md) / [设备控制](pages/Peer-Device-Mode-中文.md) +- [Detached Dispatch](pages/Detached-Dispatch.md) / [远程派发](pages/远程任务派发.md) +- [Voice](pages/Voice-and-Realtime.md) / [语音](pages/语音与实时通话.md) +- [Screenshot checklist](pages/Screenshot-Checklist.md) / [截图清单](pages/截图清单.md) + +The page bodies intentionally use extensionless Wiki links such as `(Home)`. +These resolve after publication to the Wiki, not as ordinary `.md` links in the +main repository. Use the file browser or this index during PR review. Keep page +filenames stable so existing Wiki URLs and cross-language links continue working. + +Text is based on v1.0.0 documentation and development revision f72a28eb8, checked +on 2026-09-18. Review of source documentation is not runtime or remote scenario +testing. The Playbook remains the detailed, source-backed feature/settings +reference; Wiki pages provide conceptual and scenario-oriented guidance. + +## Verification + +From the main repository root: + +```bash +node docs/wiki/check-links.mjs +pnpm run check:repo-hygiene +git diff --check +``` + +The focused check validates Wiki targets, language counterparts, local paths for +versioned source references, and screenshot topic/placeholder consistency. It does +not verify remote URLs, image availability, or application behavior. + +## Publication is separate from PR merge + +GitHub does not provide native pull requests for a `.wiki.git` repository. +The [Wiki editing guide](https://docs.github.com/en/communities/documenting-your-project-with-wikis/adding-or-editing-wiki-pages) +describes editing/cloning the separate Git repository; Wiki PR support is tracked +in [GitHub Community](https://github.com/orgs/community/discussions/50163). + +Merge text changes into the main repository through a normal PR. A maintainer +with Wiki write access must then review and publish them separately. This update +adds no automatic synchronization, workflow, credential, or permission changes. +The main repository's `GITHUB_TOKEN` must not be assumed to grant Wiki write access. + +The upstream Wiki snapshot reviewed for this refresh is +`f143e0b13a631909a3aa6818d43646c95a8a9b83`. + +To publish, start from a fresh Wiki clone and compare its HEAD with that snapshot. +If it differs, stop and reconcile intervening edits before copying any pages. +Work from the reviewed main-repository revision, not an unreviewed working copy. + +```bash +# Run from the reviewed main-repository checkout. +wiki_publish_dir=$(mktemp -d) +git clone https://github.com/GCWing/OpenBitFun.wiki.git "$wiki_publish_dir/wiki" +git -C "$wiki_publish_dir/wiki" log -1 --format=%H +``` + +Only after checking the snapshot and reconciling any newer Wiki changes: + +```bash +cp docs/wiki/pages/*.md "$wiki_publish_dir/wiki/" +git -C "$wiki_publish_dir/wiki" status --short +git -C "$wiki_publish_dir/wiki" diff --check +git -C "$wiki_publish_dir/wiki" diff +git -C "$wiki_publish_dir/wiki" add -- '*.md' +git -C "$wiki_publish_dir/wiki" commit -m "docs: refresh OpenBitFun 1.0 wiki text" +git -C "$wiki_publish_dir/wiki" push origin HEAD:master +``` + +Copy only `pages/*.md`, not this README or the checker. Do not delete unlisted +pages, force-push, or overwrite intervening edits. Review the exact diff before +pushing. After publication, inspect both language home pages, sidebar, and links. +Screenshots remain a separate follow-up and are not a prerequisite for this text PR. diff --git a/docs/wiki/README.zh-CN.md b/docs/wiki/README.zh-CN.md new file mode 100644 index 0000000000..2c9f70526e --- /dev/null +++ b/docs/wiki/README.zh-CN.md @@ -0,0 +1,47 @@ +# GitHub Wiki 文字来源与发布 + +[English](README.md) + +此目录用于通过主仓库 PR 审阅 OpenBitFun 1.0 Wiki 文字。可发布的 Markdown +位于 `pages/`，包含侧边栏和页脚；本次不添加截图素材，只保留截图占位与清单。 + +## 阅读入口 + +- [首页](pages/首页.md)与[产品全景](pages/产品全景.md) +- [Harness 与智能体](pages/Agent-模式.md) +- [会话与持续目标](pages/会话与持续目标.md) +- [任务板与定时任务](pages/任务板与定时任务.md) +- [远程与多设备](pages/远程与多设备.md)、[设备控制](pages/Peer-Device-Mode-中文.md)、[远程派发](pages/远程任务派发.md) +- [语音与实时通话](pages/语音与实时通话.md) +- [待补截图清单](pages/截图清单.md) + +正文保留 Wiki 使用的无扩展名链接，如 `(首页)`。它们发布到 Wiki 后才按 Wiki +页面解析，不是主仓库中的普通 `.md` 链接；审阅时使用文件列表或此索引。 +保留原页面文件名，以兼容旧 URL 和中英文互链。 + +核验基于 v1.0.0 文档及开发版本 f72a28eb8，日期为 2026-09-18；源码文档核对 +不等于运行或远程实测。Playbook 继续提供完整功能/设置参考，Wiki 提供概念与场景教程。 + +## 检查与发布 + +在主仓库根目录运行： + +```bash +node docs/wiki/check-links.mjs +pnpm run check:repo-hygiene +git diff --check +``` + +检查器校验 Wiki 目标、中英文互链、版本化源码引用的本地文件与截图主题/占位一致性， +不验证线上 URL、图片加载或应用行为。 + +GitHub Wiki 使用独立的 `.wiki.git` 仓库，没有原生 PR 合并流程。 +本 PR 合入主仓库后，不会自动更新线上 Wiki。需要拥有 Wiki 写权限的维护者， +另行核对并发布。本次不引入自动同步、工作流、凭据或权限变更。 + +本次核对的上游 Wiki 提交为 `f143e0b13a631909a3aa6818d43646c95a8a9b83`。 +发布前应新克隆 Wiki，检查 HEAD；若已有新提交，停止复制并先整合新增修改。 +仅从已审阅的主仓库版本复制 `pages/*.md`，不复制 README 或检查器，不删除未列出的 +页面，不强制推送。具体命令见[英文发布指南](README.md#publication-is-separate-from-pr-merge)。 + +发布后检查双语首页、导航和链接。截图以后单独补充，不阻塞本次文字 PR。 diff --git a/docs/wiki/check-links.mjs b/docs/wiki/check-links.mjs new file mode 100644 index 0000000000..15c2671940 --- /dev/null +++ b/docs/wiki/check-links.mjs @@ -0,0 +1,67 @@ +import { existsSync, readFileSync, readdirSync } from 'node:fs'; +import path from 'node:path'; +import { fileURLToPath } from 'node:url'; + +const wikiRoot = fileURLToPath(new URL('./pages/', import.meta.url)); +const repoRoot = fileURLToPath(new URL('../../', import.meta.url)); +const pages = readdirSync(wikiRoot).filter(name => name.endsWith('.md')); +const errors = []; +const pending = new Map(); +const checklistTopics = []; + +for (const name of pages) { + const content = readFileSync(path.join(wikiRoot, name), 'utf8'); + for (const [, target] of content.matchAll(/\]\(([^)]+)\)/g)) { + if (/^(https?:|#)/.test(target)) { + const source = target.match(/^https:\/\/github\.com\/GCWing\/OpenBitFun\/blob\/v1\.0\.0\/([^#]+)/); + if (source && !existsSync(path.join(repoRoot, decodeURIComponent(source[1])))) { + errors.push(`${name}: missing source reference ${source[1]}`); + } + continue; + } + const page = decodeURIComponent(target.split('#')[0]); + if (!existsSync(path.join(wikiRoot, `${page}.md`))) { + errors.push(`${name}: missing Wiki target ${target}`); + } + } + if (!name.startsWith('_')) { + const counterpart = content.split('\n')[0].match(/\]\(([^)]+)\)/)?.[1]; + const counterpartPath = counterpart && path.join(wikiRoot, `${counterpart}.md`); + if (!counterpartPath || !existsSync(counterpartPath)) { + errors.push(`${name}: missing language counterpart`); + } else { + const firstLine = readFileSync(counterpartPath, 'utf8').split('\n')[0]; + if (!firstLine.includes(`](${name.slice(0, -3)})`)) { + errors.push(`${name}: counterpart does not link back`); + } + } + } + if (name === 'Screenshot-Checklist.md' || name === '截图清单.md') { + checklistTopics.push(new Set([...content.matchAll(/^\| (S\d+) \|/gm)].map(m => m[1]))); + } + for (const line of content.split('\n').filter(line => /^> (Screenshot pending:|待补截图：)/.test(line))) { + for (const id of line.match(/S\d+/g) ?? []) { + const locations = pending.get(id) ?? new Set(); + locations.add(name); + pending.set(id, locations); + } + } +} + +const [english, chinese] = checklistTopics; +if (!english || !chinese || english.size === 0 || english.size !== chinese.size || [...english].some(id => !chinese.has(id))) { + errors.push('Screenshot checklist topics differ between languages or are empty'); +} +for (const id of english ?? []) { + if (pending.get(id)?.size !== 2) errors.push(`${id}: expected one placeholder in each language`); +} +for (const id of pending.keys()) { + if (!english?.has(id)) errors.push(`${id}: placeholder absent from screenshot checklist`); +} + +if (errors.length) { + console.error(errors.join('\n')); + process.exitCode = 1; +} else { + console.log(`Wiki checks passed: ${pages.length} Markdown files, ${pending.size} screenshot topics.`); +} diff --git a/docs/wiki/pages/Agent-Modes.md b/docs/wiki/pages/Agent-Modes.md new file mode 100644 index 0000000000..37990064b6 --- /dev/null +++ b/docs/wiki/pages/Agent-Modes.md @@ -0,0 +1,37 @@ +[English] | [简体中文](Agent-模式) · [Home](Home) + +# Harnesses and Agent selection + +## Choose how the task runs + +OpenBitFun 1.0 exposes four general Harnesses. They apply across coding, research, writing, and analysis; choose by the collaboration you need, not only by output format. + +| Harness | When to choose it | Example | +| --- | --- | --- | +| Minimal | Clear scope and quick iteration | “Explain this function, then answer my follow-up.” | +| Standard | Several dependent steps | “Analyze these files, propose changes, implement them, and verify.” | +| Ultimate | Demanding investigation or coordinated work | “Investigate this system and compare approaches before implementation.” | +| Creative | Build or extend your workspace | “Create a Mini App for repository insights.” | + +Creative can work on client UI and runtime capabilities through its available tools. Distinguish installed-client customization from changing a source checkout; source changes still need the normal build and review workflow. Review requested access and keep a recovery path. + +## Select a Harness or specialist Agent + +1. Create a session in the intended project or assistant workspace. +2. Open the session execution selector in the chat input menu. +3. Choose a Harness, or select a visible specialist/custom Agent. +4. Check the model and permission settings before sending the first request. + +The Harness is selected before the first turn. Once a session has started, choosing another execution profile asks to start a new session rather than silently changing the current run. Legacy sessions also retain their existing execution identity. + +## Harness, Agent, tool, and workflow are different + +A custom Agent can have its own instructions, model choice, tools, Skills, and read-only constraints. Browser automation and computer interaction are capabilities. Planning, debugging, and research are also tasks you can request in ordinary language. + +Older guides listed Agentic, Plan, Debug, Multitask, Cowork, Computer Use, Deep Research, Team, and Claw as equivalent modes. That list is not the current general Harness chooser. Some names remain specialist identities or compatibility identifiers; an old name is not evidence of a current mode button. + +For “plan first,” explicitly ask for a proposal without edits. Harness selection itself is not permission to implement, publish, or perform destructive actions. + +[Agent configuration](Customize-and-Extend) · [Sessions](Sessions-and-Goals) + +> Screenshot pending: S03 — Harness chooser; S04 — started-session confirmation. diff --git "a/docs/wiki/pages/Agent-\346\250\241\345\274\217.md" "b/docs/wiki/pages/Agent-\346\250\241\345\274\217.md" new file mode 100644 index 0000000000..a9221ce593 --- /dev/null +++ "b/docs/wiki/pages/Agent-\346\250\241\345\274\217.md" @@ -0,0 +1,37 @@ +[简体中文] | [English](Agent-Modes) · [首页](首页) + +# Harness 与智能体选择 + +## 选择任务的推进方式 + +OpenBitFun 1.0 提供四种通用 Harness。它们可以用于编程、调研、写作和分析；应按协作方式选择，而不是只按成果格式选择。 + +| Harness | 何时选择 | 示例 | +| --- | --- | --- | +| Minimal | 范围明确、需要快速反馈 | “解释这个函数，再回答我的追问。” | +| Standard | 有多个依赖步骤 | “分析这些文件，提出改动，实施并验证。” | +| Ultimate | 复杂调查或协调工作 | “调查这个系统，比较方案，再实施。” | +| Creative | 创建或扩展工作空间 | “制作一个仓库洞察 Mini App。” | + +Creative 可通过可用工具修改客户端界面与运行时能力。要区分已安装客户端定制和修改源码仓库；源码修改仍需正常构建与审查。确认所需权限，并保留恢复路径。 + +## 选择 Harness 或专门智能体 + +1. 在目标项目或助理工作区新建会话。 +2. 打开聊天输入菜单中的会话执行选择器。 +3. 选择 Harness，或选择当前可见的专门/自定义智能体。 +4. 发送第一条消息前，核对模型与权限设置。 + +Harness 在首轮任务前选择。会话开始后，改选其他执行配置会要求确认新建会话，而不是悄悄改变当前运行方式；旧会话也保留其既有执行身份。 + +## 不要混淆 Harness、智能体、工具和流程 + +自定义智能体可以配置角色指令、模型、工具、Skills 与只读限制。浏览器自动化、电脑操作是能力；规划、调试、调研也可以直接用自然语言提出。 + +旧指南曾将 Agentic、Plan、Debug、Multitask、Cowork、Computer Use、Deep Research、Team、Claw 并列为模式。这不是当前通用 Harness 选择器。一些名称仍作为专门角色或兼容标识保留，不能据此推断存在同名模式按钮。 + +如果希望“先规划”，明确说明“先给方案，不要修改”。选择 Harness 本身不构成实施、发布或破坏性操作的授权。 + +[智能体配置](自定义与扩展) · [会话管理](会话与持续目标) + +> 待补截图：S03 — Harness 选择器；S04 — 已开始会话的改选确认。 diff --git a/docs/wiki/pages/Coding-Workspace.md b/docs/wiki/pages/Coding-Workspace.md new file mode 100644 index 0000000000..e5705d8005 --- /dev/null +++ b/docs/wiki/pages/Coding-Workspace.md @@ -0,0 +1,34 @@ +[English] | [简体中文](编程工作台) · [Home](Home) + +# Coding workspace + +## From a request to an inspectable change + +1. Open the correct project and check whether it is local, SSH, container, WSL, or peer-owned. +2. Ask the Agent to inspect the relevant code and explain its findings. For planning-only work, explicitly prohibit edits. +3. Review the approach, then authorize implementation within the intended scope. +4. Run the project's checks and inspect diffs and unresolved failures. +5. Review changes before committing, pushing, or publishing. + +Use [Harness selection](Agent-Modes) for the execution approach. Debugging, planning, research, and review do not require the old mode buttons described in earlier guides. + +## Integrated tools + +- Files and editor: browse and organize material, search, edit code/text, view Markdown/images and diffs, and use available language services or inline AI. +- Terminal: run commands, use multiple terminal views, and inspect background processes. +- Git: inspect changes, history, branches, and worktrees; stage, commit, push, or pull with the appropriate authorization. +- Browser: inspect pages, follow supported interactions, and collect visual evidence. +- Review: ask for actionable findings or use the available review workflow. Read-only review must not silently implement fixes. +- Sessions: preserve separate conversations, inspect modified files, and manage history; see [sessions](Sessions-and-Goals). + +Language intelligence and browser/computer actions depend on configured services and OS permissions. A successful command does not prove the resulting application works. + +## Recovery is not a blanket backup + +Session forks copy conversation history, not an independent filesystem. Snapshot and rollback capabilities depend on recorded coverage and target support; they are not protection for every command or external side effect. + +For remote sessions, full file rollback and edit-and-rerun are currently unavailable until coverage can be verified. Some recorded operations can still show diffs after disconnect. Use Git commits and backups for recovery; do not assume a conversation fork isolates work. + +[Remote guide](Remote-and-Multi-device) · [CLI reference](https://github.com/GCWing/OpenBitFun/blob/v1.0.0/src/apps/cli/README.md) + +> Screenshot pending: S08 — editor, terminal, and session; S09 — Git changes and review. diff --git a/docs/wiki/pages/Cowork-and-Creation.md b/docs/wiki/pages/Cowork-and-Creation.md new file mode 100644 index 0000000000..590b7ec443 --- /dev/null +++ b/docs/wiki/pages/Cowork-and-Creation.md @@ -0,0 +1,37 @@ +[English] | [简体中文](Cowork-与创作) · [Home](Home) + +# Research, office work, and creation + +This page keeps its old address for existing links. The workflows below do not require a separate Cowork mode. + +## Work from an outcome + +Give the Agent the source material, intended audience, desired format, and success criteria. Choose a [Harness](Agent-Modes) for the task's complexity, and ensure the relevant Skills, tools, model, and dependencies are available. + +Examples: + +- “Research this topic, compare sources, and write a referenced brief.” +- “Turn these notes into an editable slide deck.” +- “Analyze this workbook; preserve the original and explain the formulas.” +- “Create a PDF guide and inspect its rendered pages.” + +## Deliverables and verification + +| Work | What to check before delivery | +| --- | --- | +| Documents | Claims, hierarchy, references, and rendered layout | +| Presentations | Story, slide layout, editable export, and fonts | +| Spreadsheets | Formulas, units, source data, and recalculated results | +| PDFs | Page rendering, clipping, text, and pagination | +| Research | Source dates, primary evidence, conflicting claims, and uncertainty | +| Visual explanations | Accurate data, readable labels, and useful interactions | + +Artifact generation depends on the installed Skills and execution environment. If a dependency or export path is unavailable, resolve it or use an explicit alternative rather than presenting an unsupported format as completed. + +## Iterate in the same workspace + +Ask the Agent to revise the actual saved artifact, not just describe a hypothetical change. Preserve source files and inspect the new output. Interactive explanations can remain in the conversation, become a [Mini App](Mini-Apps-and-Pages), or be saved and published as a Page. + +Browser and desktop interactions require supported tools and permissions. Purchases, messages, deletion, and publication need explicit intent and review. + +> Screenshot pending: S10 — generated artifact with preview; S11 — interactive visual explanation. diff --git "a/docs/wiki/pages/Cowork-\344\270\216\345\210\233\344\275\234.md" "b/docs/wiki/pages/Cowork-\344\270\216\345\210\233\344\275\234.md" new file mode 100644 index 0000000000..18d62dfbd1 --- /dev/null +++ "b/docs/wiki/pages/Cowork-\344\270\216\345\210\233\344\275\234.md" @@ -0,0 +1,37 @@ +[简体中文] | [English](Cowork-and-Creation) · [首页](首页) + +# 调研、办公与内容创作 + +本页保留旧地址以兼容已有链接，以下流程不要求进入单独的 Cowork 模式。 + +## 从目标出发 + +提供原始材料、目标受众、成果格式和验收标准。根据复杂度选择[Harness](Agent-模式)，并确认相应 Skills、工具、模型和依赖可用。 + +例如： + +- “调研这个主题，比较来源，写一份带引用的简报。” +- “把这些笔记整理成可编辑演示文稿。” +- “分析这份表格，保留原件并解释公式。” +- “制作 PDF 指南，并检查渲染后的每一页。” + +## 交付与验证 + +| 工作 | 交付前检查 | +| --- | --- | +| 文档 | 论据、层级、引用和渲染布局 | +| 演示文稿 | 叙事、版式、可编辑导出和字体 | +| 电子表格 | 公式、单位、原始数据和重算结果 | +| PDF | 页面渲染、裁切、文字和分页 | +| 调研 | 来源日期、一手证据、分歧和不确定性 | +| 可视化解释 | 数据准确、标签清晰和交互有效 | + +成果生成取决于已安装 Skills 和执行环境。依赖或导出路径不可用时，应先解决或明确改用其他方案，不能把未支持的格式宣称为已完成。 + +## 在同一工作空间中迭代 + +请智能体修改实际保存的成果，而不只是描述假想修改；保留原始材料并检查新输出。交互解释可以留在会话中、成为[Mini App](Mini-Apps-与-Pages)，或保存并发布为 Page。 + +浏览器与桌面交互需要支持的工具和权限。购买、发消息、删除、发布等操作需要明确意图并检查结果。 + +> 待补截图：S10 — 生成成果与预览；S11 — 交互式可视化。 diff --git a/docs/wiki/pages/Customize-and-Extend.md b/docs/wiki/pages/Customize-and-Extend.md new file mode 100644 index 0000000000..b88e8ac36f --- /dev/null +++ b/docs/wiki/pages/Customize-and-Extend.md @@ -0,0 +1,41 @@ +[English] | [简体中文](自定义与扩展) · [Home](Home) + +# Customize and extend + +## Start with the smallest extension + +1. Adjust a role's instructions and permissions. +2. Add a Skill for repeatable knowledge. +3. Connect MCP for external tools. +4. Build a Mini App for a dedicated interface. +5. Add trusted Hooks for lifecycle behavior. +6. Use selective ecosystem compatibility or ACP where appropriate. +7. Modify source only when the product itself needs to change. + +## Agents, Skills, and MCP + +In Agents, inspect built-in, user, project, and external roles. Configure tools/tool groups, Skills/Skill groups, model strategy, and read-only constraints according to the visible host catalog. Subagents handle bounded delegated tasks; delegation does not make every independent role a general Harness. + +Skills guide workflows and may require runtime dependencies. Check source, scope, shadowing, and availability. For MCP, configure the transport and authentication, test the connection, and explicitly select the server/tools for relevant Agents. Saved MCP configuration and a connected MCP service are different states. + +## Hooks + +OpenBitFun native user Hooks implement the Codex hook contract, with documented deviations. Use OpenBitFun's own user/project configuration files and Settings → Agent Hooks. Project Hooks are off by default and run code from a repository: enable only after review. + +Compatible Claude Code/Codex command Hooks can be imported as explicitly reviewed snapshots. Updates need another review; removing a managed copy does not modify the source tool's files. Hook management and execution are local-only; remote workspaces return unsupported. + +OpenCode plugin callbacks are discovery/static-preview data, not executable native Hooks. Follow the [OpenBitFun Hook guide](https://github.com/GCWing/OpenBitFun/blob/v1.0.0/docs/features/agent-hooks.md) for paths, gates, and compatibility limits. + +## Ecosystem compatibility + +The compatibility UI covers OpenCode, Claude Code, Codex, DeepSeek Harness, and PI. Inspect per-source/per-category status. Discovering content, importing a copy, enabling it, and connecting its dependencies are distinct steps. + +Select supported Skill/MCP/Hook items, review import plans and conflicts, then confirm the copy. Commands, tools, and subagents use their supported compatibility paths; this is not universal plugin execution. DeepSeek Harness/PI Hook catalogs are read-only. OpenCode's managed-package/static-preview support must not be described as its full live runtime. + +## Skins and client customization + +Open Settings → Application → Appearance for themes, language, fonts, local appearance packages, and the Skin market. Preview before applying, keep a known-good built-in appearance, and review market updates. [Skin market](https://market.openbitfun.com/skin/). + +Creative offers client UI/runtime customization, distinct from a visual skin and from changing/building the source product. Source development follows the [contribution guide](https://github.com/GCWing/OpenBitFun/blob/v1.0.0/CONTRIBUTING.md). ACP connects supported external Agent processes, with their own setup and trust boundaries. + +> Screenshot pending: S22 — Agent capability configuration; S23 — ecosystem import; S24 — Hook review; S25 — appearance/Skin market. diff --git a/docs/wiki/pages/Detached-Dispatch.md b/docs/wiki/pages/Detached-Dispatch.md new file mode 100644 index 0000000000..1c6779542f --- /dev/null +++ b/docs/wiki/pages/Detached-Dispatch.md @@ -0,0 +1,34 @@ +[English] | [简体中文](远程任务派发) · [Home](Home) + +# Detached Dispatch + +## Submit a target-owned job + +Dispatch sends durable work to another OpenBitFun host. After the target durably accepts the job, the controller may disconnect; the target owns the worker, session, worktree, execution log, and permission mailbox. + +## Prepare and submit + +1. Open a Git repository or managed worktree. Dispatch workspace delivery is Git-only, not arbitrary folder upload. +2. Open the session dispatch picker and select a supported SSH or account-device target. +3. Verify protocol/capabilities, target CLI/runtime readiness, model configuration, and permissions. Review any install/update or model synchronization requested during preparation. +4. Choose the baseline revision and whether to include uncommitted Git-visible changes. +5. Review the objective and submit. Wait for durable target acceptance before disconnecting. +6. Follow job status and recover the execution transcript after reconnecting. + +The target receives a managed job worktree, not a caller-selected arbitrary execution folder. When included, uncommitted changes are committed in a controller-managed baseline worktree; the user's checkout is not staged or switched. Git-ignored files such as local .env files and build output are not delivered, so prepare required target dependencies separately. + +## Observe, answer, and cancel + +Inspect job state, errors, and pending permissions. Answer supported requests remotely, or cancel the target job when intended. The execution host must remain available; a controller disconnect cannot keep a switched-off target running. + +If submission outcome is uncertain, inspect the existing job record before making a new job. Reconnectable records are not a reason to erase a failed or offline job. + +## Synchronize results deliberately + +The controller baseline and target worktree are not a live shared folder. Later changes to your original checkout do not automatically reach the running task. Synchronization imports the target job branch into the managed controller baseline; review those changes before integrating them into your normal branch. + +Synchronizing can commit Git-visible changes in the target job worktree. It is an intentional mutation, not a read-only refresh. + +[Dispatch ownership and delivery contract](https://github.com/GCWing/OpenBitFun/blob/v1.0.0/docs/architecture/detached-task-dispatch.md) + +> Screenshot pending: S32 — target/preflight; S33 — job status, permissions, and sync. diff --git a/docs/wiki/pages/FAQ.md b/docs/wiki/pages/FAQ.md new file mode 100644 index 0000000000..6e631c0d02 --- /dev/null +++ b/docs/wiki/pages/FAQ.md @@ -0,0 +1,71 @@ +[English] | [简体中文](常见问题) · [Home](Home) + +# FAQ + +## Is OpenBitFun only for coding? + +No. Coding, research, office work, and creation share the Agent workspace. A separate Cowork mode is not a prerequisite for documents or analysis. + +## Which mode should I use? + +The four general Harnesses are Minimal, Standard, Ultimate, and Creative. Start with Minimal for bounded work, Standard for everyday multi-step tasks, Ultimate for complex work, and Creative for workspace creation/customization. See [selection details](Agent-Modes). + +## Can I ask for a plan without implementation? + +Yes. Say “investigate and propose a plan, but do not edit.” A Harness choice does not override your task scope or permission rules. + +## Can I change the Harness mid-session? + +The current selector chooses it before the first turn. After a session starts, selecting another execution profile asks to create a new session. See [sessions](Sessions-and-Goals). + +## Can I upgrade directly from 0.2.x? + +Legacy data is not directly compatible with 1.0. Use the optional migrator for stable 0.2.17–0.2.19 and keep backups. [Migration instructions](Getting-Started). + +## Is it free, and do I need an account? + +Core code is [MIT licensed](https://github.com/GCWing/OpenBitFun/blob/v1.0.0/LICENSE). Model APIs, cloud speech, infrastructure, and other services may cost money. Core local use does not need an OpenBitFun account; account-device control and Pages require configured account services. + +## Can I work offline? + +Only if the chosen model, speech, tools, and dependencies can operate offline. A cloud endpoint or web research naturally needs connectivity. + +## Can it create editable office files? + +Supported Skills/toolchains can produce editable artifacts. Check installed dependencies and validate the saved output; this is not automatic support for every format on every model. + +## Does it upload my project? + +Core use does not require whole-project account upload. Relevant content may still go to the configured model or external tools. See [privacy](Security-and-Privacy). + +## What is the difference between SSH, peer control, and Dispatch? + +SSH changes the workspace IO/command target while the Agent Runtime stays on the host. Peer control uses another host's product state and execution. Dispatch submits a target-owned durable job with a managed Git worktree. See [remote comparison](Remote-and-Multi-device). + +## Can I close the controller? + +Accepted peer work belongs to its executing runtime, not the controller UI. A Dispatch job can continue after durable acceptance while the controller disconnects. The executing host and dependencies must remain available; pending permissions can still block work. + +## Does a session fork isolate files? + +No. It copies history and preserves the workspace binding. Remote forks share the same working tree. Use a worktree or separate workspace for file isolation. + +## Can I use a phone or messaging app? + +Yes, through supported Remote Connect mobile/Bot flows. Browser/device control uses the same GitHub identity on both ends, including LAN mode; a QR invitation is not anonymous authorization. Bot setup has connector-specific credentials. Capabilities vary by surface; see [remote control](Remote-and-Multi-device). + +## Are voice input and realtime calls the same? + +No. Input transcription creates editable text before sending. Realtime calls provide ongoing spoken collaboration and can request project work. They have separate service requirements. See [voice](Voice-and-Realtime). + +## What are Mini Apps, Pages, and skins? + +Mini Apps are installed interactive tools; Pages publishes versioned static results; skins change appearance. See [Mini Apps and Pages](Mini-Apps-and-Pages) and [customization](Customize-and-Extend). + +## Can I use another Agent ecosystem's plugins? + +Compatibility is selective. Discovery/import/activation are different states, and OpenCode static preview does not imply full live plugin execution. [Compatibility limits](Customize-and-Extend). + +## Where can I get help? + +[Playbook](https://playbook.openbitfun.com), [Issues](https://github.com/GCWing/OpenBitFun/issues), and the [contribution guide](https://github.com/GCWing/OpenBitFun/blob/v1.0.0/CONTRIBUTING.md). Include version, OS, target, error text, and reproduction steps; remove secrets. Report security issues privately. diff --git a/docs/wiki/pages/Getting-Started.md b/docs/wiki/pages/Getting-Started.md new file mode 100644 index 0000000000..2f41f81b6f --- /dev/null +++ b/docs/wiki/pages/Getting-Started.md @@ -0,0 +1,44 @@ +[English] | [简体中文](快速开始) · [Home](Home) + +# Getting started and migration + +## Install + +Download the Windows, macOS, or Linux package from the [official download page](https://openbitfun.com/download). Choose the package matching your system and architecture; see [download verification](https://github.com/GCWing/OpenBitFun/blob/v1.0.0/docs/verify-downloads.md) for signature checks. Nightly builds are a separate, potentially unstable channel. + +## Migrating from legacy 0.2.x releases + +OpenBitFun 1.0 is not data-compatible with legacy 0.2.x installs. Do not point it at old data and assume an ordinary upgrade will convert everything. + +The optional [Data Migrator](https://github.com/GCWing/OpenBitFun/blob/v1.0.0/src/apps/data-migrator/README.md) supports stable legacy releases 0.2.17–0.2.19 as sources. Earlier versions require upgrading the old application first and checking that its data is readable. + +1. Back up your data and close both applications, their CLI instances, and background writers. +2. Open the migrator on the machine that owns the data. +3. Check source and destination, choose data groups, scan, and review the preflight plan. +4. Run migration and inspect warnings, skipped items, conflicts, and the report. +5. Open OpenBitFun yourself; repair paths or sign in again where the report indicates. + +The migrator does not automatically delete source data. Do not delete or reset either application's data as a generic recovery step. Remote connection records are data, not a migration of the remote machine. + +## Start your first task + +1. Follow setup to configure a supported model provider or custom endpoint. Check credentials, model capabilities, and the connection test. A saved configuration is not proof of a successful connection. +2. Open a project folder containing your code, notes, data, or other material. +3. Create a session. Start with Minimal for a bounded task or Standard for several steps. +4. Choose an approval-oriented permission posture for initial work. +5. Describe the outcome and constraints, then inspect the result. + +Good first prompts: + +- “Explain this project; do not edit files.” +- “Summarize these notes into a brief and identify unsupported claims.” +- “Analyze this workbook and save a report; ask before changing the source.” +- “Plan a small improvement, but wait for approval before implementing.” + +Model use may incur provider charges. Account login is not required for core local work, but account-based device control and Pages need configured account services. + +## Find help + +Use global search and the [Playbook](https://playbook.openbitfun.com). See [Harnesses](Agent-Modes), [security](Security-and-Privacy), and [FAQ](FAQ). Report problems with the application version, OS, target environment, and reproduction steps. + +> Screenshot pending: S05 — model setup and connection test; S06 — first session; S07 — migrator preflight. diff --git a/docs/wiki/pages/Home.md b/docs/wiki/pages/Home.md new file mode 100644 index 0000000000..965180cd77 --- /dev/null +++ b/docs/wiki/pages/Home.md @@ -0,0 +1,31 @@ +[English] | [简体中文](首页) · [Home](Home) + +# OpenBitFun Wiki + +OpenBitFun is an open-source Agent workspace for coding, research, knowledge work, creation, and personal assistance. These tasks share a workspace: you do not need to sort every request into separate Code and Cowork modes. + +## Start here + +1. [Install, configure a model, and start a session](Getting-Started). +2. [Choose a Harness](Agent-Modes): Minimal, Standard, Ultimate, or Creative. +3. Inspect the files, artifacts, sources, and checks that the Agent produces. + +## Explore + +- [Product overview](Product-Overview): concepts and capabilities. +- [Coding workspace](Coding-Workspace) and [research, office work, and creation](Cowork-and-Creation): practical workflows. +- [Sessions and goals](Sessions-and-Goals): history, steering, forks, and sustained work. +- [Personal assistants](Personal-Assistant) and [task board and scheduling](Tasks-and-Automation). +- [Mini Apps and Pages](Mini-Apps-and-Pages): build tools and share results. +- [Remote and multi-device](Remote-and-Multi-device), [Peer Device Mode](Peer-Device-Mode), and [Detached Dispatch](Detached-Dispatch). +- [Voice and realtime calls](Voice-and-Realtime), [customization](Customize-and-Extend), and [security](Security-and-Privacy). + +## Versions and references + +This guide targets OpenBitFun 1.0. Text was checked on 2026-09-18 against the v1.0.0 source documentation and development revision f72a28eb8. Connection services, provider support, and surface capabilities still depend on your installation and environment. Source review is not end-to-end testing. + +Legacy 0.2.x data needs explicit migration; see [Getting started](Getting-Started). Wearables and broader device coverage remain development directions, not promises of identical capability on every device. + +[Download](https://openbitfun.com/download) · [Playbook](https://playbook.openbitfun.com) · [GitHub](https://github.com/GCWing/OpenBitFun) + +> Screenshot pending: S01 — current desktop overview. See [Screenshot checklist](Screenshot-Checklist). diff --git a/docs/wiki/pages/Mini-Apps-and-Pages.md b/docs/wiki/pages/Mini-Apps-and-Pages.md new file mode 100644 index 0000000000..2b0712b7e8 --- /dev/null +++ b/docs/wiki/pages/Mini-Apps-and-Pages.md @@ -0,0 +1,44 @@ +[English] | [简体中文](Mini-Apps-与-Pages) · [Home](Home) + +# Mini Apps and Pages + +## Mini Apps: installed tools with dedicated interfaces + +A Mini App combines UI, persistent state, and an Agent workflow inside OpenBitFun. It can provide a repository dashboard, presentation workspace, form, tracker, or interactive explanation. + +### Install and use + +1. Open Mini Apps and browse the market or installed apps. +2. Read the listing, source, version, and requested permissions. +3. Install and open the app. Grant only the workspace/path access it needs. +4. Use its interface and dedicated conversation, where provided. + +Market login, favorites, ratings, and updates are market-service features; they are distinct from local application use. + +### Create and customize + +Describe the tool you need, preferably in Creative. Ask the Agent to initialize, author, and validate it. Creation inside the installed client does not require editing OpenBitFun's source checkout. + +For customization, open a draft, request changes, inspect the live preview and permission difference, then apply, synchronize, or discard the changes. Installed and draft state are separate. Review version history before rollback; do not assume a code rollback reverses every external effect. + +Apps may use model calls and background Workers. Check Worker status and stop unnecessary work. Model calls may incur provider charges. + +### Share an app + +Market submission is an explicit publishing action, not part of merely creating an app. Review source, bundled data, permissions, and credentials before requesting submission; submissions go through market review. + +## Pages: publish a versioned result + +Pages is a service-backed publishing capability for static experiences. It differs from a Mini App installed inside your workspace. + +1. Sign in with GitHub through the configured account service. +2. Save a page version and review its rendered content. +3. Choose the intended visibility/access settings and publish or deploy the selected version. +4. Open the share link and verify access. +5. Use versions to redeploy or roll back; unpublish when needed. + +Unpublishing retains saved versions; deleting a version or Page is a separate action. Do not assume private content is safe to publish merely because the URL is hard to guess. Availability depends on the deployed service and the settings exposed by your version; historical Preview labels are not a service guarantee. + +[Mini App market](https://market.openbitfun.com/miniapp/) · [Feature reference](https://github.com/GCWing/OpenBitFun/tree/v1.0.0/docs/interactive-capabilities/capabilities) + +> Screenshot pending: S15 — market/app with conversation; S16 — draft and permissions; S17 — Pages versions and visibility. diff --git "a/docs/wiki/pages/Mini-Apps-\344\270\216-Pages.md" "b/docs/wiki/pages/Mini-Apps-\344\270\216-Pages.md" new file mode 100644 index 0000000000..f2d5e2aa37 --- /dev/null +++ "b/docs/wiki/pages/Mini-Apps-\344\270\216-Pages.md" @@ -0,0 +1,44 @@ +[简体中文] | [English](Mini-Apps-and-Pages) · [首页](首页) + +# Mini Apps 与 Pages + +## Mini Apps：拥有专用界面的已安装工具 + +Mini App 在 OpenBitFun 内组合界面、持久状态与智能体工作流，可用于仓库面板、演示文稿工作空间、表单、追踪器和交互解释。 + +### 安装与使用 + +1. 打开 Mini Apps，浏览市场或已安装应用。 +2. 阅读介绍、来源、版本与权限请求。 +3. 安装并打开，只授予所需工作区或路径访问。 +4. 使用应用界面，以及应用提供的专属会话。 + +市场登录、收藏、评分和更新属于市场服务能力，与本地应用使用有所区别。 + +### 创建与定制 + +描述所需工具，可从 Creative 开始，请智能体初始化、编写和校验。在已安装客户端内创建应用，不要求修改 OpenBitFun 源码仓库。 + +定制时打开草稿、提出修改，检查实时预览与权限差异，再应用、同步或丢弃改动。正式应用与草稿状态分开。回滚前查看版本历史，不要假设代码回滚能撤销所有外部影响。 + +应用可能调用模型并运行后台 Worker。检查 Worker 状态，停止不再需要的工作；模型调用可能产生费用。 + +### 分享应用 + +提交市场是显式发布操作，不是创建应用的默认步骤。请求提交前检查源码、附带数据、权限与凭据；投稿需经市场审核。 + +## Pages：发布版本化成果 + +Pages 是依赖服务的静态成果发布能力，与安装在工作空间中的 Mini App 不同。 + +1. 通过配置好的账号服务使用 GitHub 登录。 +2. 保存页面版本并检查渲染内容。 +3. 选择可见性与访问设置，发布或部署所选版本。 +4. 打开分享链接，验证访问范围。 +5. 使用版本重新部署或回滚，需要时取消发布。 + +取消发布会保留已保存版本；删除版本或 Page 是另一项操作。链接难猜不等于私有内容可以放心发布。可用性取决于部署服务与当前版本暴露的设置，历史 Preview 标签也不是服务可用性保证。 + +[Mini App 市场](https://market.openbitfun.com/miniapp/) · [功能参考](https://github.com/GCWing/OpenBitFun/tree/v1.0.0/docs/interactive-capabilities/capabilities) + +> 待补截图：S15 — 市场/应用与会话；S16 — 草稿与权限；S17 — Pages 版本与可见性。 diff --git "a/docs/wiki/pages/Peer-Device-Mode-\344\270\255\346\226\207.md" "b/docs/wiki/pages/Peer-Device-Mode-\344\270\255\346\226\207.md" new file mode 100644 index 0000000000..641472470c --- /dev/null +++ "b/docs/wiki/pages/Peer-Device-Mode-\344\270\255\346\226\207.md" @@ -0,0 +1,31 @@ +[简体中文] | [English](Peer-Device-Mode) · [首页](首页) + +# Peer Device Mode + +## 使用另一设备的工作空间 + +Peer Device Mode 保留本地控制端界面，产品命令与事件来自选定的 OpenBitFun Desktop 或 CLI 宿主。对端拥有执行、会话、文件系统、终端和权限交互。 + +它不同于 SSH 工作区 IO，也不同于提交[派发任务](远程任务派发)。 + +## 连接 + +1. 配置账号/Relay 服务，在相关设备使用 GitHub 登录。 +2. 打开 Remote Connect 设备管理，检查同账号设备和在线状态。 +3. 连接目标设备，进入其受支持设备表面。 +4. 选择对端真实存在的工作区，再打开或创建会话。 +5. 修改文件或运行命令前确认设备标识与路径。 + +能力由目标宿主提供，Desktop 与 CLI 不一定完全一致；不支持的操作应明确报告，而不能悄悄在控制端执行。 + +## 归属与断线 + +两台设备上看起来相同的路径仍是不同资源，不能将控制端路径复用为对端执行路径。下载目的地属于控制端，源文件属于对端。 + +切回本地视图不等于取消或关闭对端工作。已接受任务仍属于执行运行时，即使没有控制端连接，只要运行时保持可用；重连可恢复历史和未回答交互。 + +窗口、账号身份和部署等控制端本地操作，不会因为处于对端视图就变成远程操作。保护两台设备，撤销过时访问。 + +[设备行为参考](https://github.com/GCWing/OpenBitFun/blob/v1.0.0/src/web-ui/src/infrastructure/peer-device/README.md) + +> 待补截图：S31 — 设备连接与对端标识。 diff --git a/docs/wiki/pages/Peer-Device-Mode.md b/docs/wiki/pages/Peer-Device-Mode.md new file mode 100644 index 0000000000..190e5e1dee --- /dev/null +++ b/docs/wiki/pages/Peer-Device-Mode.md @@ -0,0 +1,31 @@ +[English] | [简体中文](Peer-Device-Mode-中文) · [Home](Home) + +# Peer Device Mode + +## Use another device's workspace + +Peer Device Mode keeps the controller shell local while product commands and events come from a selected OpenBitFun Desktop or CLI host. The peer owns execution, sessions, filesystem, terminals, and permission interactions. + +This differs from SSH workspace IO and from submitting a [Dispatch job](Detached-Dispatch). + +## Connect + +1. Configure the account/Relay service and sign in with GitHub on the relevant devices. +2. Open Remote Connect device management and inspect same-account devices and online state. +3. Connect the intended device and enter its supported peer surface. +4. Select a workspace that exists on the peer, then open or create a session. +5. Verify the device indicator and path before changing files or running commands. + +Capabilities come from the target host; Desktop and CLI do not necessarily expose the same set. Unsupported operations must be reported, not silently executed on the controller. + +## Ownership and disconnect + +Paths that look identical on two devices are still different resources. Never reuse a controller path as a peer execution path. Download destinations belong to the controller, while source files belong to the peer. + +Switching back to the local view is not cancellation or teardown of peer work. Accepted tasks remain owned by the executing runtime, even with no controller attached, provided that runtime remains available. Reconnect to recover history and unanswered interactions. + +Controller-local window, account identity, and deployment actions do not become remote merely because the peer view is active. Keep both devices secure and remove obsolete device access. + +[Peer behavior reference](https://github.com/GCWing/OpenBitFun/blob/v1.0.0/src/web-ui/src/infrastructure/peer-device/README.md) + +> Screenshot pending: S31 — device connection and peer indicator. diff --git a/docs/wiki/pages/Personal-Assistant.md b/docs/wiki/pages/Personal-Assistant.md new file mode 100644 index 0000000000..86b3511646 --- /dev/null +++ b/docs/wiki/pages/Personal-Assistant.md @@ -0,0 +1,31 @@ +[English] | [简体中文](个人助手) · [Home](Home) + +# Personal assistants + +Personal assistants keep dedicated identity and context for recurring responsibilities. They are not an extra general Harness and do not require separating ordinary work into Code and Cowork. + +## Create and configure + +1. Open Assistants and create or choose an assistant. +2. Define its name, role, avatar, and working style. +3. Review identity/persona files: IDENTITY.md, SOUL.md, and USER.md. +4. Configure the applicable Skills, built-in tools, MCP services, and model. +5. Start a conversation from the assistant card or detail page. + +The defaults configuration for new assistants controls their starting capabilities. Inspect enabled, unavailable, shadowed, or changed items; do not assume changing defaults rewrites every existing assistant. + +## Ongoing work + +An assistant has its own workspace and sessions. Use [scheduled tasks](Tasks-and-Automation) for recurring work, and check that the execution host and required services remain available. A personality file alone does not create a background job. + +## Memory and insights + +Long-term memory can retain durable preferences and knowledge from sessions, subject to memory configuration. Inspect and manage it separately from the assistant's identity. Clearing memory is not the same as deleting session history. + +Session insights summarize activity across a chosen period. Treat them as reflective reports and verify important conclusions against the underlying work. + +Voice input, realtime calls, and optional desktop companions are separate capabilities; see [voice](Voice-and-Realtime). Resetting a workspace or deleting an assistant is an explicit data operation: back up anything you need first. + +[Assistant reference](https://github.com/GCWing/OpenBitFun/blob/v1.0.0/docs/interactive-capabilities/capabilities/feature.personal-assistants.md) + +> Screenshot pending: S12 — assistant list and identity; S13 — default capabilities; S14 — memory and insights. diff --git a/docs/wiki/pages/Product-Overview.md b/docs/wiki/pages/Product-Overview.md new file mode 100644 index 0000000000..9f7d47f600 --- /dev/null +++ b/docs/wiki/pages/Product-Overview.md @@ -0,0 +1,42 @@ +[English] | [简体中文](产品全景) · [Home](Home) + +# Product overview + +## One workspace, several kinds of work + +A project supplies the working material and environment. A session preserves a conversation and its activity. A Harness shapes how the Agent executes the task. A specialist Agent supplies role-specific instructions and capabilities. Skills, MCP services, and tools extend what it can do; permissions determine what it may do. + +Coding and non-coding work are scenarios, not a strict Code/Cowork split. Personal assistants add persistent identity and dedicated context rather than acting as another general Harness. + +## Four Harnesses + +| Harness | Suitable starting point | +| --- | --- | +| Minimal | Clear, bounded tasks and quick back-and-forth | +| Standard | Everyday multi-step work with planning and verification | +| Ultimate | Complex investigation and coordinated Agent work | +| Creative | Mini App creation and client customization | + +See [Harness selection](Agent-Modes). Complexity is a useful starting point, not a guarantee about speed, cost, or outcome. + +## Capability map + +- Files, editor, terminal, Git, browser, and previews: [coding workspace](Coding-Workspace). +- Research, documents, slides, workbooks, PDFs, and visual explanations: [creation workflows](Cowork-and-Creation). +- Persistent history, goals, usage, and context management: [sessions](Sessions-and-Goals). +- Dedicated assistants and recurring work: [assistants](Personal-Assistant), [scheduling](Tasks-and-Automation). +- Installed tools with dedicated interfaces and Agent conversations: [Mini Apps](Mini-Apps-and-Pages). +- Static page versions and intentional publishing: [Pages](Mini-Apps-and-Pages). +- Mobile/Bot control, SSH/container/WSL workspaces, peer devices, and durable remote jobs: [remote guide](Remote-and-Multi-device). +- Speech transcription and realtime spoken collaboration: [voice](Voice-and-Realtime). +- Custom Agents, Skills, MCP, Hooks, ecosystem compatibility, and skins: [extensions](Customize-and-Extend). + +Availability varies by platform, configured model, permissions, runtime, and service deployment. Office artifacts depend on the relevant Skills and tools; they are not a promise that every model can generate every format without setup. + +## Find the right feature + +Use global search or the [Playbook](https://playbook.openbitfun.com) to discover features and settings. You can also ask the Agent to locate an entry or change a supported setting. Opening a settings page is not the same as completing its configuration: some actions require your interaction. + +[Source-backed feature reference](https://github.com/GCWing/OpenBitFun/tree/v1.0.0/docs/interactive-capabilities) + +> Screenshot pending: S02 — global search and feature discovery. diff --git a/docs/wiki/pages/Remote-and-Multi-device.md b/docs/wiki/pages/Remote-and-Multi-device.md new file mode 100644 index 0000000000..7370791e69 --- /dev/null +++ b/docs/wiki/pages/Remote-and-Multi-device.md @@ -0,0 +1,44 @@ +[English] | [简体中文](远程与多设备) · [Home](Home) + +# Remote and multi-device + +## Choose the right remote scenario + +| Scenario | What moves | Execution and data ownership | +| --- | --- | --- | +| Remote workspace | Workspace IO and commands target SSH/container/WSL | Agent Runtime and session metadata stay on the OpenBitFun host; files and workspace commands use the target | +| Remote control | Mobile or Bot sends requests to a host | The connected host owns execution and sessions | +| Peer Device Mode | A local shell uses another device's product commands/events | The selected Desktop/CLI owns work and records | +| Detached Dispatch | A durable job is submitted to another host | The target owns its runtime, job session, managed worktree, and records | + +These are not interchangeable “remote modes.” A remote workspace does not automatically install or start OpenBitFun on the target. See [Peer Device Mode](Peer-Device-Mode) and [Detached Dispatch](Detached-Dispatch) for their prerequisites. + +## Mobile and Bot control + +1. Open Remote Connect on the host. +2. Choose LAN or the configured official Relay path; inspect connection state and network information. +3. Sign in with the same GitHub identity on the host and mobile controller, then follow the QR invitation flow. The QR contains the endpoint/device identity, not anonymous access authorization. +4. Verify the selected host/workspace, then send a request or inspect an existing session. +5. Answer supported permission requests from the driving surface and reconnect to recover history. + +The current UI does not offer separate ngrok or custom-server tabs. Same-network mode starts a Relay on the host; both LAN and official Relay modes use GitHub identity verification and need internet for sign-in. The official endpoint is fixed: self-hosting requires a matching client build, not an editable server URL or deployment wizard. Use the [Relay guide](https://github.com/GCWing/OpenBitFun/blob/v1.0.0/src/apps/relay-server/README.md). + +Feishu, Telegram, and WeChat/iLink have dedicated Bot configuration. Supported session controls differ by surface and connector. Mobile web supports adaptive layouts; do not infer universal desktop feature parity or a standalone mobile execution runtime. + +## Remote workspaces + +Supported targets include SSH, jump-host chains, Docker on SSH, local Docker, container sshd, and Windows WSL on the executing Windows host. Configure the connection, test it, select the actual target workspace path, and verify the terminal and files belong to that environment. + +Remote paths use POSIX separators. Container paths are inside the container; host bind mounts are visible only at their mounted path. Docker commands require a compatible POSIX shell. + +Agent Grep/Glob and remote file-name search remain available through supported providers. Flashgrep-accelerated remote content search/index controls are unavailable; the application must not silently search local files instead. Remote file rollback also has coverage restrictions; see [coding workspace](Coding-Workspace). + +If Git reports unsafe ownership, inspect the exact target and grant safe.directory trust yourself on the repository-owning machine; OpenBitFun does not silently grant remote trust. + +## Disconnect and security + +A controller disconnect is not a guarantee of cancellation. The executing host must remain running; a job waiting on permissions still needs an answer. Paired payload encryption does not hide all routing metadata or protect compromised endpoints. See [security](Security-and-Privacy). + +[Detailed workspace guide](https://github.com/GCWing/OpenBitFun/blob/v1.0.0/docs/features/remote-workspaces.md) + +> Screenshot pending: S18 — Remote Connect and QR; S19 — mobile layouts; S20 — target connection; S21 — Bot configuration. diff --git a/docs/wiki/pages/Screenshot-Checklist.md b/docs/wiki/pages/Screenshot-Checklist.md new file mode 100644 index 0000000000..c76aca59fe --- /dev/null +++ b/docs/wiki/pages/Screenshot-Checklist.md @@ -0,0 +1,57 @@ +[English] | [简体中文](截图清单) · [Home](Home) + +# Screenshot checklist + +This refresh changes text only. No screenshots were generated or uploaded. Obsolete Home images were removed; S01–S36 identify pending illustration positions. There are 36 topics, not necessarily 36 image files. + +P0 covers onboarding, execution ownership, selection, or safety; P1 covers primary features; P2 covers supporting examples. + +## Capture requirements + +- Use one released version and record version, OS, language, and theme. Label development-only examples explicitly. +- Prefer Chinese UI for Chinese pages and English UI for English pages, with consistent demo data. Language-neutral images may be shared. +- Use demo accounts/projects. Hide API keys, Bot tokens, emails, private repositories, sensitive paths/IPs, and personal files. Invalidate or redact QR/pairing codes; never publish live credentials. +- Capture real UI and retain important state/target indicators. Do not delete, reset, publish, or grant Full Access just to capture a screenshot; leave confirmation dialogs unsubmitted. +- Use names such as `s03-harness-zh-cn.png` and `s03-harness-en-us.png`, adding `-01` or `-02` when needed. Upload to a publicly accessible Wiki asset URL and replace the corresponding placeholder with an informative caption. +- Check image links and surrounding instructions. Screenshots illustrate UI; they are not evidence of remote behavior testing. + +## Checklist + +| ID | Priority | Page | Topic | Required view | +| --- | --- | --- | --- | --- | +| S01 | P0 | [Home](Home) | Desktop overview | Project navigation, chat, workbench | +| S02 | P1 | [Product-Overview](Product-Overview) | Global search | Feature/setting results and destination | +| S03 | P0 | [Agent-Modes](Agent-Modes) | Harness chooser | All four Harnesses and specialist entry | +| S04 | P0 | [Agent-Modes](Agent-Modes) | Started-session selection | New-session confirmation without sending | +| S05 | P0 | [Getting-Started](Getting-Started) | Model setup | Provider/model and connection test result | +| S06 | P0 | [Getting-Started](Getting-Started) | First session | Workspace, Harness, model, permissions | +| S07 | P0 | [Getting-Started](Getting-Started) | Migration preflight | Source/destination, groups, warnings | +| S08 | P1 | [Coding-Workspace](Coding-Workspace) | Engineering workspace | Editor, terminal, Agent output | +| S09 | P1 | [Coding-Workspace](Coding-Workspace) | Git and review | Changed files, diff, review result | +| S10 | P1 | [Cowork-and-Creation](Cowork-and-Creation) | Artifact preview | Saved document/slides/workbook and preview | +| S11 | P2 | [Cowork-and-Creation](Cowork-and-Creation) | Interactive explanation | Readable visual plus adjustable interaction | +| S12 | P1 | [Personal-Assistant](Personal-Assistant) | Assistant identity | List/card and persona editor (may be two images) | +| S13 | P1 | [Personal-Assistant](Personal-Assistant) | Default capabilities | Skills, tools, MCP states and scope | +| S14 | P2 | [Personal-Assistant](Personal-Assistant) | Memory and insights | Memory controls and sanitized insight report | +| S15 | P1 | [Mini-Apps-and-Pages](Mini-Apps-and-Pages) | Market and app | Install listing; launched app with conversation | +| S16 | P1 | [Mini-Apps-and-Pages](Mini-Apps-and-Pages) | Customization | Draft preview, permission diff, apply controls | +| S17 | P1 | [Mini-Apps-and-Pages](Mini-Apps-and-Pages) | Pages | Versions, deployment and visibility | +| S18 | P0 | [Remote-and-Multi-device](Remote-and-Multi-device) | Remote Connect | LAN/Relay options and invalidated QR | +| S19 | P1 | [Remote-and-Multi-device](Remote-and-Multi-device) | Mobile layouts | Single and supported multi-screen layouts | +| S20 | P0 | [Remote-and-Multi-device](Remote-and-Multi-device) | Workspace target | Target type, test state and target path | +| S21 | P1 | [Remote-and-Multi-device](Remote-and-Multi-device) | Bot connection | Provider and status, no token | +| S22 | P1 | [Customize-and-Extend](Customize-and-Extend) | Agent configuration | Role, model, read-only and capabilities | +| S23 | P1 | [Customize-and-Extend](Customize-and-Extend) | Ecosystem import | Five sources; import plan/conflict and state | +| S24 | P1 | [Customize-and-Extend](Customize-and-Extend) | Hooks | Project gate and reviewed command plan | +| S25 | P1 | [Customize-and-Extend](Customize-and-Extend) | Appearance | Built-ins, local pack preview, Skin market | +| S26 | P0 | [Security-and-Privacy](Security-and-Privacy) | Permission request | Action target and remembered-rule scope | +| S27 | P1 | [Sessions-and-Goals](Sessions-and-Goals) | Session and goal | Fork/export menu; objective and status | +| S28 | P2 | [Sessions-and-Goals](Sessions-and-Goals) | Usage/background work | Usage report; process output and stop/input | +| S29 | P1 | [Tasks-and-Automation](Tasks-and-Automation) | Task board | Pending/Calendar/Inactive and upcoming jobs | +| S30 | P0 | [Tasks-and-Automation](Tasks-and-Automation) | Job setup | Timing/timezone, workspace, model and target | +| S31 | P0 | [Peer-Device-Mode](Peer-Device-Mode) | Peer control | Device list; selected peer and workspace badge | +| S32 | P0 | [Detached-Dispatch](Detached-Dispatch) | Dispatch preparation | Target, baseline, uncommitted option, preflight | +| S33 | P0 | [Detached-Dispatch](Detached-Dispatch) | Dispatch observation | Job state, permissions, result sync | +| S34 | P1 | [Voice-and-Realtime](Voice-and-Realtime) | Voice configuration | Mic/model state and successful test | +| S35 | P1 | [Voice-and-Realtime](Voice-and-Realtime) | Transcription | Recording then editable composer text | +| S36 | P1 | [Voice-and-Realtime](Voice-and-Realtime) | Realtime call | Active call, project task, stop/end distinction | diff --git a/docs/wiki/pages/Security-and-Privacy.md b/docs/wiki/pages/Security-and-Privacy.md new file mode 100644 index 0000000000..1c15968bbd --- /dev/null +++ b/docs/wiki/pages/Security-and-Privacy.md @@ -0,0 +1,46 @@ +[English] | [简体中文](安全与隐私) · [Home](Home) + +# Security and privacy + +## Data goes where the workflow requires + +Core local work does not require uploading a whole project to an OpenBitFun account. Relevant prompts, files, images, and tool context may still go to your configured model provider or external services. Cloud speech, MCP, messaging platforms, market services, and Pages have separate data boundaries. + +“Local-first” does not mean all processing is local. SSH workspaces keep runtime/session metadata on the host while workspace IO uses the target; Peer Device Mode and Dispatch execute on another host. + +## Permissions and consequential actions + +Use approval-oriented permissions for unfamiliar work. Full Access reduces prompts; it is not a sandbox or a guarantee of harmless behavior. Remembered rules are real authorization and should stay narrow. + +Inspect the target, reversibility, credentials, and potential disclosure before approving file changes, commands, browser/computer actions, or extensions. OS permissions for microphone, screen capture, or input control are separate. + +A request to research or draft is not permission to purchase, send a message, publish, or delete. Back up important data. Session rollback does not reverse all external effects. + +## Remote traffic and endpoints + +Paired payload content is encrypted end to end. Routing, timing, presence, and other connection metadata are not necessarily hidden. Model-provider traffic, Bot platforms, published Pages, and compromised devices do not acquire the same protection merely because a Relay is encrypted. + +Trust the selected executing device and service deployment. Revoke stale devices/connections. Do not infer a guarantee of uptime, compliance, or data retention from a public Relay. + +## Extensions + +- Skills provide instructions; inspect their code/dependency requirements. +- MCP exposes external tools; limit the selected services and authority. +- Mini Apps request workspace/path access and may use Workers or models. +- Hooks execute commands; project Hooks are off by default and require review. +- Ecosystem discovery is not blanket approval to execute imported code. +- ACP processes have their own permissions and trust assumptions. + +Review new permissions on updates. Keep copies and source configuration intact when an import cannot be parsed; do not reset user data to recover. + +## Accounts, publishing, memory, and voice + +Pages publishing is intentional disclosure; verify visibility and the final share link. Account-based device control requires configured services. Memory, session insights, and speech settings should be reviewed independently. Local transcription and cloud transcription have different data flows; realtime speech also depends on its configured provider. + +For legacy migration, use [the migration flow](Getting-Started). Run it on the data-owning machine and inspect warnings instead of deleting old records. + +## Report vulnerabilities privately + +Follow the [security policy](https://github.com/GCWing/OpenBitFun/blob/v1.0.0/SECURITY.md) and [private vulnerability reporting](https://github.com/GCWing/OpenBitFun/security/advisories/new). Do not publish exploit details, keys, or personal records in an issue. + +> Screenshot pending: S26 — permission request and remembered-rule scope. diff --git a/docs/wiki/pages/Sessions-and-Goals.md b/docs/wiki/pages/Sessions-and-Goals.md new file mode 100644 index 0000000000..b6777389ad --- /dev/null +++ b/docs/wiki/pages/Sessions-and-Goals.md @@ -0,0 +1,35 @@ +[English] | [简体中文](会话与持续目标) · [Home](Home) + +# Sessions and sustained goals + +## Start and organize + +Create a session in the intended workspace, choose the Harness/Agent before the first turn, then select the model and permissions. Rename, archive, restore, search, fork, or export sessions as needed. Deletion is different from archiving and should be intentional. + +Inspect tool output, modified files, background commands, and pending interactions rather than relying only on a final completion message. + +## Steer, interrupt, and recover + +Send additional instructions to redirect active work through the supported steering flow. Inspect queued messages before assuming they have been executed. Interrupt or cancel a run when needed; these actions do not undo edits or external effects already performed. + +Recovery depends on persisted session/runtime state and the executing host. A lost connection is not proof that a task stopped. Confirm host and session identity before retrying a submission to avoid duplicate work. + +## Forks and context + +Fork a conversation to explore another direction. A fork copies selected history; it does not automatically create a Git worktree or duplicate files. Remote forks retain their connection and POSIX path and share the original working tree. + +Context reload, instruction initialization, memory management, and compression affect what the model sees; they do not necessarily delete persisted history. A memory reset is a separate operation from session removal. + +Use lightweight BTW questions or editor inline AI for side questions where available. Keep the main task's scope explicit. + +## Sustained goals + +For work that needs a durable objective, explicitly ask to create a session goal. Inspect its objective and status; edit or clear it when necessary. Goals can be completed or marked blocked based on actual progress, not merely on a tool count. + +A goal is not a schedule. Use [scheduled jobs](Tasks-and-Automation) for future runs and [Dispatch](Detached-Dispatch) for target-owned remote execution. + +Review the session's request, token, and cost report where available. Provider pricing and reported usage can differ; verify consequential billing assumptions with the provider. + +[Session reference](https://github.com/GCWing/OpenBitFun/blob/v1.0.0/docs/interactive-capabilities/capabilities/feature.ai-assistant.md) + +> Screenshot pending: S27 — session actions and goal; S28 — usage and background commands. diff --git a/docs/wiki/pages/Tasks-and-Automation.md b/docs/wiki/pages/Tasks-and-Automation.md new file mode 100644 index 0000000000..8784cb0705 --- /dev/null +++ b/docs/wiki/pages/Tasks-and-Automation.md @@ -0,0 +1,33 @@ +[English] | [简体中文](任务板与定时任务) · [Home](Home) + +# Task board and scheduled work + +## Plan future or recurring work + +Open the Task Board to inspect Pending, Calendar, and Inactive views. Scheduling is separate from a session goal: it decides when and where another run should start. + +1. Create a scheduled job from the available task/assistant entry, or ask the Agent to create one. +2. Define the objective and choose one-time, daily, weekly, or custom Cron scheduling. +3. Review the displayed timezone and upcoming occurrences; make the intended timezone explicit in your request. +4. Choose the workspace, Agent, model, work mode, and supported execution target. +5. Save, then inspect the calendar and enabled state. + +Use a harmless initial task to verify your environment before relying on a consequential recurring workflow. + +## Host and permission requirements + +The owning scheduler/execution host must be available and ready. Scheduling on a remote target requires the relevant connection/capability; it does not make every target automatically usable. + +A pending permission request may need a remote answer. Do not assume that scheduling authorizes purchases, publishing, deletion, or unlimited Full Access. A switched-off machine is not a cloud scheduler. + +Assistants can manage jobs scoped to their own workspace. Verify the selected workspace rather than assuming all assistants share the same task list. + +## Edit and stop + +Inspect the next run, edit timing or scope, and enable or disable the job. Disable future occurrences when pausing a routine; cancellation of an already running session and deletion of the job are separate actions. + +Example: “Every Monday at 09:00 in my timezone, summarize this project's recent work. Save a report, but do not send messages or change source files.” + +[Scheduling reference](https://github.com/GCWing/OpenBitFun/blob/v1.0.0/docs/interactive-capabilities/capabilities/feature.tasks-automation.md) + +> Screenshot pending: S29 — board/calendar; S30 — job configuration and target. diff --git a/docs/wiki/pages/Voice-and-Realtime.md b/docs/wiki/pages/Voice-and-Realtime.md new file mode 100644 index 0000000000..17a0ee8b4a --- /dev/null +++ b/docs/wiki/pages/Voice-and-Realtime.md @@ -0,0 +1,35 @@ +[English] | [简体中文](语音与实时通话) · [Home](Home) + +# Voice input and realtime calls + +## Two separate workflows + +| Workflow | Result | Review boundary | +| --- | --- | --- | +| Input transcription | Recording becomes text in the composer | Edit before sending | +| Realtime call | Ongoing spoken conversation with audible replies | Project/tool actions still follow their permissions | + +Realtime calls can ask the assistant to enter a project, run or stop work, and speak brief progress. A local transcription model does not make a configured cloud realtime call local. + +## Configure and test transcription + +1. Open the standalone Voice settings page. +2. Enable voice and choose the configured local or cloud recognition path. +3. For local recognition, inspect model download/install/verification state and complete setup. +4. Select the microphone and recognition language or automatic detection. +5. Run the microphone/recognition test, then record from the chat input. +6. Finish to return text to the composer, edit it, and send; cancel to discard the recording. + +Check microphone OS permissions, model state, service credentials, network, and test errors before retrying. Do not delete unrelated models or application data as a general recovery step. + +## Realtime collaboration + +Configure the realtime voice service, start a call from the available client entry, and confirm the active project before asking for execution. Distinguish stopping a project task from ending the call; do not assume ending audio undoes work already performed. + +Provider/model availability, audio support, and surface entrypoints differ by installation. Do not infer mobile/Bot or remote-host voice parity from desktop support. Never route audio to a controller-local service silently if the selected surface cannot support it. + +Review what audio and context leave the device. Use text for sensitive instructions when you cannot verify the service's privacy settings. + +[Voice reference](https://github.com/GCWing/OpenBitFun/blob/v1.0.0/docs/interactive-capabilities/capabilities/feature.voice-input.md) + +> Screenshot pending: S34 — voice setup/test; S35 — recording with editable text; S36 — realtime call and project task. diff --git a/docs/wiki/pages/_Footer.md b/docs/wiki/pages/_Footer.md new file mode 100644 index 0000000000..8797a61233 --- /dev/null +++ b/docs/wiki/pages/_Footer.md @@ -0,0 +1,3 @@ +[OpenBitFun](https://github.com/GCWing/OpenBitFun) · [Website](https://openbitfun.com/) · [Playbook](https://playbook.openbitfun.com) · [Download](https://openbitfun.com/download) · [Issues](https://github.com/GCWing/OpenBitFun/issues) · [License](https://github.com/GCWing/OpenBitFun/blob/v1.0.0/LICENSE) + +Text checked / 文字核验：2026-09-18 · OpenBitFun 1.0 · Source documentation review, not cross-platform or remote end-to-end testing / 源码文档核对，不等于跨平台或远程端到端实测。 diff --git a/docs/wiki/pages/_Sidebar.md b/docs/wiki/pages/_Sidebar.md new file mode 100644 index 0000000000..7eb8a65d47 --- /dev/null +++ b/docs/wiki/pages/_Sidebar.md @@ -0,0 +1,50 @@ +## OpenBitFun Wiki + +[Home](Home) · [中文首页](首页) + +### English + +- [Getting started](Getting-Started) +- [Product overview](Product-Overview) +- [Harnesses and Agents](Agent-Modes) +- [Sessions and goals](Sessions-and-Goals) +- [Coding workspace](Coding-Workspace) +- [Research and creation](Cowork-and-Creation) +- [Personal assistants](Personal-Assistant) +- [Tasks and scheduling](Tasks-and-Automation) +- [Mini Apps and Pages](Mini-Apps-and-Pages) +- [Remote and multi-device](Remote-and-Multi-device) +- [Peer Device Mode](Peer-Device-Mode) +- [Detached Dispatch](Detached-Dispatch) +- [Voice and realtime](Voice-and-Realtime) +- [Customize and extend](Customize-and-Extend) +- [Security and privacy](Security-and-Privacy) +- [FAQ](FAQ) + +### 中文导航 + +- [快速开始与迁移](快速开始) +- [产品全景](产品全景) +- [Harness 与智能体](Agent-模式) +- [会话与持续目标](会话与持续目标) +- [编程工作台](编程工作台) +- [调研与内容创作](Cowork-与创作) +- [个人助手](个人助手) +- [任务板与定时任务](任务板与定时任务) +- [Mini Apps 与 Pages](Mini-Apps-与-Pages) +- [远程与多设备](远程与多设备) +- [Peer Device Mode](Peer-Device-Mode-中文) +- [远程任务派发](远程任务派发) +- [语音与实时通话](语音与实时通话) +- [自定义与扩展](自定义与扩展) +- [安全与隐私](安全与隐私) +- [常见问题](常见问题) + +### References / 参考 + +- [Playbook](https://playbook.openbitfun.com) +- [Download / 下载](https://openbitfun.com/download) +- [Releases](https://github.com/GCWing/OpenBitFun/releases) +- [GitHub](https://github.com/GCWing/OpenBitFun) +- [Issues](https://github.com/GCWing/OpenBitFun/issues) +- [Screenshot checklist / 截图清单](截图清单) diff --git "a/docs/wiki/pages/\344\270\252\344\272\272\345\212\251\346\211\213.md" "b/docs/wiki/pages/\344\270\252\344\272\272\345\212\251\346\211\213.md" new file mode 100644 index 0000000000..42a7d55420 --- /dev/null +++ "b/docs/wiki/pages/\344\270\252\344\272\272\345\212\251\346\211\213.md" @@ -0,0 +1,31 @@ +[简体中文] | [English](Personal-Assistant) · [首页](首页) + +# 个人助手 + +个人助手为长期职责保留专属身份和上下文，不是额外的通用 Harness，也不要求把普通工作划分为 Code 与 Cowork。 + +## 创建与配置 + +1. 打开“助理”，创建或选择一个助理。 +2. 定义名称、角色、头像和协作风格。 +3. 检查身份与人设文件：IDENTITY.md、SOUL.md、USER.md。 +4. 配置相应 Skills、内置工具、MCP 服务与模型。 +5. 从助理卡片或详情页开始对话。 + +新助理默认能力配置决定其初始能力。注意启用、不可用、遮蔽和已更改项；不要假设修改默认值会重写所有已有助理。 + +## 持续工作 + +每个助理拥有自己的工作区和会话。重复工作使用[定时任务](任务板与定时任务)，并确认执行主机和所需服务保持可用。编写人设文件本身不会创建后台任务。 + +## 记忆与洞察 + +长期记忆可按配置保留会话中的持久偏好与知识，应与身份配置分开检查和管理。清除记忆不等于删除会话历史。 + +会话洞察汇总选定时间段的活动，应作为反思报告使用，重要结论仍需对照实际工作确认。 + +语音输入、实时通话和可选桌面伙伴是独立能力，见[语音](语音与实时通话)。重置工作区或删除助理是明确的数据操作，先备份需要保留的材料。 + +[助理功能参考](https://github.com/GCWing/OpenBitFun/blob/v1.0.0/docs/interactive-capabilities/capabilities/feature.personal-assistants.md) + +> 待补截图：S12 — 助理列表与身份；S13 — 默认能力；S14 — 记忆与洞察。 diff --git "a/docs/wiki/pages/\344\272\247\345\223\201\345\205\250\346\231\257.md" "b/docs/wiki/pages/\344\272\247\345\223\201\345\205\250\346\231\257.md" new file mode 100644 index 0000000000..b972fbdd0a --- /dev/null +++ "b/docs/wiki/pages/\344\272\247\345\223\201\345\205\250\346\231\257.md" @@ -0,0 +1,42 @@ +[简体中文] | [English](Product-Overview) · [首页](首页) + +# 产品全景 + +## 一个工作空间，多种工作场景 + +项目提供工作材料与环境；会话保存对话和活动记录；Harness 决定智能体如何推进任务；专门智能体提供角色指令和能力配置。Skills、MCP 与工具扩展能力，权限决定允许执行的操作。 + +编程与非编程是使用场景，不是严格分离的 Code/Cowork 模式。个人助手提供持续身份和专属上下文，也不应与通用 Harness 混为一谈。 + +## 四种 Harness + +| Harness | 适合作为起点的任务 | +| --- | --- | +| Minimal | 目标明确的小任务、快速来回协作 | +| Standard | 需要规划与验证的日常多步骤工作 | +| Ultimate | 复杂调查与多智能体协调工作 | +| Creative | Mini App 创建与客户端定制 | + +详见[Harness 选择](Agent-模式)。任务复杂度只是选择依据，不代表速度、成本或结果的保证。 + +## 能力地图 + +- 文件、编辑器、终端、Git、浏览器与预览：[编程工作台](编程工作台)。 +- 调研、文档、演示文稿、表格、PDF 与可视化：[内容创作](Cowork-与创作)。 +- 持久历史、目标、用量与上下文管理：[会话与持续目标](会话与持续目标)。 +- 长期助手与重复工作：[个人助手](个人助手)、[定时任务](任务板与定时任务)。 +- 专用界面与智能体会话结合的工具：[Mini Apps](Mini-Apps-与-Pages)。 +- 静态页面版本与显式发布：[Pages](Mini-Apps-与-Pages)。 +- 手机/Bot 控制、SSH/容器/WSL 工作区、设备控制和持久远程任务：[远程指南](远程与多设备)。 +- 听写与实时语音协作：[语音](语音与实时通话)。 +- 自定义智能体、Skills、MCP、Hooks、生态兼容与皮肤：[扩展指南](自定义与扩展)。 + +可用性取决于平台、模型配置、权限、运行时与服务部署。办公成果依赖相应 Skills 和工具，不代表任意模型无需配置就能生成所有格式。 + +## 查找功能 + +使用全局搜索或 [Playbook](https://playbook.openbitfun.com) 查找功能与设置，也可以请智能体定位入口或修改受支持设置。“打开设置页”不等于“完成配置”，部分操作仍需你交互确认。 + +[带源码证据的功能参考](https://github.com/GCWing/OpenBitFun/tree/v1.0.0/docs/interactive-capabilities) + +> 待补截图：S02 — 全局搜索与功能发现。 diff --git "a/docs/wiki/pages/\344\273\273\345\212\241\346\235\277\344\270\216\345\256\232\346\227\266\344\273\273\345\212\241.md" "b/docs/wiki/pages/\344\273\273\345\212\241\346\235\277\344\270\216\345\256\232\346\227\266\344\273\273\345\212\241.md" new file mode 100644 index 0000000000..f1dd796bd5 --- /dev/null +++ "b/docs/wiki/pages/\344\273\273\345\212\241\346\235\277\344\270\216\345\256\232\346\227\266\344\273\273\345\212\241.md" @@ -0,0 +1,33 @@ +[简体中文] | [English](Tasks-and-Automation) · [首页](首页) + +# 任务板与定时任务 + +## 安排未来或重复工作 + +打开任务板查看待处理、日历和已停用视图。定时任务不同于会话目标，它决定何时、在哪里启动另一次运行。 + +1. 从可用任务/助理入口创建定时任务，或请智能体创建。 +2. 定义目标，选择一次性、每日、每周或自定义 Cron。 +3. 核对显示时区和后续运行时间，在请求中明确期望时区。 +4. 选择工作区、智能体、模型、工作方式及受支持执行目标。 +5. 保存后检查日历与启用状态。 + +先用无害任务验证环境，再依赖重要的重复流程。 + +## 主机与权限条件 + +拥有调度/执行的宿主需可用并就绪。远程目标需要相应连接和能力，不代表任意目标自动可用。 + +等待权限时可能需要远程回答。定时不等于授权购买、发布、删除或无限 Full Access；关机的机器也不是云端调度器。 + +助理任务可按自身工作区管理，应确认所选工作区，不要假设全部助理共享任务列表。 + +## 编辑与停止 + +检查下次运行，修改时间或范围，启用或停用。暂停流程时关闭未来调度；取消已运行会话和删除任务是不同操作。 + +例如：“按我的时区每周一 09:00 总结项目近期工作，保存报告，不发消息、不修改源码。” + +[定时任务参考](https://github.com/GCWing/OpenBitFun/blob/v1.0.0/docs/interactive-capabilities/capabilities/feature.tasks-automation.md) + +> 待补截图：S29 — 任务板/日历；S30 — 任务配置与执行目标。 diff --git "a/docs/wiki/pages/\344\274\232\350\257\235\344\270\216\346\214\201\347\273\255\347\233\256\346\240\207.md" "b/docs/wiki/pages/\344\274\232\350\257\235\344\270\216\346\214\201\347\273\255\347\233\256\346\240\207.md" new file mode 100644 index 0000000000..d968f50ff1 --- /dev/null +++ "b/docs/wiki/pages/\344\274\232\350\257\235\344\270\216\346\214\201\347\273\255\347\233\256\346\240\207.md" @@ -0,0 +1,35 @@ +[简体中文] | [English](Sessions-and-Goals) · [首页](首页) + +# 会话与持续目标 + +## 创建与整理 + +在目标工作区新建会话，首轮前选择 Harness/智能体，再核对模型与权限。按需重命名、归档、恢复、搜索、分叉或导出。删除不同于归档，需要明确意图。 + +检查工具输出、修改文件、后台命令和等待交互，不要只依赖最后一句完成说明。 + +## 引导、打断与恢复 + +通过支持的引导流程补充指令，重定向正在进行的工作；确认排队消息状态，不要假设已执行。按需打断或取消，但这不会撤销已完成的编辑或外部影响。 + +恢复依赖持久会话/运行时状态与执行宿主。连接丢失不证明任务已停止，重试提交前确认宿主与会话身份，避免重复执行。 + +## 分叉与上下文 + +分叉对话可以探索另一方向，它复制选定历史，不自动创建 Git worktree 或复制文件。远程分叉保留连接与 POSIX 路径，共享原工作树。 + +上下文重载、指令初始化、记忆管理和压缩改变模型可见信息，不一定删除持久历史。重置记忆与删除会话是不同操作。 + +支持时可使用 BTW 轻量问答或编辑器内联 AI 处理旁支问题，并保持主任务范围明确。 + +## 持续目标 + +需要持久目标时，明确请求创建会话目标，检查目标说明和状态，按需编辑或清除。应根据真实进展完成目标或标记阻塞，而非仅凭工具次数。 + +目标不是时间表，未来运行使用[定时任务](任务板与定时任务)，目标主机拥有的远程执行使用[派发](远程任务派发)。 + +支持时查看会话请求、Token 与成本报告。服务定价与报告估算可能不同，重要账单假设需向服务商核实。 + +[会话功能参考](https://github.com/GCWing/OpenBitFun/blob/v1.0.0/docs/interactive-capabilities/capabilities/feature.ai-assistant.md) + +> 待补截图：S27 — 会话操作与目标；S28 — 用量与后台命令。 diff --git "a/docs/wiki/pages/\345\256\211\345\205\250\344\270\216\351\232\220\347\247\201.md" "b/docs/wiki/pages/\345\256\211\345\205\250\344\270\216\351\232\220\347\247\201.md" new file mode 100644 index 0000000000..f095dab040 --- /dev/null +++ "b/docs/wiki/pages/\345\256\211\345\205\250\344\270\216\351\232\220\347\247\201.md" @@ -0,0 +1,46 @@ +[简体中文] | [English](Security-and-Privacy) · [首页](首页) + +# 安全与隐私 + +## 数据流向取决于工作流程 + +核心本地工作不要求把整个项目上传到 OpenBitFun 账号，但相关提示、文件、图片和工具上下文仍可能发送到配置的模型或外部服务。云端语音、MCP、消息平台、市场服务和 Pages 各有数据边界。 + +“本地优先”不代表全部处理都在本地。SSH 工作区的运行时/会话元数据保留在宿主，工作区 IO 指向目标；Peer Device Mode 与 Dispatch 则由其他宿主执行。 + +## 权限与重要操作 + +不熟悉的工作采用需要审批的权限方式。Full Access 减少询问，不是沙箱，也不保证操作无害。记住的规则是真实授权，应保持范围狭窄。 + +批准文件修改、命令、浏览器/电脑操作或扩展前，检查目标、可逆性、凭据和泄露风险。麦克风、屏幕录制与输入控制等系统权限另行管理。 + +调研或起草请求不等于购买、发消息、发布或删除的许可。备份重要数据，会话回滚不能撤销全部外部影响。 + +## 远程流量与端点 + +配对内容端到端加密，但路由、时间、在线状态等元数据不一定隐藏。模型服务流量、Bot 平台、已发布 Pages 与被攻破的设备，不会因为 Relay 加密就自动获得相同保护。 + +确认执行设备与服务部署可信，撤销不再使用的设备/连接。公共 Relay 不意味着可用性、合规或保留策略保证。 + +## 扩展 + +- Skills 提供指令，仍需检查代码和依赖要求。 +- MCP 暴露外部工具，应限制服务和权限。 +- Mini Apps 请求路径/工作区访问，可能使用 Worker 和模型。 +- Hooks 执行命令；项目 Hook 默认关闭，需审阅。 +- 生态发现不等于批准所有导入代码执行。 +- ACP 进程具有独立的权限与信任假设。 + +更新时检查新增权限。导入无法解析时保留副本与来源配置，不要通过重置用户数据恢复。 + +## 账号、发布、记忆与语音 + +Pages 发布是有意披露，检查可见性和最终分享链接。账号设备控制依赖配置的服务。记忆、会话洞察与语音设置需分别审查。本地和云端转写数据流不同，实时语音也取决于所配置服务。 + +旧数据采用[迁移流程](快速开始)，在数据所属机器执行并检查警告，不要删除旧记录。 + +## 私下报告漏洞 + +遵循[安全政策](https://github.com/GCWing/OpenBitFun/blob/v1.0.0/SECURITY.md)，使用[私密漏洞报告](https://github.com/GCWing/OpenBitFun/security/advisories/new)，不要在公开 Issue 中发布利用细节、密钥或个人记录。 + +> 待补截图：S26 — 权限请求与记住规则的范围。 diff --git "a/docs/wiki/pages/\345\270\270\350\247\201\351\227\256\351\242\230.md" "b/docs/wiki/pages/\345\270\270\350\247\201\351\227\256\351\242\230.md" new file mode 100644 index 0000000000..b868767ea7 --- /dev/null +++ "b/docs/wiki/pages/\345\270\270\350\247\201\351\227\256\351\242\230.md" @@ -0,0 +1,71 @@ +[简体中文] | [English](FAQ) · [首页](首页) + +# 常见问题 + +## OpenBitFun 只适合编程吗？ + +不是。编程、调研、办公与创作共享 Agent 工作空间，制作文档和分析数据不要求单独 Cowork 模式。 + +## 应该选哪个模式？ + +通用 Harness 是 Minimal、Standard、Ultimate、Creative。小任务从 Minimal 开始；日常多步骤任务选 Standard；复杂工作选 Ultimate；创建/定制工作空间可选 Creative。见[选择说明](Agent-模式)。 + +## 能先规划而不实施吗？ + +可以，明确说“先调查并给方案，不要修改”。Harness 不会覆盖任务范围或权限规则。 + +## 可以在会话中途切换 Harness 吗？ + +当前选择器在首轮前选择；会话开始后改选其他执行配置会要求新建会话。见[会话管理](会话与持续目标)。 + +## 能直接从 0.2.x 升级吗？ + +旧数据与 1.0 不直接兼容。使用支持稳定版 0.2.17–0.2.19 的可选迁移工具，并保留备份。见[迁移步骤](快速开始)。 + +## 免费吗，需要账号吗？ + +核心代码采用 [MIT 许可](https://github.com/GCWing/OpenBitFun/blob/v1.0.0/LICENSE)。模型 API、云语音、基础设施及其他服务可能收费。核心本地使用不要求 OpenBitFun 账号；账号设备控制与 Pages 依赖相应账号服务。 + +## 可以离线使用吗？ + +取决于模型、语音、工具和依赖是否能离线运行。云端地址和联网调研自然需要网络。 + +## 能生成可编辑办公文件吗？ + +受支持 Skills/工具链可以生成可编辑成果。确认依赖并检查保存结果，不是任意模型自动支持全部格式。 + +## 会上传整个项目吗？ + +核心使用不要求把整个项目上传到账号，相关内容仍可能发送至模型或外部工具。见[隐私说明](安全与隐私)。 + +## SSH、设备控制与派发有什么区别？ + +SSH 改变工作区 IO/命令目标，Agent Runtime 仍在宿主；设备控制使用另一宿主的状态与执行；派发提交目标拥有的持久任务与托管 Git worktree。见[远程对照](远程与多设备)。 + +## 控制端可以关闭吗？ + +已接受的设备任务属于执行运行时，而非控制端界面。Dispatch 在持久接受后可随控制端断开继续；执行宿主和依赖仍需可用，权限等待仍可能阻塞。 + +## 分叉会话会隔离文件吗？ + +不会。它复制历史并保留工作区绑定，远程分叉共享工作树。文件隔离请使用 worktree 或独立工作区。 + +## 可以用手机或消息平台吗？ + +可以，通过受支持 Remote Connect 手机/Bot 流程。浏览器/设备控制两端使用相同 GitHub 身份，局域网也如此；二维码邀请不是匿名授权。Bot 按连接器配置凭据。各表面能力不同，见[远程控制](远程与多设备)。 + +## 语音输入和实时通话相同吗？ + +不同。听写先生成可编辑文字再发送；实时通话持续语音协作并可请求项目工作，有独立服务要求。见[语音](语音与实时通话)。 + +## Mini Apps、Pages、皮肤有什么区别？ + +Mini Apps 是已安装交互工具；Pages 发布版本化静态成果；皮肤改变外观。见[Mini Apps 与 Pages](Mini-Apps-与-Pages)和[定制](自定义与扩展)。 + +## 可以使用其他生态的全部插件吗？ + +兼容是选择性的。发现、导入、启用不同；OpenCode 静态预览不代表完整实时插件执行。见[兼容限制](自定义与扩展)。 + +## 去哪里获取帮助？ + +[Playbook](https://playbook.openbitfun.com)、[Issues](https://github.com/GCWing/OpenBitFun/issues)与[贡献指南](https://github.com/GCWing/OpenBitFun/blob/v1.0.0/CONTRIBUTING_CN.md)。附版本、系统、目标、错误文本和复现步骤，移除密钥；安全问题私下报告。 diff --git "a/docs/wiki/pages/\345\277\253\351\200\237\345\274\200\345\247\213.md" "b/docs/wiki/pages/\345\277\253\351\200\237\345\274\200\345\247\213.md" new file mode 100644 index 0000000000..f5b935f6c7 --- /dev/null +++ "b/docs/wiki/pages/\345\277\253\351\200\237\345\274\200\345\247\213.md" @@ -0,0 +1,44 @@ +[简体中文] | [English](Getting-Started) · [首页](首页) + +# 快速开始与数据迁移 + +## 安装 + +从[官方下载页](https://openbitfun.com/download)获取 Windows、macOS 或 Linux 安装包，核对系统和架构；签名检查见[下载验证](https://github.com/GCWing/OpenBitFun/blob/v1.0.0/docs/verify-downloads.md)。Nightly 是独立的可能不稳定的构建渠道。 + +## 从旧 0.2.x 版本迁移 + +OpenBitFun 1.0 与旧 0.2.x 安装的数据不兼容，不要直接指向旧数据目录并假设普通升级会自动转换全部内容。 + +可选的[数据迁移工具](https://github.com/GCWing/OpenBitFun/blob/v1.0.0/src/apps/data-migrator/README.zh-CN.md)支持旧稳定版 0.2.17–0.2.19。更早版本需先升级旧应用，并确认旧数据仍可正常读取。 + +1. 备份数据，关闭两款应用、CLI 实例及后台数据写入进程。 +2. 在拥有数据的机器上打开迁移工具。 +3. 核对源与目标目录，选择数据组，扫描并审阅预检计划。 +4. 执行迁移，检查警告、跳过项、冲突和报告。 +5. 自行打开 OpenBitFun，按报告修复路径或重新登录。 + +迁移工具不会自动删除源数据。不要把删除或重置任一应用数据当作通用修复方式。迁移远程连接记录不等于迁移远程机器。 + +## 开始第一项任务 + +1. 按初始化流程配置受支持模型服务或自定义地址，核对凭据、模型能力并测试连接。“配置已保存”不代表“连接成功”。 +2. 打开包含代码、笔记、数据或其他材料的项目目录。 +3. 新建会话：小任务可从 Minimal 开始，多步骤工作可选 Standard。 +4. 初次使用选择需要审批的权限方式。 +5. 说明目标和限制，并检查实际结果。 + +适合首次使用的提示： + +- “解释这个项目，不要修改文件。” +- “把这些笔记整理成简报，指出没有依据的说法。” +- “分析这份表格并保存报告；修改原始材料前先询问。” +- “规划一个小改进，实施前等我确认。” + +模型服务可能产生费用。核心本地工作不要求账号登录；账号设备控制和 Pages 需要相应账号服务。 + +## 获取帮助 + +通过全局搜索与 [Playbook](https://playbook.openbitfun.com)查找说明，也可阅读[Harness](Agent-模式)、[安全](安全与隐私)与[FAQ](常见问题)。反馈问题时附应用版本、系统、目标环境及复现步骤。 + +> 待补截图：S05 — 模型配置与连接测试；S06 — 首次会话；S07 — 迁移预检。 diff --git "a/docs/wiki/pages/\346\210\252\345\233\276\346\270\205\345\215\225.md" "b/docs/wiki/pages/\346\210\252\345\233\276\346\270\205\345\215\225.md" new file mode 100644 index 0000000000..4163c1b125 --- /dev/null +++ "b/docs/wiki/pages/\346\210\252\345\233\276\346\270\205\345\215\225.md" @@ -0,0 +1,57 @@ +[简体中文] | [English](Screenshot-Checklist) · [首页](首页) + +# 待补截图清单 + +本次仅刷新文字，不生成或上传截图。旧版首页图片已移除，正文用 S01–S36 标注待补位置，避免显示失效或误导界面。共 36 个截图主题；部分主题需要多张图片，并非强制 36 个文件。 + +P0 是入门、模式、执行归属或安全边界，优先补；P1 是主要功能；P2 是补充示例。 + +## 统一拍摄要求 + +- 使用同一已发布版本，记录版本、系统、语言和主题；若展示开发版新增能力，明确标注，不混入稳定版图。 +- 中文页优先中文界面，英文页优先英文界面；演示数据尽量一致。无界面文字的通用图可共享。 +- 使用演示项目与账号，隐藏 API Key、Bot Token、邮箱、私有仓库、敏感路径、IP 和个人文件。二维码/配对码使用失效演示值或遮盖，不发布有效访问凭据。 +- 截图必须来自真实界面，保留关键状态与目标标识；不要为拍图执行删除、重置、发布或全权限授权。确认框停留在未提交阶段即可。 +- 按主题保存为 `s03-harness-zh-cn.png` / `s03-harness-en-us.png` 等，需要多张时加 `-01`、`-02`。在 Wiki 可公开访问的素材地址上传后，用有意义的图片说明替换对应占位。 +- 核对所有图片链接和相邻文字。截图用于说明界面，不视为功能或远程行为验证证据。 + +## 清单 + +| 编号 | 优先级 | 页面 | 主题 | 必需画面 | +| --- | --- | --- | --- | --- | +| S01 | P0 | [首页](首页) | 桌面整体界面 | 项目导航、对话和工作台 | +| S02 | P1 | [产品全景](产品全景) | 全局搜索 | 功能/设置搜索结果与目标入口 | +| S03 | P0 | [Agent-模式](Agent-模式) | Harness 选择器 | 四种 Harness 与专门角色入口 | +| S04 | P0 | [Agent-模式](Agent-模式) | 已开始会话改选 | 尚未提交的新会话确认 | +| S05 | P0 | [快速开始](快速开始) | 模型配置 | 服务/模型与连接测试结果 | +| S06 | P0 | [快速开始](快速开始) | 首次会话 | 工作区、Harness、模型与权限 | +| S07 | P0 | [快速开始](快速开始) | 迁移预检 | 源/目标、数据组和警告 | +| S08 | P1 | [编程工作台](编程工作台) | 编程工作台 | 编辑器、终端与智能体输出 | +| S09 | P1 | [编程工作台](编程工作台) | Git 与评审 | 改动文件、差异与评审结果 | +| S10 | P1 | [Cowork-与创作](Cowork-与创作) | 成果预览 | 已保存文档/演示文稿/表格及预览 | +| S11 | P2 | [Cowork-与创作](Cowork-与创作) | 交互解释 | 清晰图示与可调交互 | +| S12 | P1 | [个人助手](个人助手) | 助理身份 | 列表/卡片与人设编辑，可分两张 | +| S13 | P1 | [个人助手](个人助手) | 默认能力 | Skills、工具、MCP 状态与范围 | +| S14 | P2 | [个人助手](个人助手) | 记忆与洞察 | 记忆控制和脱敏洞察，可分两张 | +| S15 | P1 | [Mini-Apps-与-Pages](Mini-Apps-与-Pages) | 市场与应用 | 安装详情与带会话的运行界面，可分两张 | +| S16 | P1 | [Mini-Apps-与-Pages](Mini-Apps-与-Pages) | 定制 | 草稿预览、权限差异与应用操作 | +| S17 | P1 | [Mini-Apps-与-Pages](Mini-Apps-与-Pages) | Pages | 版本、部署与可见性 | +| S18 | P0 | [远程与多设备](远程与多设备) | Remote Connect | 局域网/Relay 选项与已失效二维码 | +| S19 | P1 | [远程与多设备](远程与多设备) | 手机布局 | 单屏与受支持多屏布局，可分多张 | +| S20 | P0 | [远程与多设备](远程与多设备) | 工作区目标 | 目标类型、测试状态与目标路径 | +| S21 | P1 | [远程与多设备](远程与多设备) | Bot 连接 | 平台和状态，不含令牌 | +| S22 | P1 | [自定义与扩展](自定义与扩展) | 智能体配置 | 角色、模型、只读与能力 | +| S23 | P1 | [自定义与扩展](自定义与扩展) | 生态导入 | 五类来源、导入计划/冲突与状态，可分两张 | +| S24 | P1 | [自定义与扩展](自定义与扩展) | Hooks | 项目开关与命令审查计划 | +| S25 | P1 | [自定义与扩展](自定义与扩展) | 外观 | 内置外观、本地包预览与 Skin 市场，可分多张 | +| S26 | P0 | [安全与隐私](安全与隐私) | 权限请求 | 操作目标与记住规则范围 | +| S27 | P1 | [会话与持续目标](会话与持续目标) | 会话与目标 | 分叉/导出菜单、目标和状态，可分两张 | +| S28 | P2 | [会话与持续目标](会话与持续目标) | 用量/后台工作 | 用量报告、进程输出与停止/输入，可分两张 | +| S29 | P1 | [任务板与定时任务](任务板与定时任务) | 任务板 | 待处理/日历/停用与后续任务 | +| S30 | P0 | [任务板与定时任务](任务板与定时任务) | 任务配置 | 时间/时区、工作区、模型与目标 | +| S31 | P0 | [Peer-Device-Mode-中文](Peer-Device-Mode-中文) | 设备控制 | 设备列表、所选对端与工作区标识，可分两张 | +| S32 | P0 | [远程任务派发](远程任务派发) | 派发准备 | 目标、基线、未提交选项与预检 | +| S33 | P0 | [远程任务派发](远程任务派发) | 派发跟踪 | 任务状态、权限与结果同步，可分多张 | +| S34 | P1 | [语音与实时通话](语音与实时通话) | 语音配置 | 麦克风/模型状态与测试结果 | +| S35 | P1 | [语音与实时通话](语音与实时通话) | 转写 | 录音状态与输入框可编辑文字，可分两张 | +| S36 | P1 | [语音与实时通话](语音与实时通话) | 实时通话 | 通话、项目任务、停止任务与结束通话区别 | diff --git "a/docs/wiki/pages/\347\274\226\347\250\213\345\267\245\344\275\234\345\217\260.md" "b/docs/wiki/pages/\347\274\226\347\250\213\345\267\245\344\275\234\345\217\260.md" new file mode 100644 index 0000000000..ac4cefe505 --- /dev/null +++ "b/docs/wiki/pages/\347\274\226\347\250\213\345\267\245\344\275\234\345\217\260.md" @@ -0,0 +1,34 @@ +[简体中文] | [English](Coding-Workspace) · [首页](首页) + +# 编程工作台 + +## 从需求到可检查的改动 + +1. 打开正确项目，核对它属于本地、SSH、容器、WSL 还是另一台设备。 +2. 请智能体检查相关代码并解释发现；只需规划时，明确禁止修改。 +3. 审阅方案后，授权在约定范围内实施。 +4. 运行项目检查，查看差异及未解决的失败。 +5. 提交、推送或发布前审查改动。 + +执行方式见[Harness 选择](Agent-模式)。调试、规划、调研和审查不需要按旧指南寻找同名模式按钮。 + +## 集成工具 + +- 文件与编辑器：浏览和整理材料、搜索、编辑代码/文本、查看 Markdown/图片与差异，使用可用的语言服务和内联 AI。 +- 终端：执行命令，使用多个终端视图，检查后台进程。 +- Git：查看改动、历史、分支和 worktree；在获得相应授权后暂存、提交、推送或拉取。 +- 浏览器：检查页面、完成受支持交互并收集可视化证据。 +- 审查：请求可操作的问题，或使用现有评审流程；只读审查不应悄悄实施修复。 +- 会话：分开保存不同对话，查看修改文件并管理历史，见[会话管理](会话与持续目标)。 + +语言服务、浏览器与电脑操作依赖服务配置和系统权限。命令成功不等于生成的应用已正常工作。 + +## 恢复不等于完整备份 + +分叉会话复制的是对话历史，不是独立文件系统。快照与回滚取决于已记录覆盖和目标支持，不能保护所有命令和外部副作用。 + +远程会话目前不能在覆盖未确认时执行完整文件回滚或编辑后重跑；部分已记录操作仍可在断线后展示差异。使用 Git 提交与备份保障恢复，不要假设会话分叉能隔离工作。 + +[远程指南](远程与多设备) · [CLI 参考](https://github.com/GCWing/OpenBitFun/blob/v1.0.0/src/apps/cli/README.md) + +> 待补截图：S08 — 编辑器、终端与会话；S09 — Git 改动与评审。 diff --git "a/docs/wiki/pages/\350\207\252\345\256\232\344\271\211\344\270\216\346\211\251\345\261\225.md" "b/docs/wiki/pages/\350\207\252\345\256\232\344\271\211\344\270\216\346\211\251\345\261\225.md" new file mode 100644 index 0000000000..82d63d6e34 --- /dev/null +++ "b/docs/wiki/pages/\350\207\252\345\256\232\344\271\211\344\270\216\346\211\251\345\261\225.md" @@ -0,0 +1,41 @@ +[简体中文] | [English](Customize-and-Extend) · [首页](首页) + +# 自定义与扩展 + +## 从最小扩展开始 + +1. 调整角色指令与权限。 +2. 用 Skill 封装可重复知识。 +3. 通过 MCP 连接外部工具。 +4. 用 Mini App 提供专用界面。 +5. 用可信 Hook 控制生命周期行为。 +6. 按需使用选择性生态兼容或 ACP。 +7. 产品本身确需改变时再修改源码。 + +## 智能体、Skills 与 MCP + +在智能体管理中检查内置、用户、项目和外部角色。根据当前宿主目录配置工具/工具组、Skills/Skill 组、模型策略与只读限制。子智能体处理边界明确的委派任务，不代表每个角色都是通用 Harness。 + +Skills 提供流程指引，可能依赖运行环境；注意来源、范围、遮蔽与可用状态。MCP 需要配置传输和认证、测试连接，再为相关智能体明确选择服务/工具。MCP 配置已保存和服务已连接是不同状态。 + +## Hooks + +OpenBitFun 原生用户 Hook 实现 Codex Hook 契约，并记录具体差异。使用 OpenBitFun 自己的用户/项目配置文件与“设置 → Agent Hooks”。项目 Hook 默认关闭，会执行仓库代码，审阅后再开启。 + +兼容的 Claude Code/Codex 命令 Hook 可作为显式审查的快照导入；更新需再次审查，删除托管副本不会修改来源工具文件。Hook 管理与执行为本地能力，远程工作区会返回不支持。 + +OpenCode 插件回调仅供发现/静态预览，不是可执行原生 Hook。路径、开关与限制见[OpenBitFun Hook 指南](https://github.com/GCWing/OpenBitFun/blob/v1.0.0/docs/features/agent-hooks.md)。 + +## 生态兼容 + +兼容界面覆盖 OpenCode、Claude Code、Codex、DeepSeek Harness 与 PI，请逐来源、逐类别查看状态。发现、导入副本、启用、连接依赖是不同步骤。 + +选择受支持的 Skill/MCP/Hook，审查导入计划与冲突后确认副本；Command、Tool、子智能体使用各自受支持路径，不是通用插件执行。DeepSeek Harness/PI Hook 目录为只读，OpenCode 托管包/静态预览不能描述为完整实时运行时。 + +## 皮肤与客户端定制 + +在“设置 → 应用 → 外观”选择主题、语言、字体、本地外观包和 Skin 市场。应用前预览，保留可恢复的内置外观，检查市场更新。[Skin 市场](https://market.openbitfun.com/skin/)。 + +Creative 提供客户端界面/运行时定制，与视觉皮肤和修改构建源码产品不同。源码开发遵循[贡献指南](https://github.com/GCWing/OpenBitFun/blob/v1.0.0/CONTRIBUTING_CN.md)。ACP 连接受支持的外部智能体进程，仍有独立配置与信任边界。 + +> 待补截图：S22 — 智能体能力配置；S23 — 生态导入；S24 — Hook 审查；S25 — 外观/Skin 市场。 diff --git "a/docs/wiki/pages/\350\257\255\351\237\263\344\270\216\345\256\236\346\227\266\351\200\232\350\257\235.md" "b/docs/wiki/pages/\350\257\255\351\237\263\344\270\216\345\256\236\346\227\266\351\200\232\350\257\235.md" new file mode 100644 index 0000000000..c13e50b46e --- /dev/null +++ "b/docs/wiki/pages/\350\257\255\351\237\263\344\270\216\345\256\236\346\227\266\351\200\232\350\257\235.md" @@ -0,0 +1,35 @@ +[简体中文] | [English](Voice-and-Realtime) · [首页](首页) + +# 语音输入与实时通话 + +## 两种不同流程 + +| 流程 | 结果 | 检查边界 | +| --- | --- | --- | +| 语音转文字 | 录音转成输入框文字 | 发送前可编辑 | +| 实时通话 | 持续语音对话并听取回复 | 项目/工具操作仍遵循权限 | + +实时通话可请求助理进入项目、执行或停止工作，并播报简要进展。安装本地转写模型不代表配置的云端实时通话变成本地处理。 + +## 配置并测试听写 + +1. 打开独立语音设置页。 +2. 启用语音，选择配置的本地或云端识别路径。 +3. 本地识别需检查模型下载、安装与验证状态并完成准备。 +4. 选择麦克风与识别语言，或自动检测。 +5. 运行麦克风/识别测试，再从聊天输入框录音。 +6. 结束录音后检查并编辑文字再发送，取消则丢弃录音。 + +重试前检查麦克风系统权限、模型状态、服务凭据、网络和测试错误，不要通过删除无关模型或应用数据通用修复。 + +## 实时协作 + +配置实时语音服务，从可用客户端入口发起通话；要求执行前确认当前项目。停止项目任务和结束通话不同，结束音频不会撤销已经完成的工作。 + +服务/模型、音频支持和入口随安装而异；桌面支持不代表手机/Bot 或远程宿主语音等价。选定表面不支持时，不应悄悄改走控制端本地语音服务。 + +确认哪些音频和上下文离开设备，无法核实隐私设置时，敏感指令改用文字。 + +[语音功能参考](https://github.com/GCWing/OpenBitFun/blob/v1.0.0/docs/interactive-capabilities/capabilities/feature.voice-input.md) + +> 待补截图：S34 — 语音设置/测试；S35 — 录音与可编辑文字；S36 — 实时通话与项目任务。 diff --git "a/docs/wiki/pages/\350\277\234\347\250\213\344\270\216\345\244\232\350\256\276\345\244\207.md" "b/docs/wiki/pages/\350\277\234\347\250\213\344\270\216\345\244\232\350\256\276\345\244\207.md" new file mode 100644 index 0000000000..3e9e76b073 --- /dev/null +++ "b/docs/wiki/pages/\350\277\234\347\250\213\344\270\216\345\244\232\350\256\276\345\244\207.md" @@ -0,0 +1,44 @@ +[简体中文] | [English](Remote-and-Multi-device) · [首页](首页) + +# 远程与多设备 + +## 先分清远程场景 + +| 场景 | 连接的是什么 | 执行与数据归属 | +| --- | --- | --- | +| 远程工作区 | 工作区 IO 与命令指向 SSH/容器/WSL | Agent Runtime 和会话元数据仍在 OpenBitFun 宿主，文件和工作区命令使用目标环境 | +| 远程控制 | 手机或 Bot 向宿主发送请求 | 已连接宿主拥有执行和会话 | +| Peer Device Mode | 本地界面使用另一设备的产品命令/事件 | 所选 Desktop/CLI 拥有工作和记录 | +| Detached Dispatch | 向另一主机提交持久任务 | 目标拥有运行时、任务会话、托管 worktree 与记录 | + +它们不是可以互换的“远程模式”。远程工作区不会自动在目标安装或启动 OpenBitFun。前提条件见[Peer Device Mode](Peer-Device-Mode-中文)与[Detached Dispatch](远程任务派发)。 + +## 手机与 Bot 控制 + +1. 在宿主打开 Remote Connect。 +2. 选择局域网或配置好的官方 Relay 路径，检查连接状态和网络信息。 +3. 宿主和手机控制端使用相同 GitHub 身份登录，再按二维码邀请流程连接。二维码包含端点/设备身份，不是匿名访问授权。 +4. 确认宿主与工作区，再发送请求或查看已有会话。 +5. 在驱动端回答支持的权限请求，断线后重连恢复历史。 + +当前界面没有独立 ngrok 或 custom-server 页签。同网络模式在宿主启动 Relay，局域网和官方 Relay 都通过 GitHub 身份验证，登录需要互联网。官方端点固定；自托管需匹配的客户端构建，不是填写服务器 URL 或使用部署向导。参阅[Relay 指南](https://github.com/GCWing/OpenBitFun/blob/v1.0.0/src/apps/relay-server/README.md)。 + +飞书、Telegram、微信/iLink 有专门 Bot 配置。会话控制范围随表面与连接器不同；移动网页支持自适应布局，但不代表全部桌面能力等价，也不意味着手机拥有独立任务运行时。 + +## 远程工作区 + +目标包括 SSH、跳板机链、SSH 主机上的 Docker、本地 Docker、容器 sshd，以及执行 Windows 宿主上的 WSL。配置并测试连接，选择真实目标工作区路径，确认终端和文件属于目标环境。 + +远程路径使用 POSIX 分隔符。容器路径位于容器内部，主机挂载只按挂载位置可见；Docker 命令需要兼容的 POSIX shell。 + +智能体 Grep/Glob 与远程文件名搜索可通过支持的 Provider 使用。远程 Flashgrep 加速内容搜索和索引入口不可用，应用不应悄悄搜索本地文件；远程文件回滚也有覆盖限制，见[编程工作台](编程工作台)。 + +Git 提示目录所有权不安全时，核对目标，在仓库所属机器自行授予 safe.directory 信任；OpenBitFun 不会静默授予远程信任。 + +## 断线与安全 + +控制端断开不等于取消任务。执行宿主仍需保持运行，等待权限的任务仍需有人回答。配对内容加密不隐藏全部路由元数据，也不能保护已被攻破的端点，见[安全说明](安全与隐私)。 + +[工作区详细指南](https://github.com/GCWing/OpenBitFun/blob/v1.0.0/docs/features/remote-workspaces.md) + +> 待补截图：S18 — Remote Connect 与二维码；S19 — 手机布局；S20 — 目标连接；S21 — Bot 配置。 diff --git "a/docs/wiki/pages/\350\277\234\347\250\213\344\273\273\345\212\241\346\264\276\345\217\221.md" "b/docs/wiki/pages/\350\277\234\347\250\213\344\273\273\345\212\241\346\264\276\345\217\221.md" new file mode 100644 index 0000000000..6afedb34eb --- /dev/null +++ "b/docs/wiki/pages/\350\277\234\347\250\213\344\273\273\345\212\241\346\264\276\345\217\221.md" @@ -0,0 +1,34 @@ +[简体中文] | [English](Detached-Dispatch) · [首页](首页) + +# Detached Dispatch 远程任务派发 + +## 提交目标主机拥有的任务 + +派发将持久工作提交到另一台 OpenBitFun 主机。目标持久接受后，控制端可以断开；目标拥有 Worker、会话、worktree、执行记录与权限邮箱。 + +## 准备与提交 + +1. 打开 Git 仓库或托管 worktree。派发工作区交付仅支持 Git，不是任意目录上传。 +2. 打开会话派发选择器，选择受支持 SSH 或账号设备目标。 +3. 核对协议/能力、目标 CLI/运行时、模型配置和权限，审查准备过程要求的安装/更新或模型同步。 +4. 选择基线版本，决定是否包含未提交的 Git 可见改动。 +5. 审查任务并提交，断开前等待目标持久接受。 +6. 跟踪任务状态，重连后恢复执行记录。 + +目标获得托管任务 worktree，不是调用者随意指定的执行目录。选择包含未提交改动时，它们在控制端托管基线 worktree 中提交，不会暂存或切换用户原检出。被 Git 忽略的 .env、构建产物等不交付，目标所需依赖要另行准备。 + +## 查看、回答与取消 + +检查状态、错误和权限等待，远程回答支持的请求，或明确取消目标任务。执行主机需保持可用，控制端断线不能让已关机目标继续运行。 + +提交结果不确定时先查看已有任务记录，再决定是否新建，不要因为失败或离线就删除可恢复记录。 + +## 有意同步结果 + +控制端基线和目标 worktree 不是实时共享目录，原检出后续改动不会自动传给运行中的任务。结果同步把目标任务分支导入控制端托管基线，检查改动后再整合到正常分支。 + +同步可能提交目标任务 worktree 中 Git 可见改动，是有意变更，不是只读刷新。 + +[派发归属与交付契约](https://github.com/GCWing/OpenBitFun/blob/v1.0.0/docs/architecture/detached-task-dispatch.md) + +> 待补截图：S32 — 目标/预检；S33 — 状态、权限与同步。 diff --git "a/docs/wiki/pages/\351\246\226\351\241\265.md" "b/docs/wiki/pages/\351\246\226\351\241\265.md" new file mode 100644 index 0000000000..8d109a2384 --- /dev/null +++ "b/docs/wiki/pages/\351\246\226\351\241\265.md" @@ -0,0 +1,31 @@ +[简体中文] | [English](Home) · [首页](首页) + +# OpenBitFun 使用指南 + +OpenBitFun 是开源的 Agent 工作空间，面向编程、调研、知识工作、内容创作和个人助理。它们共享工作空间，不需要先把每个需求严格划分为 Code 或 Cowork 模式。 + +## 从这里开始 + +1. [安装、配置模型并开始会话](快速开始)。 +2. [选择 Harness](Agent-模式)：Minimal、Standard、Ultimate 或 Creative。 +3. 检查智能体生成的文件、成果、来源和验证结果。 + +## 探索功能 + +- [产品全景](产品全景)：核心概念和能力地图。 +- [编程工作台](编程工作台)与[调研、办公与内容创作](Cowork-与创作)：常见工作流程。 +- [会话与持续目标](会话与持续目标)：历史、引导、分叉与持续工作。 +- [个人助手](个人助手)与[任务板与定时任务](任务板与定时任务)。 +- [Mini Apps 与 Pages](Mini-Apps-与-Pages)：创建工具、分享成果。 +- [远程与多设备](远程与多设备)、[Peer Device Mode](Peer-Device-Mode-中文)与[Detached Dispatch](远程任务派发)。 +- [语音与实时通话](语音与实时通话)、[自定义与扩展](自定义与扩展)、[安全与隐私](安全与隐私)。 + +## 版本与参考 + +本指南面向 OpenBitFun 1.0。文字于 2026-09-18 对照 v1.0.0 源码文档及开发版本 f72a28eb8 核验。连接服务、模型支持和不同表面的能力仍取决于安装版本与环境；源码核对不等于端到端实测。 + +旧 0.2.x 数据需要显式迁移，见[快速开始](快速开始)。可穿戴设备及更广泛的设备覆盖仍是发展方向，不代表每种设备都具有相同能力。 + +[下载](https://openbitfun.com/download) · [Playbook 说明书](https://playbook.openbitfun.com) · [GitHub](https://github.com/GCWing/OpenBitFun) + +> 待补截图：S01 — 当前桌面整体界面。见[截图清单](截图清单)。