From 622a344520521252c5312a6edd846f51e0cf575c Mon Sep 17 00:00:00 2001 From: Costa Tin <12409467+C0staTin@users.noreply.github.com> Date: Fri, 26 Jun 2026 15:50:12 -0600 Subject: [PATCH] Refresh the README for MindsHub Cowork MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Updates the `minds` README to match the current product and MindsHub branding, and fixes stale links. ### Changes - **Rebrand to MindsHub Cowork** — new intro, "Get started", "What's inside" (connected data, Model Router, open agents, artifacts) using site copy; voice per the press kit. - **Download links → the website's**: `downloads.mindsdb.com/mindshub-cowork/...` for macOS `.pkg` / Windows `.exe` (was the stale `…/anton/…` paths). - **Added the web app / login** → `console.mindshub.ai` as the no-install path. - **Fixed stale self-references**: clone URL `minds-platform` → `minds`; issues & security now point at `mindsdb/minds` (were `mindsdb/mindsdb`). - **Community → Discord** (`mindshub.ai/discord`); removed the Slack links and the contributors image. - **Swapped stale badges** (PyPI / Docker for the old engine) → release, stars, license, Python. - **UTMs** on `mindshub.ai` links (`utm_medium=repo-readme&utm_campaign=minds-readme`); download binaries and Discord left bare. - Kept the hero screenshot and the build-from-source / submodule `make` tables. --- README.md | 166 +++++++++++++++++++++--------------------------------- 1 file changed, 63 insertions(+), 103 deletions(-) diff --git a/README.md b/README.md index 901e273858c..0451a2c7841 100644 --- a/README.md +++ b/README.md @@ -1,67 +1,71 @@ +
+# MindsHub Cowork -
- - MindsDB Release - - - Python supported - - - Docker pulls - -
-

- Documentation - · - Try it - · - Contact us for a demo - -

-
+**The unified workspace where open-source agents get work done for you.** + +_Delegate anything. It comes back done._ +[![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) +[![Python 3.10–3.13](https://img.shields.io/badge/python-3.10%20–%203.13-brightgreen.svg)](https://www.python.org/downloads/) -image +[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) · +[Discord](https://mindshub.ai/discord) +
-# MINDS-COWORK PLATFORM +

+ MindsHub Cowork — the unified workspace +

-Minds Platform is dedicated to building a general-purpose AI designed for knowledge workers — creators, strategists, and operators — and individuals seeking AI systems they can truly control to help them get work done, with full flexibility to extend and deploy anywhere (VPC, on-prem, or cloud). +**MindsHub Cowork** is the unified workspace where you delegate entire tasks — research, analysis, reporting, scheduled operations — and collect finished, shareable results. Connect your data, route each step to the right model, run open-source agents, and turn their output into artifacts you can publish. It's open source and runs anywhere — your machine, your VPC, or the hosted app. +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. +## Get started -## USE CASES +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`). +- **Run it open source.** [Build from source](#build-from-source) — see below. -**For every knowledge worker** -- **Automate** any repetitive multi-step task that involves reading and writing (reports, monitoring, workflows) -- **Build** internal AI tools/artifacts without engineering and deploy to your team (apps, decks, docs, analyses) +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). ---- +## What you can do -## GET STARTED +For every knowledge worker — creators, strategists, and operators: -### Desktop App: -Simplest way to use this is the latest build App, available on web or desktop: +- **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. -- **web**: Click [here to register/login](https://mindshub.ai) the Minds-cowork app, packaged and ready for you in one click. +## What's inside -- **macOS**: Click [here to download](https://downloads.mindsdb.com/anton/mac/anton-latest.pkg) the Minds-cowork for MacOS. +- **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. -- **Windows**: Click [here to download](https://downloads.mindsdb.com/anton/windows/anton-latest.exe) the Minds-cowork for Windows. - +## Build from source -### Build from source: **1. Clone the repository** + ```bash -git clone --recurse-submodules https://github.com/mindsdb/minds-platform.git -cd minds-platform +git clone --recurse-submodules https://github.com/mindsdb/minds.git +cd minds ``` **2. Install dependencies** + ```bash make setup ``` @@ -78,13 +82,14 @@ make setup | Build macOS `.app` from local uncommitted source | `make pack-local` | | Wipe all local installs + data (fresh start) | `make flush` | -> **Reset to a clean slate:** `make flush` uninstalls 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. ⚠️ This deletes your conversations and saved keys. It prompts for confirmation; pass `FORCE=1` to skip it. The next `make setup` or app launch reinstalls everything. +> **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. ### 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: **1. Pick your branches** in a gitignored `dev.env` (copy the template): + ```bash cp dev.env.example dev.env # then set REF=feat/my-thing (or per-module API_REF=…) ``` @@ -105,79 +110,34 @@ cp dev.env.example dev.env # then set REF=feat/my-thing (or per-module API_ 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. ---- +## Deploy anywhere -## 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. -Minds Platform is designed for flexible deployment across: +## Help & support -- Cloud -- VPC -- On-Prem -- Air-Gapped Environments -- Hybrid Infrastructure +- **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). -Maintain full control over your infrastructure, models, permissions, and data. +## 🤝 Contribute -## 🫴 Help and support +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). -Stuck on a query? Found a bug? We’re here to help. - - - - - - - - - - - - - -
- Ask a question - - Join our Slack Community. -
- Report a bug - - Open a GitHub Issue. Please include reproduction steps! -
- Get commercial support - - Contact the MindsDB Team for enterprise SLAs and custom solutions. -
+## 🔒 Security -**Security Note:** If you find a security vulnerability, please do not open a public issue. Refer to our security policy for reporting instructions. +Found a security vulnerability? Please **don't** open a public issue. Report it privately through our [security policy](https://github.com/mindsdb/minds/security). -## 🤝 Contribute to Minds Platform - -Minds Platform is open source and contributions are welcome! You can submit code changes through pull requests or by opening issues to report bugs, suggest new features, or enhancements. - - -**How to contribute** - -- Read the contribution guide to get set up. -- Browse open issues. -- Join the #contributors channel in Slack. -- Explore community rewards and programs. +## 📚 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) -Our top 100 contributors +## 📄 License - - - - -Made with [contrib.rocks](https://contrib.rocks) -
+This repository is released under the [MIT License](LICENSE). Bundled components are governed by their own licenses — see each submodule's repository for details. -## 📚 Resources -- Documentation -- Blog -- Events -- Community Slack -- Brand guidelines -- Contact form +

(back to top)