README.md

DeepScientist Docs

DeepScientist is not just a long-running autonomous scientific discovery system. It is also a persistent research map that lives on your own machine.

2 minutes to install. 2 minutes to bind Weixin. 2 minutes to launch. Extremely fast and easy to use.

Local Web access now starts without a password gate by default. If you want a generated 16-character browser password for one launch, run ds --auth true; DeepScientist then prints the password in the terminal and the browser can reuse the stored login after the first successful entry.

It is also a workshop-style collaboration environment: let it keep moving autonomously, or step in anytime to collaborate, edit code, run the terminal yourself, or keep notes and plans in a Notion-style workspace.

Use DeepScientist anywhere: on the server through TUI, in the browser through Web, on the phone through Weixin or QQ, and even on glasses through Rokid Glasses.

News

• 2026/03/24: DeepScientist officially releases v1.5.
• 2026/02/01: the DeepScientist paper is available on OpenReview for ICLR 2026.

More From ResearAI

AI Scientist and AutoFigure projects worth exploring alongside DeepScientist:

Project	What it does
AutoFigure	generate paper-ready figures
AutoFigure-Edit	editable vector paper figures
DeepReviewer-v2	review papers and drafts
Awesome-AI-Scientist	curated AI scientist landscape

This page is the shortest path to the right document.

Built-in runners today:

• codex
• claude
• kimi
• opencode

If you are new

• 00 Quick Start Start here if you want to install DeepScientist, choose between Codex / Claude Code / Kimi Code / OpenCode, launch it locally, and create your first project.
• 20 Workspace Modes Guide Read this if you want to choose correctly between Copilot and Autonomous before creating a project.
• 31 Local Browser Auth Read this if you want to understand the local password prompt, where to find the password, and how to disable it.
• 32 Windows + WSL2 Deployment Guide Read this if you are on Windows and want the recommended WSL2-based deployment path instead of guessing the environment setup.
• 05 TUI Guide Read this if your main surface is the terminal and you want one end-to-end path through ds --tui, quests, connectors, and cross-surface work.
• 15 Codex Provider Setup Read this when you want to run DeepScientist through MiniMax, GLM, Volcengine Ark, Alibaba Bailian Coding Plan, or another Codex profile.
• 24 Claude Code Setup Read this when Claude Code already works on your machine and you want DeepScientist to reuse it directly.
• 27 Kimi Code Setup Read this when the official Kimi Code CLI already works on your machine and you want DeepScientist to use it as a separate builtin runner.
• 25 OpenCode Setup Read this when OpenCode already works on your machine and you want DeepScientist to reuse its provider/model configuration.
• 21 Local Model Backends Guide Read this if you want to run DeepScientist through local OpenAI-compatible backends such as vLLM, Ollama, or SGLang.
• 26 Citation And Attribution Read this if DeepScientist materially helped a paper or report and you want the preferred citation, acknowledgment wording, and attribution boundary.
• 12 Guided Workflow Tour Follow the real product flow from landing page to workspace, step by step.
• 02 Start Research Guide Read this next if you want to understand each field in the Start Research dialog and what it actually submits.

If you want to launch a project well

• 02 Start Research Guide Explains the current frontend fields, derived contract fields, and practical examples.
• 20 Workspace Modes Guide Use this when the main question is not “how do I fill the form?” but “should this project start as Copilot or Autonomous?”.
• 01 Settings Reference Use this when DeepScientist is already running and you want to configure runtime defaults, models, connectors, baselines, DeepXiv, extensions, or MCP from the visual Settings page before touching raw YAML.
• 30 Settings Control Center Guide Use this when the question is not configuration but runtime supervision: summary, hardware, diagnostics, errors, logs, quests, repairs, controllers, stats, or search.
• 11 License And Risk Notice Read this first if you care about the license boundary, server safety, fabricated outputs, connector leakage, and public exposure risk.
• 26 Citation And Attribution Use this when the question is not runtime risk but how to cite or acknowledge DeepScientist fairly in research outputs.

If you want to collaborate through external surfaces

• 16 Telegram Connector Guide Bind Telegram through the built-in polling runtime and continue quests from bot chats.
• 28 Discord Connector Guide Configure the built-in Discord gateway connector from the Settings page and keep the workflow visual-first.
• 29 Slack Connector Guide Configure the built-in Slack Socket Mode connector from the Settings page after launch.
• 17 WhatsApp Connector Guide Bind WhatsApp through the local-session runtime and continue quests from local chat sessions.
• 18 Feishu Connector Guide Bind Feishu through the built-in long-connection runtime and continue quests from bot chats.
• 10 Weixin Connector Guide Bind personal WeChat through DeepScientist's built-in QR login and iLink runtime.
• 03 QQ Connector Guide Use QQ as a practical collaboration surface for progress, commands, and milestone delivery.
• 04 Lingzhu Connector Guide Bind Lingzhu / Rokid Glasses to DeepScientist.

If you want to understand how the system works

• 13 Core Architecture Guide Read this first if you want a user-facing overview of launcher, daemon, quests, Canvas, memory, and connectors.
• 14 Prompt, Skills, and MCP Guide Read this when you want the real turn-time structure: prompt assembly order, stage skills, and built-in MCP tool families.
• 06 Runtime and Canvas Explains how the daemon, workspace, canvas, and connector views fit together.
• 07 Memory and MCP Explains memory, artifacts, and built-in MCP behavior.
• 19 External Controller Guide Shows how to build optional outer-orchestration guards on top of mailbox and quest_control without patching core runtime code.

If something is broken

• 09 Doctor Start here for diagnostics and common runtime problems.
• 30 Settings Control Center Guide Use this when you want the operator view of summary, hardware, diagnostics, errors, logs, quests, repairs, controllers, stats, and search.
• 15 Codex Provider Setup Check this if the problem is likely in your Codex profile, provider endpoint, API key, or model configuration.
• 24 Claude Code Setup Check this if the problem is likely in your Claude Code login, config directory, permission mode, or Anthropic-compatible gateway setup.
• 27 Kimi Code Setup Check this if the problem is likely in your Kimi Code login, ~/.kimi home, agent selection, or --yolo / thinking configuration.
• 25 OpenCode Setup Check this if the problem is likely in your OpenCode provider login, config file, model selection, agent, or variant setup.
• 21 Local Model Backends Guide Check this if the problem is specifically about local OpenAI-compatible backends and whether they support /v1/responses.
• 01 Settings Reference Check this if the problem is likely caused by config, credentials, or connector setup.

If you are developing DeepScientist

• 23 BenchStore GitHub Releases Spec Read this when you want to publish BenchStore benchmark source packages on GitHub Releases and make the frontend Download flow work for users.

• 90 Architecture High-level system contracts and repository structure.

• 91 Development Maintainer-facing workflow, implementation notes, and the concrete checklists for adding MCP tools, skills, and connectors.

Community

Welcome to join the WeChat group for discussion.