@researai/deepscientist 1.5.14 → 1.5.16

package/README.md

@@ -1,140 +1,341 @@
 <h1 align="center">
-  <img src="assets/branding/logo.svg" alt="DeepScientist logo" width="84" />
+  <img src="assets/branding/logo.svg" alt="DeepScientist logo" width="92" />
   DeepScientist
 </h1>
 
-<p>
-  <strong>DeepScientist is not just a long-running autonomous scientific discovery system. It is also a persistent research map that lives on your own machine.</strong>
-</p>
 
-<p>
-  Local-first. Open-source. Git-backed. Built for verifiable computational research.
+<p align="center">
+  DeepScientist is a local-first AI research studio, Bring your own AI scientist onto your machine in 15 minutes.
 </p>
 
+
+
 <p align="center">
-  <a href="docs/en/README.md">English</a> | <a href="docs/zh/README.md">中文</a>
+  <a href="https://github.com/ResearAI/DeepScientist">GitHub</a> |
+  <a href="README_ZH.md">中文文档</a> |
+  <a href="docs/en/README.md">English Docs</a> |
+  <a href="https://openreview.net/forum?id=cZFgsLq8Gs">Paper</a> |
+  <a href="https://deepscientist.cc/">Website</a>
 </p>
 
 <p align="center">
+  <a href="https://github.com/ResearAI/DeepScientist"><img alt="GitHub stars" src="https://img.shields.io/github/stars/ResearAI/DeepScientist?style=for-the-badge&logo=github"></a>
   <a href="https://openreview.net/forum?id=cZFgsLq8Gs"><img alt="ICLR 2026" src="https://img.shields.io/badge/ICLR-2026-blue?style=for-the-badge&logo=openreview"></a>
   <a href="LICENSE"><img alt="License Apache-2.0" src="https://img.shields.io/badge/License-Apache%202.0-yellow.svg?style=for-the-badge"></a>
   <a href="https://www.python.org/"><img alt="Python 3.11+" src="https://img.shields.io/badge/Python-3.11%2B-blue?style=for-the-badge&logo=python&logoColor=white"></a>
   <a href="https://www.npmjs.com/package/@researai/deepscientist"><img alt="npm @researai/deepscientist" src="https://img.shields.io/badge/npm-%40researai%2Fdeepscientist-CB3837?style=for-the-badge&logo=npm&logoColor=white"></a>
-  <a href="https://deepscientist.cc/"><img alt="Website deepscientist.cc" src="https://img.shields.io/badge/Website-deepscientist.cc-brightgreen?style=for-the-badge&logo=googlechrome&logoColor=white"></a>
+</p>
+
+<p align="center">
+  <strong>15-minute local setup</strong> ·
+  <strong>One repo per quest</strong> ·
+  <strong>Visible research progress</strong> ·
+  <strong>Human takeover anytime</strong>
 </p>
 
 <p align="center">
   <a href="docs/en/00_QUICK_START.md">Quick Start</a> •
-  <a href="docs/en/02_START_RESEARCH_GUIDE.md">Start Research Guide</a> •
-  <a href="docs/en/10_WEIXIN_CONNECTOR_GUIDE.md"><img src="assets/branding/connector-weixin.png" alt="Weixin" width="14" height="14" /> Weixin</a> •
-  <a href="docs/en/03_QQ_CONNECTOR_GUIDE.md"><img src="assets/branding/connector-qq.png" alt="QQ" width="14" height="14" /> QQ</a> •
-  <a href="docs/en/04_LINGZHU_CONNECTOR_GUIDE.md"><img src="assets/branding/connector-rokid.png" alt="Rokid" width="14" height="14" /> Rokid</a> •
-  <a href="https://openreview.net/forum?id=cZFgsLq8Gs">Paper</a>
+  <a href="docs/en/02_START_RESEARCH_GUIDE.md">Launch Your First Project</a> •
+  <a href="docs/en/12_GUIDED_WORKFLOW_TOUR.md">Product Tour</a> •
+  <a href="docs/en/15_CODEX_PROVIDER_SETUP.md">Model Setup</a>
 </p>
 
+![deepscientist_install](https://github.com/user-attachments/assets/d8244944-4f70-4e08-94e3-002b74ce70fb)
+
+If you are tired of paper overload, broken baselines, scattered experiment logs, and late-night writing cleanup, give the project a star first, then keep scrolling to see how much research grunt work it can take off your plate.
+
+---
+
+https://github.com/user-attachments/assets/3c7abb44-2b25-4477-a011-10a3154d6d76
+
+## Still Spending Your Time On Research Grunt Work?
+
+What drains researchers is often not the lack of ideas. It is the endless cycle of low-leverage work:
+
+- new papers keep coming, but only a small fraction turns into an actionable next-step research plan
+- baseline repos fail on environment, dependency, data, and script issues before real work even starts
+- experiment results get scattered across terminals, scripts, notes, and chats, making later review painful
+- writing, figures, and analysis live in separate tools, so turning them into a coherent paper takes far too long
+
+This is the problem DeepScientist is built to solve:
+
+> turn fragmented, repetitive, easy-to-lose research work into a local AI workspace that can keep moving, keep accumulating, and keep getting stronger over time
+
+## DeepScientist Is Not Just Another "Research Chatbot"
+
+It is not a tool that summarizes papers, throws you a few ideas, and leaves the dirty work to you.
+
+It is much closer to a real long-running AI research partner:
+
+| What common AI tools often look like | What DeepScientist does instead |
+|---|---|
+| Great at chatting, but context disappears quickly | Turns tasks, files, branches, artifacts, and memory into durable state |
+| Good at suggesting ideas, but weak at sustained execution | Pushes papers, baselines, experiments, and writing inside one workspace |
+| Strong automation, but feels like a black box | Lets you inspect the process through the web workspace, Canvas, files, and terminal |
+| Hard to take over once it goes off track | Lets you pause, take over, edit plans, change code, and continue at any time |
+| Each run ends when the run ends | Preserves failed paths, winning paths, and reproduction lessons for the next round |
+
 ## About
 
-DeepScientist is not just a long-running autonomous scientific discovery system. It is also a persistent research map that lives on your own machine.
+> DeepScientist is not a one-shot agent demo. It is a system built for long-horizon research work.
+
+## What Can It Actually Help You Get Done?
+
+### 1. Start a real project from a paper or a research question
+
+- feed it a core paper, a GitHub repository, or a natural-language research objective
+- it turns those inputs into an executable quest instead of a chat that loses state after a few turns
+
+### 2. Reproduce baselines and keep the reproduction reusable
+
+- restore repositories, prepare environments, handle dependencies, and track the critical failures
+- preserve what broke, what got fixed, and which steps are trustworthy for future rounds
+
+### 3. Run experiments continuously instead of stopping after one pass
+
+- propose the next hypothesis from existing results
+- branch, ablate, compare, and record conclusions
+- keep failed routes as assets instead of deleting them
+
+### 4. Turn results into materials you can actually ship
+
+- organize findings, conclusions, and analysis
+- produce figures, reports, and paper drafts
+- support local PDF and LaTeX compilation workflows
+
+### 5. Follow the same research effort from multiple surfaces
+
+- the web workspace in your browser
+- the TUI workflow on a remote server
+- external connector surfaces for collaboration and progress updates
 
-- See every branch.
-- Recover every lesson.
-- Compound every round.
+The current docs already cover these collaboration channels:
 
-**A research workspace you can actually inspect.** The frontend rebuilds a live [Canvas](docs/en/06_RUNTIME_AND_CANVAS.md) from Git branches, artifacts, connector traffic, and raw quest events, so progress stays visible as a navigable map instead of collapsing into one long chat log.
+- [Weixin](docs/en/10_WEIXIN_CONNECTOR_GUIDE.md)
+- [QQ](docs/en/03_QQ_CONNECTOR_GUIDE.md)
+- [Telegram](docs/en/16_TELEGRAM_CONNECTOR_GUIDE.md)
+- [WhatsApp](docs/en/17_WHATSAPP_CONNECTOR_GUIDE.md)
+- [Feishu](docs/en/18_FEISHU_CONNECTOR_GUIDE.md)
+- [Lingzhu / Rokid](docs/en/04_LINGZHU_CONNECTOR_GUIDE.md)
 
-**Memory that survives failure.** Built-in [memory](docs/en/07_MEMORY_AND_MCP.md) turns paper notes, dead ends, route decisions, and recovered lessons into searchable project state that later rounds can pull back deliberately.
+## Why Is It Easier To Keep Using?
 
-**A self-evolving loop with real state.** Failed branches, reusable baselines, promoted lessons, and new evidence all feed the next round, so DeepScientist compounds research progress instead of restarting from zero.
+What retains users is not a flashy demo. It is a system that becomes more useful the longer you work with it.
 
-**A studio, not a sealed autopilot.** DeepScientist can drive a task end to end, but you can step in at any moment to redirect the plan, edit code, inspect files, or run the terminal yourself inside the same quest.
+DeepScientist tends to stick for four reasons:
 
-DeepScientist is strong at:
+### Local-first by default
 
-- reproducing baselines and keeping them reusable
-- reading papers, extracting concrete limitations, and generating hypotheses
-- running experiment branches, analysis campaigns, figures, and paper drafts
-- preserving both successful and failed results so the next round can start stronger
+- code, experiments, drafts, and project state stay on your own machine or server by default
+- this is especially valuable for unpublished ideas, sensitive experiment history, and longer-running research loops
 
-DeepScientist is flexible and easy to use with:
+### One repo per quest
 
-- local-first, open-source, one-command install
-- Git-backed quest repositories, shared web workspace, Studio / Canvas, and TUI
-- workshop-style collaboration: let DeepScientist drive, or pause anytime to inspect, edit, and run commands yourself
-- Codex with `gpt-5.4` by default, plus external OpenAI-compatible inference endpoints
-- use DeepScientist anywhere: server via TUI, browser via Web, phone via Weixin or QQ, and even glasses via Rokid Glasses
-- one bound external connector per quest: [Weixin](docs/en/10_WEIXIN_CONNECTOR_GUIDE.md), [QQ](docs/en/03_QQ_CONNECTOR_GUIDE.md), Telegram, Discord, Slack, Feishu, WhatsApp, and [Lingzhu / Rokid](docs/en/04_LINGZHU_CONNECTOR_GUIDE.md)
-- conference-to-journal extension workflows, and rebuttal workflows from paper, code, and reviewer comments
-- one quest, one Git repository
-- branches and worktrees as native research structure
-- live Studio and Canvas from durable quest state
-- reusable baselines, not one-off benchmark runs
-- durable `bash_exec` sessions, not disposable terminal output
+- every quest is a real Git repository
+- branches, worktrees, files, and artifacts naturally express research structure
 
-DeepScientist works best when the task is computational, verifiable, and worth tracking across multiple rounds.
+### The process is not a black box
 
-## News
+- it does not only give you an output
+- you can inspect what it read, what it changed, what it kept, and what it plans to do next
 
-- `2026/03/24`: DeepScientist officially releases `v1.5`.
-- `2026/02/01`: the DeepScientist paper is available on [OpenReview](https://openreview.net/forum?id=cZFgsLq8Gs) for `ICLR 2026`.
+### Human collaboration is built in
 
-## Getting Started
+- DeepScientist can move autonomously
+- you can also step in, edit, redirect, and hand control back whenever you want
 
-- [Docs Index (English)](docs/en/README.md)
-- [Quick Start (English)](docs/en/00_QUICK_START.md)
-- [Guided Workflow Tour (English)](docs/en/12_GUIDED_WORKFLOW_TOUR.md)
-- [Start Research Guide (English)](docs/en/02_START_RESEARCH_GUIDE.md)
-- [Core Architecture Guide (English)](docs/en/13_CORE_ARCHITECTURE_GUIDE.md)
+## Why Try It Now?
 
-## Install
+Because this is not just a concept. It is a real system with public docs, a public paper, and a public install path.
+
+- `2026/03/24`: DeepScientist officially released `v1.5`
+- `2026/02/01`: the paper went live on [OpenReview](https://openreview.net/forum?id=cZFgsLq8Gs) for `ICLR 2026`
+- npm install path is already available: [`@researai/deepscientist`](https://www.npmjs.com/package/@researai/deepscientist)
+- both Chinese and English docs are available, along with Web, TUI, and connector entry points
+
+## Product Preview
+
+### Architecture Overview
+
+<p align="center">
+  <img src="assets/readme/architecture-promo.png" alt="DeepScientist architecture overview" width="92%" />
+</p>
+
+### Example Outputs
+
+<table>
+<tr>
+<td width="50%">
+<img src="assets/readme/paper-output-1.png" alt="DeepScientist generated paper example 1" width="100%" />
+</td>
+<td width="50%">
+<img src="assets/readme/paper-output-2.png" alt="DeepScientist generated paper example 2" width="100%" />
+</td>
+</tr>
+<tr>
+<td valign="top">
+<b>Example paper output 1</b><br/>
+Paper-facing deliverables can be preserved directly inside the quest instead of being split across external tools.
+</td>
+<td valign="top">
+<b>Example paper output 2</b><br/>
+DeepScientist can carry work through writing, review, figure polish, and export workflows.
+</td>
+</tr>
+</table>
+
+### Workspace Preview
+
+<table>
+<tr>
+<td width="33%">
+<img src="assets/readme/start-research-promo.png" alt="Start Research dialog" width="100%" />
+</td>
+<td width="33%">
+<img src="assets/readme/canvas-promo.png" alt="Canvas workspace preview" width="100%" />
+</td>
+<td width="33%">
+<img src="assets/readme/studio-details-promo.png" alt="Studio and details workspace preview" width="100%" />
+</td>
+</tr>
+<tr>
+<td valign="top">
+<b>Start Research</b><br/>
+Kick off a quest from a paper, repository, or natural-language goal.
+</td>
+<td valign="top">
+<b>Canvas</b><br/>
+Inspect branches, baselines, and accumulated research structure as a visible map.
+</td>
+<td valign="top">
+<b>Studio + Details</b><br/>
+Review metrics, traces, and project state without leaving the same workspace.
+</td>
+</tr>
+</table>
+
+### Progress Reporting
+
+<p align="center">
+  <img src="assets/readme/progress-reporting-promo.png" alt="DeepScientist progress reporting example" width="88%" />
+</p>
+
+### Projects surface after long-running work
+
+![DeepScientist projects surface](assets/readme/projects-surface.png)
+
+## Who Will Love DeepScientist Most?
+
+- graduate students and engineers who want to reproduce papers and push beyond existing baselines
+- labs or research teams running long experiment loops, ablations, and structured result analysis
+- people who want code, experiments, notes, and writing to live in one workspace
+- users who do not want to hand unpublished ideas and intermediate results directly to a pure cloud workflow
+- people who want to run work on servers while following progress from web, TUI, or messaging surfaces
+
+## The Core Philosophy Behind DeepScientist
+
+We believe a system that is actually suitable for research should at least satisfy these principles:
+
+- one quest, one repository, instead of letting everything dissolve after a short conversation
+- branches and worktrees should express research routes naturally instead of being forced into chat history
+- failed paths should be preserved, summarized, and reused instead of overwritten
+- human researchers should always retain takeover power instead of being locked outside the loop
+- the research process should be reviewable, inspectable, and auditable instead of relying on "the model says it did it"
+
+If that sounds like the way you want to work, DeepScientist is worth trying now.
+
+## Get Started In 30 Seconds
+
+If you want to try it right now, the shortest path is:
+
+Platform note: DeepScientist fully supports Linux and macOS. Native Windows support is currently experimental (strongly recommend WSL2).
 
 ```bash
 npm install -g @researai/deepscientist
 codex --login
-ds --yolo --here
+ds --here
 ```
 
-If `codex --login` is unavailable, run `codex` once and finish authentication there. After startup, open `http://127.0.0.1:20999`.
+To stop the managed local daemon and all currently running agents:
 
-For detailed install, troubleshooting, PDF compile, and other launch modes, use:
+```bash
+ds --stop
+```
 
-- [Quick Start](docs/en/00_QUICK_START.md)
-- [Codex Provider Setup](docs/en/15_CODEX_PROVIDER_SETUP.md)
-- [Doctor](docs/en/09_DOCTOR.md)
+If `codex --login` is unavailable, run this once first:
 
-## Documentation
+```bash
+codex
+```
 
-- [Docs Index (English)](docs/en/README.md)
-- [Guided Workflow Tour (English)](docs/en/12_GUIDED_WORKFLOW_TOUR.md)
-- [Core Architecture Guide (English)](docs/en/13_CORE_ARCHITECTURE_GUIDE.md)
-- [Prompt, Skills, and MCP Guide (English)](docs/en/14_PROMPT_SKILLS_AND_MCP_GUIDE.md)
-- [Weixin Connector Guide (English)](docs/en/10_WEIXIN_CONNECTOR_GUIDE.md)
-- [QQ Connector Guide (English)](docs/en/03_QQ_CONNECTOR_GUIDE.md)
-- [Lingzhu / Rokid Guide (English)](docs/en/04_LINGZHU_CONNECTOR_GUIDE.md)
-- [Memory and MCP Guide (English)](docs/en/07_MEMORY_AND_MCP.md)
-- [Settings Reference (English)](docs/en/01_SETTINGS_REFERENCE.md)
-- [Codex Provider Setup (English)](docs/en/15_CODEX_PROVIDER_SETUP.md)
+If `codex` still appears to be missing after installing DeepScientist, take the explicit repair path instead of assuming the bundled dependency was linked correctly:
 
-## Maintainers
+```bash
+npm install -g @openai/codex
+which codex
+codex --login
+```
 
-- [Architecture](docs/en/90_ARCHITECTURE.md)
-- [Development Guide](docs/en/91_DEVELOPMENT.md)
+If `which codex` still prints nothing after that, fix the npm global bin path first, then retry `codex --login` and `ds doctor`.
 
-## Citation
+After startup, the default local address is:
 
-This project is currently contributed by Yixuan Weng, Shichen Li, Weixu Zhao, Qiyao Sun, Zhen Lin, Minjun Zhu. If you find our work valuable, please cite:
+```text
+http://127.0.0.1:20999
+```
 
-```bibtex
-@inproceedings{
-weng2026deepscientist,
-title={DeepScientist: Advancing Frontier-Pushing Scientific Findings Progressively},
-author={Yixuan Weng and Minjun Zhu and Qiujie Xie and QiYao Sun and Zhen Lin and Sifan Liu and Yue Zhang},
-booktitle={The Fourteenth International Conference on Learning Representations},
-year={2026},
-url={https://openreview.net/forum?id=cZFgsLq8Gs}
-}
+Local browser auth is now optional and disabled by default. If you want a per-launch local access password, start with:
+
+```bash
+ds --auth true
 ```
 
-## End-to-End Autonomous Research Systems
+Then you only need to do three things:
+
+1. click `Start Research`
+2. fill in the research goal, baseline links, paper links, or local paths
+3. let DeepScientist start a real research project that can keep evolving locally
+
+If this is your first run, prefer an isolated environment, a non-root user, and a local machine. For the full details, see:
+
+- [00 Quick Start](docs/en/00_QUICK_START.md)
+- [15 Codex Provider Setup](docs/en/15_CODEX_PROVIDER_SETUP.md)
+- [09 Doctor](docs/en/09_DOCTOR.md)
+
+## Choose Your Starting Path
+
+### I just want to get it running first
+
+- [00 Quick Start](docs/en/00_QUICK_START.md)
+- [12 Guided Workflow Tour](docs/en/12_GUIDED_WORKFLOW_TOUR.md)
+
+### I want to launch a real project today
+
+- [02 Start Research Guide](docs/en/02_START_RESEARCH_GUIDE.md)
+- [01 Settings Reference](docs/en/01_SETTINGS_REFERENCE.md)
+
+### I mainly work on servers and terminals
+
+- [05 TUI Guide](docs/en/05_TUI_GUIDE.md)
+
+### I want to connect my own models or external collaboration channels
+
+- [15 Codex Provider Setup](docs/en/15_CODEX_PROVIDER_SETUP.md)
+- [Weixin Connector Guide](docs/en/10_WEIXIN_CONNECTOR_GUIDE.md)
+- [QQ Connector Guide](docs/en/03_QQ_CONNECTOR_GUIDE.md)
+- [Telegram Connector Guide](docs/en/16_TELEGRAM_CONNECTOR_GUIDE.md)
+- [WhatsApp Connector Guide](docs/en/17_WHATSAPP_CONNECTOR_GUIDE.md)
+- [Feishu Connector Guide](docs/en/18_FEISHU_CONNECTOR_GUIDE.md)
+
+### I want to understand the system design first
+
+- [Docs Index](docs/en/README.md)
+- [Core Architecture Guide](docs/en/13_CORE_ARCHITECTURE_GUIDE.md)
+- [Prompt, Skills, and MCP Guide](docs/en/14_PROMPT_SKILLS_AND_MCP_GUIDE.md)
+
+## Autonomous Research Systems
+
+### End-to-End Autonomous Research Systems
 
 | System | System Type | E2E | Research Map | Workshop | Keeps Growing | Channels | Figure & Rebuttal & Review |
 |---|---|---|---|---|---|---|---|
@@ -153,17 +354,62 @@ url={https://openreview.net/forum?id=cZFgsLq8Gs}
 | [Research-Claw](https://github.com/wentorai/Research-Claw) | Open-source | ✓ |  | ✓ | ✓ | ✓ |  |
 | [DeepScientist](https://github.com/ResearAI/DeepScientist) | Open-source | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ |
 
+## Documentation
+
+- [English Docs Index](docs/en/README.md)
+- [Chinese Docs Index](docs/zh/README.md)
+
+## NLPCC 2026 AISB Challenge
+
+If you want to benchmark or extend AI scientist systems in the wild, the NLPCC 2026 AISB shared task is a natural next stop:
+
+- [Registration](http://tcci.ccf.org.cn/conference/2026/shared-tasks/)
+- [Task Repository](https://github.com/ResearAI/NLPCC-2026-Task9-AISB)
+
+<p align="center">
+  <img src="assets/readme/aisb-poster.jpeg" alt="NLPCC 2026 AISB shared task poster" width="88%" />
+</p>
+
+## For Developers And Maintainers
+
+If you are developing or maintaining DeepScientist, continue with:
+
+- [Architecture](docs/en/90_ARCHITECTURE.md)
+- [Development Guide](docs/en/91_DEVELOPMENT.md)
+- [CONTRIBUTING](CONTRIBUTING.md)
+
+## Citation
+
+If DeepScientist helps your research or engineering work, please cite:
+
+```bibtex
+@inproceedings{
+weng2026deepscientist,
+title={DeepScientist: Advancing Frontier-Pushing Scientific Findings Progressively},
+author={Yixuan Weng and Minjun Zhu and Qiujie Xie and QiYao Sun and Zhen Lin and Sifan Liu and Yue Zhang},
+booktitle={The Fourteenth International Conference on Learning Representations},
+year={2026},
+url={https://openreview.net/forum?id=cZFgsLq8Gs}
+}
+```
+
+If this feels like the research workflow you have been waiting for, give the project a star. Every star makes it easier for more researchers who actually need it to find it.
+
+## Community
+
+Welcome to join the WeChat group for discussion.
+
+<p align="center">
+  <img src="assets/readme/wechat.jpg" alt="DeepScientist WeChat group" width="360" />
+</p>
+
 ## More From ResearAI
 
-DeepReviewer and AutoFigure projects worth exploring alongside DeepScientist:
+If you like DeepScientist, you may also want to explore the rest of the ResearAI ecosystem:
 
 | Project | What it does |
 |---|---|
-| [AutoFigure](https://github.com/ResearAI/AutoFigure) | generate paper-ready figures |
-| [AutoFigure-Edit](https://github.com/ResearAI/AutoFigure-Edit) | editable vector paper figures |
-| [DeepReviewer-v2](https://github.com/ResearAI/DeepReviewer-v2) | review papers and drafts |
+| [AutoFigure](https://github.com/ResearAI/AutoFigure) | generate publication-ready figures |
+| [AutoFigure-Edit](https://github.com/ResearAI/AutoFigure-Edit) | generate editable vector paper figures |
+| [DeepReviewer-v2](https://github.com/ResearAI/DeepReviewer-v2) | review papers and suggest revisions |
 | [Awesome-AI-Scientist](https://github.com/ResearAI/Awesome-AI-Scientist) | curated AI scientist landscape |
-
-## License
-
-[Apache License 2.0](LICENSE)