docs: refine README product copy

This commit is contained in:
Tianyi Cui
2026-07-23 00:37:30 +08:00
parent ef325b02fa
commit 2be046dcf2
6 changed files with 18 additions and 74 deletions
+8 -4
View File
@@ -2,16 +2,18 @@
English | [中文](README.zh.md)
DeepSeek Harness (`dsh`) is an open-source coding agent built on the DeepSeek Harness SDK, where everything is a plugin.
DeepSeek Harness (`dsh`) is an open-source coding agent built on the DeepSeek Harness SDK, where **everything is a plugin**.
## Install
Install `dsh` with one command. The installer requires `git` and Node `^22.19 || >=24`, offers to install `pnpm` when it is missing, and prompts for a DeepSeek API key:
Install `dsh` with one command:
```sh
curl -fsSL https://raw.githubusercontent.com/deepseek-harness/deepseek-harness/master/scripts/install.sh | sh
```
The installer requires `git` and Node `^22.19 || >=24`, offers to install `pnpm` when it is missing, and prompts for a DeepSeek API key.
The installer clones DeepSeek Harness to `~/.dsh/source`, links `dsh` into `~/.local/bin`, and launches it. Re-running the command updates the checkout. See [`scripts/install.sh`](scripts/install.sh) for alternate install locations and other options.
## Use DeepSeek Harness
@@ -48,7 +50,7 @@ dsh -p "summarize this workspace"
Built-in capabilities cover file reading, editing, and search; shell execution; reusable skills; task tracking; subagents and workflows; persistent sessions; and context compaction. The TUI also includes Plan Mode.
- **Everything is a plugin.** Models, tools, policies, storage, context management, and interfaces are composable [Cordis plugins](docs/user/develop/basic/index.md), so deployments can extend or replace behavior without forking the agent loop. See the [architecture](docs/architecture.md) for the underlying design.
- **Code Mode is opt-in.** It exposes a `run_code` tool and a generated TypeScript SDK; only program output re-enters model context. See [Code Mode](packages/core/tools/README.md#code-mode).
- **Code Mode (opt-in).** It exposes a `run_code` tool and a generated TypeScript SDK; only program output re-enters model context. See [Code Mode](packages/core/tools/README.md#code-mode).
- **Self-referential Cordis tools are opt-in.** They let the agent inspect its live runtime and mount or unmount plugins while it runs. See the [Cordis tools](packages/cordis/tool-cordis/README.md).
## Community
@@ -62,7 +64,9 @@ pnpm install
pnpm run test:coverage
```
Start with the [development guide](docs/development.md), read the [architecture](docs/architecture.md) before changing packages, and follow [AGENTS.md](AGENTS.md) when working in this repository.
Start with the [development guide](docs/development.md) and read the [architecture](docs/architecture.md) before changing packages.
For agents, follow [AGENTS.md](AGENTS.md).
DeepSeek Harness is currently pre-release.