MindOS is a free, open source documentation & knowledge base project written in TypeScript and released under MIT. It has 676 GitHub stars, 58 forks and 2 open issues, and was last pushed 5 days ago. On this registry it ranks #78 of 91 tracked projects in Documentation & Knowledge Base, with 5 head-to-head comparisons available.

MindOS

Human Thinks Here, Agents Act There.

English | 中文

Website npm version WeChat MIT License

Desktop App Web Clipper

MindOS is a local-first knowledge base for sharing durable context between you and the AI agents you use. Think in one place. Let agents work from shared context.


</td>
</td>
Home — Knowledge base overview AI Agent — Proactively understand intent and execute tasks from your knowledge
</td>
</td>
Agents — Manage all connected AI agents Echo — Reflect and distill cognitive growth

[!IMPORTANT] ⭐ Agent-assisted install: Send this to your Agent (Claude Code, Cursor, etc.) to set up MindOS, MCP, and Skills:

Help me install MindOS from https://github.com/GeminiLight/MindOS with MCP and Skills. Use English template.

✨ Try it now: After installation, give these a try:

Here's my resume, read it and organize my info into MindOS.
Help me distill the experience from this conversation into MindOS as a reusable SOP.
Help me execute the XXX SOP from MindOS.

📢 What's New

MindOS is now organized around a few stable product modules instead of one-off setup scripts:

Module What is live
Local Knowledge Workbench A desktop/web/CLI workspace for browsing, editing, importing, searching, and organizing a local Markdown knowledge base.
MCP + Skills Bridge One command installs or repairs both MCP config and the packaged MindOS Skill, then mindos doctor agents verifies real agent readiness.
Native Agent Runtime Run agents with resumable sessions, cancellation, reconnect/reattach support, and reviewable output history where the runtime exposes it.
Workflow & Audit Surfaces YAML workflows, Agent Inspector, run ledgers, backlinks, graph views, and importer progress help keep human review in the loop.
Cross-platform Delivery Install through Desktop releases or npm install -g @geminilight/mindos@latest; the npm package includes the CLI and prebuilt local Web runtime.

🧠 Human-AI Shared Mind

You shape AI through thinking, AI empowers you through execution. Human and AI, growing together in one shared brain.

1. Global Sync — Breaking Memory Silos

Switch tools or start a new chat and you're re-transporting context, scattering knowledge. With a built-in MCP server and packaged Skills, MindOS gives supported Agents a shared path into your core knowledge base. Record profile and project memory once, then reuse it across your AI tools.

2. Transparent & Controllable — No Black Boxes

Agent memory locked in black boxes makes reasoning hard to audit and correct. MindOS keeps your knowledge base as local plain text and exposes review surfaces for agent runs, file changes, and important tool activity, so you can inspect and adjust the context agents rely on.

3. Symbiotic Evolution — Experience Flows Back As Instructions

You express preferences but the next chat often starts from zero, leaving useful judgment behind. MindOS helps turn reviewed conversations, corrections, and project standards into reusable notes, Skills, and SOPs, so future agent work can start from a better baseline.

Foundation: Local-first by default — your knowledge base stays in local plain text for privacy, ownership, and speed.


🚀 Getting Started

[!IMPORTANT] Quick Start with Agent: Paste this prompt into any MCP-capable Agent (Claude Code, Cursor, etc.) to install MindOS, MCP, and Skills, then skip to Step 3:

Help me install MindOS from https://github.com/GeminiLight/MindOS with MCP and Skills. Use English template.

Already have a knowledge base? Skip to Step 4 to configure MCP + Skills.

1. Install

Option A: Desktop App (macOS / Windows / Linux)

Download from the official website or GitHub Releases — double-click to install, no terminal needed.

Option B: npm

npm install -g @geminilight/mindos@latest

Option C: Clone from source

git clone https://github.com/GeminiLight/MindOS
cd MindOS
pnpm install
pnpm --filter @geminilight/mindos build
cd packages/mindos
pnpm link --global   # registers the `mindos` command globally

The npm package intentionally installs both the CLI and the prebuilt local Web runtime. mindos is the command entrypoint, while _standalone/ provides the browser UI used by mindos start / mindos open; Web source (packages/web), tests, wiki, legacy source roots, and dev caches are excluded from the tarball.

2. Interactive Setup

mindos onboard

The setup wizard guides you through knowledge base path, template, ports, auth, AI provider, and start mode — all with sensible defaults. Config is saved to ~/.mindos/config.json. See docs/en/configuration.md for all fields.

[!TIP] On macOS/Linux, choose "Background service" during onboard for auto-start on boot. On Windows CLI installs, use foreground mode; Windows auto-start is handled by the Desktop app. Run mindos update anytime to upgrade.

Open the Web UI in your browser:

mindos open

3. Inject Your Personal Mind with MindOS Agent

  1. Open the built-in MindOS Agent chat panel in the GUI.
  2. Upload your resume or any personal/project material.
  3. Send this prompt: Help me sync this information into my MindOS knowledge base.

4. Make Any Agent Ready (MCP + Skills)

MCP + Skills (connection + workflow) — one command to install or repair both:

mindos mcp install        # interactive
mindos mcp install -g -y  # one-shot, global scope

Verify the actual agent-facing state:

mindos doctor agents
mindos doctor agents codex --json

For remote access, manual JSON config, and common pitfalls, see docs/en/supported-agents.md.

5. Capture from Anywhere

MindOS knowledge doesn't have to start from scratch — bring in

readme truncated — read the full docs on github

Frequently asked questions

Is MindOS free to use?

MindOS is open source under the MIT licence. There is no licence fee and no seat count — you can self-host it or, where the project offers one, pay a vendor for a managed version instead.

What does MindOS do?

MindOS is a Human-AI Collaborative Mind System, where human thinks and agents act. Globally sync your mind for all agents: transparent, controllable, and evolvi

What is MindOS written in?

MindOS is primarily written in TypeScript. Its source is publicly available at https://github.com/GeminiLight/MindOS, and it has 676 GitHub stars.