diff --git a/README.md b/README.md index 28e0251..7323059 100644 --- a/README.md +++ b/README.md @@ -1,150 +1,153 @@ + +> [!NOTE] +> 本文档由 WeHub 基于上游 README 翻译整理，属于社区翻译，非官方中文文档。 +> [English](./README.en.md) · [原始项目](https://github.com/mindsdb/mindsdb) · [上游 README](https://github.com/mindsdb/mindsdb/blob/HEAD/README.md) +> 原作者、版权与许可证归属以原始项目及本仓库 LICENSE 文件为准。 +
-# MindsHub +# MindsHub -**The unified workspace where open-source models get things done for you.** +**开源模型为你完成任务的统一工作空间。** -_Make AI do actual work. Swap the model anytime — keep everything you've built._ +_让 AI 真正干活。随时切换模型——你搭建的一切都保留下来。_ [![Release](https://img.shields.io/github/v/release/mindsdb/minds?logo=github&label=release)](https://github.com/mindsdb/minds/releases) [![Stars](https://img.shields.io/github/stars/mindsdb/minds?logo=github)](https://github.com/mindsdb/minds/stargazers) -[![License: MIT](https://img.shields.io/github/license/mindsdb/minds)](#-license) +[![License: MIT](https://img.shields.io/github/license/mindsdb/minds)](#-许可证) [![Python 3.10–3.13](https://img.shields.io/badge/python-3.10%20–%203.13-brightgreen.svg)](https://www.python.org/downloads/) -[Website](https://mindshub.ai/?utm_source=github&utm_medium=repo-readme&utm_campaign=minds-readme) · -[Docs](https://docs.mindshub.ai/?utm_source=github&utm_medium=repo-readme&utm_campaign=minds-readme) · -[Web app](https://console.mindshub.ai/?utm_source=github&utm_medium=repo-readme&utm_campaign=minds-readme) · -[Pricing](https://mindshub.ai/pricing?utm_source=github&utm_medium=repo-readme&utm_campaign=minds-readme) · +[官网](https://mindshub.ai/?utm_source=github&utm_medium=repo-readme&utm_campaign=minds-readme) · +[文档](https://docs.mindshub.ai/?utm_source=github&utm_medium=repo-readme&utm_campaign=minds-readme) · +[网页应用](https://console.mindshub.ai/?utm_source=github&utm_medium=repo-readme&utm_campaign=minds-readme) · +[定价](https://mindshub.ai/pricing?utm_source=github&utm_medium=repo-readme&utm_campaign=minds-readme) · [Discord](https://mindshub.ai/discord)

- Read this in: 中文 · Español · Português · हिन्दी + 其他语言: English · Español · Português · हिन्दी

cowork - - -

-**MindsHub Cowork** is the unified workspace where you delegate entire projects — apps, websites, research, analysis, reporting, scheduled operations — and collect finished, shareable results. Connect your data, route work to any model (open or proprietary), run open-source agents, and turn their output into web applications you can publish. It's open source and runs anywhere — your machine, your VPC, or the hosted app. +**MindsHub Cowork** 是一个统一工作空间,你可以在这里委托完整的项目——应用、网站、调研、分析、报告、定时运维——并获得可直接分享的成品结果。连接你的数据,将工作路由到任意模型(开源或商用),运行开源智能体,并将其产出转化为可发布的网页应用。它是开源的,可以运行在任何地方——你的电脑、你的 VPC,或托管应用中。 -This repository is the **platform superproject**: it pulls together the desktop/web app, the agent backend, and the data engine so you can build and run the whole stack from source. +本仓库是**平台超级项目(superproject)**:它整合了桌面/网页应用、智能体后端和数据引擎,让你可以从源码构建并运行整套技术栈。 -## Get started +## 快速开始 -Pick whichever fits: +选择最适合你的方式: -- **Web — nothing to install.** Open **[console.mindshub.ai](https://console.mindshub.ai/?utm_source=github&utm_medium=repo-readme&utm_campaign=minds-readme)** and sign in. -- **macOS.** [Download the desktop app](https://downloads.mindsdb.com/mindshub-cowork/mac/mindshub-cowork-latest.pkg) (`.pkg`). -- **Windows.** [Download the desktop app](https://downloads.mindsdb.com/mindshub-cowork/windows/mindshub-cowork-latest.exe) (`.exe`). -- **Linux.** [Build from source](#build-from-source). +- **网页版 —— 无需安装。** 打开 **[console.mindshub.ai](https://console.mindshub.ai/?utm_source=github&utm_medium=repo-readme&utm_campaign=minds-readme)** 并登录。 +- **macOS。** [下载桌面应用](https://downloads.mindsdb.com/mindshub-cowork/mac/mindshub-cowork-latest.pkg)(`.pkg`)。 +- **Windows。** [下载桌面应用](https://downloads.mindsdb.com/mindshub-cowork/windows/mindshub-cowork-latest.exe)(`.exe`)。 +- **Linux。** [从源码构建](#从源码构建)。 -Free to start. Pro adds all frontier models and private artifacts — see [pricing](https://mindshub.ai/pricing?utm_source=github&utm_medium=repo-readme&utm_campaign=minds-readme). +免费即可开始使用。Pro 版本解锁全部前沿模型与私有成果物——详见[定价](https://mindshub.ai/pricing?utm_source=github&utm_medium=repo-readme&utm_campaign=minds-readme)。 -## What you can do +## 你能做什么 -For every knowledge worker — creators, strategists, and operators: +面向每一位知识工作者——创作者、策略制定者与运营者: -- **Automate** repetitive, multi-step work that involves reading and writing: reports, monitoring, recurring workflows, and scheduled operations. -- **Build** internal AI tools and artifacts — apps, dashboards, decks, docs, analyses — without engineering, and publish them to a live URL to share with your team. +- **自动化**涉及读写的重复性多步骤工作:报告、监控、周期性工作流以及定时运维任务。 +- **构建**内部 AI 工具与成果物——应用、仪表盘、演示文稿、文档、分析报告——无需工程开发,并发布到可分享给团队的在线链接。 -## What's inside +## 内含功能 -- **Connected data.** A secure vault links systems like BigQuery, Postgres, Gmail, Drive, HubSpot, Notion, and Linear. Credentials stay scoped per connection — agents never see raw keys. -- **Model Router.** Switch between frontier models (Claude, GPT, Gemini) and open models (DeepSeek, Qwen, Kimi) without wiring up a key for each provider. -- **Open agents.** Run interchangeable open-source harnesses — Anton (default) and Hermes — swappable from a dropdown. -- **Artifacts.** Turn agent output into documents, dashboards, apps, and code, and publish to a live URL. -- **Memory, skills & scheduling.** Cross-session memory, a reusable skill library, and tasks that run on a schedule. +- **数据连接。** 安全的密钥库(vault)可连接 BigQuery、Postgres、Gmail、Drive、HubSpot、Notion、Linear 等系统。凭证按连接单独限定范围——智能体永远看不到原始密钥。 +- **模型路由(Model Router)。** 在前沿模型(Claude、GPT、Gemini)与开源模型(DeepSeek、Qwen、Kimi)之间自由切换,无需为每个提供方单独配置密钥。 +- **开源智能体。** 运行可互换的开源执行引擎(harness)——Anton(默认)与 Hermes——通过下拉菜单即可切换。 +- **成果物(Artifacts)。** 将智能体的产出转化为文档、仪表盘、应用与代码,并发布到在线链接。 +- **记忆、技能与定时任务。** 跨会话记忆、可复用的技能库,以及按计划运行的任务。 -## Build from source +## 从源码构建 -**1. Clone the repository** +**1. 克隆仓库** ```bash git clone --recurse-submodules https://github.com/mindsdb/minds.git cd minds ``` -**2. Install dependencies** +**2. 安装依赖** ```bash make setup ``` -**3. Run** +**3. 运行** -| Mode | Command | +| 模式 | 命令 | |---|---| -| Desktop app (Electron) with hot reload | `make dev` or `make watch` | -| Web app in browser with hot reload | `make dev-web` | -| Production build | `make build` | -| Package for macOS | `make dist-mac` | -| Package for Windows | `make dist-win` | -| Build macOS `.app` from local uncommitted source | `make pack-local` | -| Wipe all local installs + data (fresh start) | `make flush` | +| 桌面应用(Electron),支持热重载 | `make dev` 或 `make watch` | +| 浏览器网页应用,支持热重载 | `make dev-web` | +| 生产构建 | `make build` | +| 打包 macOS 版本 | `make dist-mac` | +| 打包 Windows 版本 | `make dist-win` | +| 从本地未提交的源码构建 macOS `.app` | `make pack-local` | +| 清除所有本地安装与数据(从零开始) | `make flush` | -> **Fresh start:** `make flush` removes the local runtime (the `cowork-server` uv tool and the `backend/*/.venv`s) and deletes app state in `~/.anton` (provider keys) and `~/.cowork` (database, hermes, projects). Use it to test the from-scratch install flow or recover from a broken install. It prompts for confirmation — pass `FORCE=1` to skip. The next `make setup` or app launch reinstalls everything. ⚠️ This deletes your conversations and saved keys. +> **从零开始:** `make flush` 会移除本地运行环境(`cowork-server` uv 工具及 `backend/*/.venv`),并删除 `~/.anton`(提供方密钥)与 `~/.cowork`(数据库、hermes、项目)中的应用状态。用它来测试从零安装流程,或从损坏的安装中恢复。执行前会要求确认——传入 `FORCE=1` 可跳过确认。之后运行 `make setup` 或启动应用即可重新安装全部内容。⚠️ 此操作会删除你的对话记录和已保存的密钥。 -### Working on feature branches (submodules) +### 在功能分支上开发(子模块) -This repo is a superproject that pins each module (`frontend`, `backend/core_api`, `backend/core_agent`, `backend/data-vault`) to a commit. To work on module branches without polluting `git status` or fighting over pins: +本仓库是一个超级项目,将每个模块(`frontend`、`backend/core_api`、`backend/core_agent`、`backend/data-vault`)固定(pin)到某个提交。要在模块分支上开发而不污染 `git status` 或与固定版本产生冲突: -**1. Pick your branches** in a gitignored `dev.env` (copy the template): +**1. 在(已加入 `.gitignore` 的)`dev.env` 中选择你的分支**(从模板复制): ```bash -cp dev.env.example dev.env # then set REF=feat/my-thing (or per-module API_REF=…) +cp dev.env.example dev.env # 然后设置 REF=feat/my-thing(或按模块设置 API_REF=…) ``` -**2. `make` follows it** — one knob, both run paths: +**2. `make` 会自动读取该配置** —— 一个开关,适用于两种运行方式: -| Command | What it does | +| 命令 | 作用 | |---|---| -| `make use` | check out your `dev.env` refs across all submodules | -| `make dev` / `make watch` | run the Electron app with live reload against local source | -| `make dev-web` | run the web SPA with live reload against local source | -| `make server` + `make app` | (re)install the desktop server from the configured branch, then launch | -| `make server-local` + `make app-local` | install the desktop server from **local uncommitted source**, then launch | -| `make pack-local` | build the macOS `.app` from local uncommitted source (no push needed) | -| `make refs` | show which refs the next run will use | -| `make baseline` | reset submodules to the pinned commits | -| `make pin` | record the current submodule commits as the superproject's pins (one deliberate commit) | +| `make use` | 按 `dev.env` 中的配置检出所有子模块的分支 | +| `make dev` / `make watch` | 以本地源码热重载方式运行 Electron 应用 | +| `make dev-web` | 以本地源码热重载方式运行网页版 SPA | +| `make server` + `make app` | 从配置的分支(重新)安装桌面服务端,然后启动 | +| `make server-local` + `make app-local` | 从**本地未提交的源码**安装桌面服务端,然后启动 | +| `make pack-local` | 从本地未提交的源码构建 macOS `.app`(无需推送) | +| `make refs` | 显示下一次运行将使用的分支引用 | +| `make baseline` | 将子模块重置为固定的提交版本 | +| `make pin` | 将当前子模块提交记录为超级项目的固定版本(一次明确的提交) | -Submodules are configured with `ignore = all`, so your branch work never shows up as superproject changes — the parent `git status` stays clean. Pins move **only** via `make pin`. See [`CLAUDE.md`](CLAUDE.md) for the full workflow. +子模块配置了 `ignore = all`,因此你在分支上的工作永远不会显示为超级项目的更改——父仓库的 `git status` 始终保持干净。固定版本**只能**通过 `make pin` 变更。完整流程见 [`CLAUDE.md`](CLAUDE.md)。 -## Deploy anywhere +## 随处部署 -Cowork is built for flexible deployment — **cloud, VPC, on-prem, air-gapped, and hybrid** infrastructure — so you keep full control over your infrastructure, models, permissions, and data. +Cowork 的设计支持灵活部署——**云端、VPC、本地部署、离线隔离环境以及混合基础设施**——让你完全掌控自己的基础设施、模型、权限与数据。 -## Help & support +## 帮助与支持 -- **Ask a question** — join the [Discord community](https://mindshub.ai/discord). -- **Report a bug** — open a [GitHub issue](https://github.com/mindsdb/minds/issues) with reproduction steps. -- **Read the docs** — guides, setup, and the API at [docs.mindshub.ai](https://docs.mindshub.ai/?utm_source=github&utm_medium=repo-readme&utm_campaign=minds-readme). -- **Enterprise SLAs or custom deployments** — [contact the team](https://mindshub.ai/contact?utm_source=github&utm_medium=repo-readme&utm_campaign=minds-readme). +- **提出问题** —— 加入 [Discord 社区](https://mindshub.ai/discord)。 +- **报告 Bug** —— 提交 [GitHub issue](https://github.com/mindsdb/minds/issues),并附上复现步骤。 +- **查阅文档** —— 使用指南、部署说明与 API,见 [docs.mindshub.ai](https://docs.mindshub.ai/?utm_source=github&utm_medium=repo-readme&utm_campaign=minds-readme)。 +- **企业级 SLA 或定制化部署** —— [联系我们](https://mindshub.ai/contact?utm_source=github&utm_medium=repo-readme&utm_campaign=minds-readme)。 -## 🤝 Contribute +## 🤝 参与贡献 -Cowork is open source and contributions are welcome — code, integrations, docs, bug reports, and feature ideas. Read the [docs](https://docs.mindshub.ai/?utm_source=github&utm_medium=repo-readme&utm_campaign=minds-readme) to get set up, browse [open issues](https://github.com/mindsdb/minds/issues), and say hi on [Discord](https://mindshub.ai/discord). +Cowork 是开源项目,欢迎任何形式的贡献——代码、集成、文档、Bug 报告与功能建议。阅读[文档](https://docs.mindshub.ai/?utm_source=github&utm_medium=repo-readme&utm_campaign=minds-readme)完成环境搭建,浏览[已有 issue](https://github.com/mindsdb/minds/issues),也欢迎到 [Discord](https://mindshub.ai/discord) 打个招呼。 -## 🔒 Security +## 🔒 安全 -Found a security vulnerability? Please **don't** open a public issue. Report it privately through our [security policy](https://github.com/mindsdb/minds/security). +发现安全漏洞?请**不要**创建公开 issue。请通过我们的[安全策略](https://github.com/mindsdb/minds/security)私下提交报告。 -## 📚 Resources +## 📚 资源 -- [Documentation](https://docs.mindshub.ai/?utm_source=github&utm_medium=repo-readme&utm_campaign=minds-readme) -- [Blog](https://mindshub.ai/blog?utm_source=github&utm_medium=repo-readme&utm_campaign=minds-readme) -- [Brand guidelines & press kit](https://mindshub.ai/press-kit?utm_source=github&utm_medium=repo-readme&utm_campaign=minds-readme) -- [Discord community](https://mindshub.ai/discord) +- [文档](https://docs.mindshub.ai/?utm_source=github&utm_medium=repo-readme&utm_campaign=minds-readme) +- [博客](https://mindshub.ai/blog?utm_source=github&utm_medium=repo-readme&utm_campaign=minds-readme) +- [品牌指南与媒体资料包](https://mindshub.ai/press-kit?utm_source=github&utm_medium=repo-readme&utm_campaign=minds-readme) +- [Discord 社区](https://mindshub.ai/discord) -## 📄 License +## 📄 许可证 -This repository is released under the [MIT License](LICENSE). Bundled components are governed by their own licenses — see each submodule's repository for details. +本仓库基于 [MIT 许可证](LICENSE) 发布。所捆绑的组件遵循各自的许可证——详情请参阅各子模块仓库。 -

(back to top)

+

(返回顶部)