+
+
+
+ Your team. Your data. Your infrastructure.
+ Open-source, self-hostable tools for people and AI agents to work together.
+
+ Download RoleWeave · + Try the CLI · + 简体中文 +
-[](https://github.com/bytefolk/digital-employee/releases/latest) [](https://www.npmjs.com/package/@fullstack-ai-infra/digital-employee) [](https://github.com/bytefolk/digital-employee/actions/workflows/ci.yml) +ByteFolk helps you organize AI employees, keep useful knowledge, and collaborate +on documents. Start with a desktop app or a portable CLI package, then add the +services your team needs. -Package a role's instructions, approved knowledge, Schemas, and acceptance -fixtures as a portable digital employee. Validate it locally without a model -call, then run one-shot work through a configured, supported Agent Host. +## Start with your workflow -**Try it without credentials:** -[run an official release-pinned case](https://github.com/bytefolk/digital-employee-quickstart#try-a-case-safely). +### Use a desktop workspace → [RoleWeave](https://github.com/bytefolk/roleweave) -[Quickstart](https://github.com/bytefolk/digital-employee-quickstart) · [Latest release](https://github.com/bytefolk/digital-employee/releases/latest) · [CLI and current status](https://github.com/bytefolk/digital-employee#run) · [Roadmap](https://github.com/bytefolk/digital-employee/blob/main/docs/roadmap.md) +Create a project, organize digital employees, and work with them through +role-based conversations. Keep the organization, documents, and task history +in one local workspace. -> Digital Employee is under active development. The repositories distinguish -> public releases from source previews and planned capabilities; a green build -> or a merged change is not automatically a released feature. +**Desktop preview available.** [macOS Apple Silicon](https://github.com/bytefolk/roleweave/releases/download/v0.1.1/roleweave-0.1.1-arm64.dmg) · [Windows x64](https://github.com/bytefolk/roleweave/releases/download/v0.1.1/roleweave-0.1.1-x64.exe) · [Release notes](https://github.com/bytefolk/roleweave/releases/tag/v0.1.1) -## Explore the product stack +> The current v0.1.1 installers are for macOS Apple Silicon and Windows x64. +> They are not Apple Developer ID-signed/notarized or Windows Authenticode-signed; +> installation or first launch may show a security prompt. The default desktop +> host needs a locally installed Qoder CLI 1.1.x and working account access. -### [Digital Employee Quickstart](https://github.com/bytefolk/digital-employee-quickstart) — official examples +[Get started](https://github.com/bytefolk/roleweave#get-started) · [Latest release](https://github.com/bytefolk/roleweave/releases/latest) -**Release-pinned, credential-free starting point.** Try reusable employee -packages for team Q&A, onboarding, approval proposals, and product support. -Each case includes knowledge, Schemas, and offline acceptance fixtures. +### Build from the terminal → [Digital Employee](https://github.com/bytefolk/digital-employee) -[Try a case](https://github.com/bytefolk/digital-employee-quickstart#try-a-case-safely) · [Browse examples](https://github.com/bytefolk/digital-employee-quickstart#cases) +Turn instructions, approved knowledge, and acceptance fixtures into reusable +employee packages. Validate a package locally, then run it with a supported, +configured Agent Host. -### [Org Workbench](https://github.com/bytefolk/org-workbench) — local organization workspace +**Start without credentials:** [run an official example](https://github.com/bytefolk/digital-employee-quickstart#try-a-case-safely). +The quickstart pins a published CLI version and uses offline fixtures without +a model call. It checks the package contract; running real tasks requires a +configured AI host. -**Development preview; no tagged installer release yet.** An Electron desktop -workspace where the file tree is the org chart, with position-based local -conversations, auditable organization changes, and local reporting. +[CLI releases](https://github.com/bytefolk/digital-employee/releases/latest) · [Example library](https://github.com/bytefolk/digital-employee-quickstart#cases) -[Current status and source setup](https://github.com/bytefolk/org-workbench) · [API contract](https://github.com/bytefolk/org-workbench/blob/main/docs/api-contract-v0.md) +## Add the pieces you need -### [Memory](https://github.com/bytefolk/mem) — portable memory plane +Each project has its own setup guide and can be explored independently. -**Experimental; a public release is available.** Keep files, structured -memories, task checkpoints, and provenance under your control, with one core -available through API, MCP, CLI, and UI. +| Project | What it helps you do | Start here | +| --- | --- | --- | +| [mem](https://github.com/bytefolk/mem) | Keep files, memories, and task checkpoints with their sources. | [MCP binaries](https://github.com/bytefolk/mem/releases/latest) · [Service setup](https://github.com/bytefolk/mem/blob/main/docs/RUN_LOCAL.md) | +| [doc](https://github.com/bytefolk/doc) | Write, share, and collaborate on documents with people and agents. | [Run locally](https://github.com/bytefolk/doc/blob/main/docs/RUN_LOCAL.md) | +| [design-system](https://github.com/bytefolk/design-system) | Build consistent interfaces with shared tokens and components. | [Developer guide](https://github.com/bytefolk/design-system#develop-and-verify) | -[Quick start](https://github.com/bytefolk/mem#快速开始) · [Latest release](https://github.com/bytefolk/mem/releases/latest) · [Product direction](https://github.com/bytefolk/mem/blob/main/GOAL.md) +**Availability:** mem is experimental; its released MCP adapter needs a running +mem service. Its web/API setup is documented in the repository. doc and +design-system currently provide source setup guides and have no GitHub Releases. -### [Docs](https://github.com/bytefolk/doc) — collaborative document plane +[Ordane](https://github.com/bytefolk/ordane) hosts the source for a static marketing +site. For the available desktop application, use RoleWeave above. -**Experimental source preview; no tagged release yet.** Self-hosted documents -for people and AI agents, with rich-text editing, real-time collaboration, -sharing, version recovery, API access, and a CLI. +## For developers and AI assistants -[Run locally](https://github.com/bytefolk/doc/blob/main/docs/RUN_LOCAL.md) · [Capabilities](https://github.com/bytefolk/doc/blob/main/docs/CAPABILITIES.md) · [Product direction](https://github.com/bytefolk/doc/blob/main/GOAL.md) +Use the repository that owns the capability you need: -These projects can be explored independently. Cross-project integration is -described as available only when the owning repositories provide release and -verification evidence. +- **Role packages and execution:** [Digital Employee CLI and contracts](https://github.com/bytefolk/digital-employee). +- **Desktop workflows and local automation:** [RoleWeave API reference](https://github.com/bytefolk/roleweave/blob/main/docs/api-contract-v0.md). +- **Files, memory, and retrieval:** [mem setup and interfaces](https://github.com/bytefolk/mem). +- **Document editing and collaboration:** [doc capabilities](https://github.com/bytefolk/doc/blob/main/docs/CAPABILITIES.md). -## For builders +Check the installed version against its release notes before using an API or +claiming support. Source on `main` can be ahead of a published package. Keep +credentials in the configured service environment, outside prompts and +committed files. Local workspace storage does not mean offline model execution: +your configured AI host may send task content to its provider. -### [Design System](https://github.com/bytefolk/design-system) — shared UI foundation +## Build with us -An experimental set of design tokens, accessible components, and application -patterns for a consistent ByteFolk experience. It is available for source -integration; no stable npm release is promised yet. +- **Try it:** download RoleWeave or follow the CLI quickstart above. +- **Report a problem:** open an issue in the project you used, with reproduction + steps and redacted output. Never include tokens or private workspace data. +- **Contribute:** start with an issue, make a focused PR, and include reproducible + checks. Changes go through CI and independent review. +- **Report a vulnerability:** use the affected repository's **Security** tab, + not a public issue. -[Package guide](https://github.com/bytefolk/design-system#develop-and-verify) · [Design decisions](https://github.com/bytefolk/design-system/tree/main/docs/adr) - -## How we work - -- Start with a documented problem or outcome. -- Make changes through issues and pull requests, with passing checks and - independent review. -- Validate claims with reproducible evidence. -- Prefer small, reviewable changes and transparent decisions. -- Keep shipped capabilities, experimental work, and future direction clearly - separated. - -## Get involved - -- Start with the Digital Employee quickstart, or choose the product plane - closest to your goal and read its status and setup documentation. -- Use the repository's issue templates for bugs, proposals, documentation, - maintenance, and questions. -- Report vulnerabilities privately through the affected repository's - **Security** tab. - -Organization-wide policies: - -- [Contributing](https://github.com/bytefolk/.github/blob/main/CONTRIBUTING.md) -- [Governance](https://github.com/bytefolk/.github/blob/main/GOVERNANCE.md) -- [Security](https://github.com/bytefolk/.github/blob/main/SECURITY.md) -- [Support](https://github.com/bytefolk/.github/blob/main/SUPPORT.md) -- [Code of Conduct](https://github.com/bytefolk/.github/blob/main/CODE_OF_CONDUCT.md) - -A repository's local policy supplies project-specific instructions while -preserving the organization baseline. +[Contributing](https://github.com/bytefolk/.github/blob/main/CONTRIBUTING.md) · [Governance](https://github.com/bytefolk/.github/blob/main/GOVERNANCE.md) · [Security](https://github.com/bytefolk/.github/blob/main/SECURITY.md) · [Support](https://github.com/bytefolk/.github/blob/main/SUPPORT.md) · [Code of Conduct](https://github.com/bytefolk/.github/blob/main/CODE_OF_CONDUCT.md) diff --git a/profile/README.zh-CN.md b/profile/README.zh-CN.md new file mode 100644 index 0000000..ec6f062 --- /dev/null +++ b/profile/README.zh-CN.md @@ -0,0 +1,86 @@ +
+
+
+ 你的团队，你的数据，你的基础设施。
+ 让人与 AI Agent 一起工作的开源、自托管工具。
+
+ 下载 RoleWeave · + 体验 CLI · + English +
+ +ByteFolk 帮助你组织 AI 员工、积累有用的知识并协作文档。 +从桌面应用或可移植的 CLI 员工包开始，再按需接入团队需要的服务。 + +## 从你要做的事开始 + +### 想直接使用桌面工作台 → [RoleWeave](https://github.com/bytefolk/roleweave) + +创建项目、组织数字员工，按岗位发起对话。在本地工作区里管理组织、文档和任务历史。 + +**桌面预览版已发布。** [macOS Apple Silicon](https://github.com/bytefolk/roleweave/releases/download/v0.1.1/roleweave-0.1.1-arm64.dmg) · [Windows x64](https://github.com/bytefolk/roleweave/releases/download/v0.1.1/roleweave-0.1.1-x64.exe) · [版本说明](https://github.com/bytefolk/roleweave/releases/tag/v0.1.1) + +> 当前 v0.1.1 安装包面向 macOS Apple Silicon 和 Windows x64。安装包尚无 +> Apple Developer ID 签名/公证或 Windows Authenticode 签名，安装或首次启动 +> 可能出现安全提示。默认桌面 Host 需要本机安装 Qoder CLI 1.1.x，并具备可用的账号权限。 + +[开始使用](https://github.com/bytefolk/roleweave#get-started) · [最新版本](https://github.com/bytefolk/roleweave/releases/latest) + +### 想从命令行构建员工 → [Digital Employee](https://github.com/bytefolk/digital-employee) + +把岗位指令、已审核的知识和验收用例封装成可复用的员工包。 +先在本地校验，再交给已配置、受支持的 Agent Host 执行。 + +**无需凭据即可开始：** [运行官方示例](https://github.com/bytefolk/digital-employee-quickstart/blob/main/README.zh-CN.md)。 +快速开始固定使用已发布的 CLI 版本，通过离线用例检查包契约，不调用模型。 +运行真实任务需要配置 AI Host。 + +[CLI 版本](https://github.com/bytefolk/digital-employee/releases/latest) · [示例库](https://github.com/bytefolk/digital-employee-quickstart#cases) + +## 按需选择组件 + +各项目均有独立的配置指引，可以单独探索。 + +| 项目 | 帮你做什么 | 从这里开始 | +| --- | --- | --- | +| [mem](https://github.com/bytefolk/mem) | 保存文件、记忆和任务检查点，并保留来源。 | [MCP 下载](https://github.com/bytefolk/mem/releases/latest) · [服务部署](https://github.com/bytefolk/mem/blob/main/docs/RUN_LOCAL.md) | +| [doc](https://github.com/bytefolk/doc) | 让人和 Agent 编写、分享、协作文档。 | [本地启动](https://github.com/bytefolk/doc/blob/main/docs/RUN_LOCAL.md) | +| [design-system](https://github.com/bytefolk/design-system) | 用共享设计变量和组件构建一致的界面。 | [开发指引](https://github.com/bytefolk/design-system#develop-and-verify) | + +**可用范围：** mem 仍为实验性项目，已发布的 MCP 适配器需要连接运行中的 mem 服务， +Web/API 部署方法见仓库文档。doc 与 design-system 目前提供源码启动指引， +尚无 GitHub Release。 + +[Ordane](https://github.com/bytefolk/ordane) 仓库提供静态宣传站源码。 +使用已发布的桌面应用，请从上面的 RoleWeave 入口开始。 + +## 面向开发者和 AI 助手 + +按能力找到负责它的仓库： + +- **员工包与执行：** [Digital Employee CLI 与契约](https://github.com/bytefolk/digital-employee)。 +- **桌面工作流与本地自动化：** [RoleWeave API 参考](https://github.com/bytefolk/roleweave/blob/main/docs/api-contract-v0.md)。 +- **文件、记忆与检索：** [mem 配置与接口](https://github.com/bytefolk/mem)。 +- **文档编辑与协作：** [doc 能力说明](https://github.com/bytefolk/doc/blob/main/docs/CAPABILITIES.md)。 + +使用 API 或描述能力前，先核对已安装版本与其发布说明。`main` 中的源码可能领先于 +已发布的包。凭据放在对应服务的配置环境中，不写入提示词或提交到仓库。 +本地存储工作区不代表模型离线执行：已配置的 AI Host 可能将任务内容发送给模型服务商。 + +## 一起改进 + +- **体验产品：** 下载 RoleWeave，或运行上面的 CLI 示例。 +- **反馈问题：** 到所用项目的 Issues 提供复现步骤和脱敏输出，不上传 token 或私有工作区数据。 +- **参与开发：** 从 Issue 开始，提交小而清晰的 PR 和可复现检查，经过 CI 与独立评审。 +- **报告漏洞：** 使用对应仓库的 **Security** 私密报告入口，不提交到公开 Issue。 + +[贡献指南](https://github.com/bytefolk/.github/blob/main/CONTRIBUTING.md) · [治理规则](https://github.com/bytefolk/.github/blob/main/GOVERNANCE.md) · [安全](https://github.com/bytefolk/.github/blob/main/SECURITY.md) · [支持](https://github.com/bytefolk/.github/blob/main/SUPPORT.md) · [行为准则](https://github.com/bytefolk/.github/blob/main/CODE_OF_CONDUCT.md)