docs: refresh root README and sync Chinese counterpart
Finalize the English root README (developer-preview notice, npm run path, community sections) and re-translate README.zh.md to match, updating the pairing record. Fix the README.md#run anchors in the Web UI guide and model providers docs after the Run section was renamed.
This commit is contained in:
Tianyi Cui
@@ -2,31 +2,27 @@
|
||||
|
||||
English | [中文](README.zh.md)
|
||||
|
||||
DeepSeek Harness (`dsh`) is an open-source coding agent and plugin-based agent harness.
|
||||
DeepSeek Harness (`dsh`) is an open-source agent harness developed by [DeepSeek AI](https://deepseek.com).
|
||||
|
||||
It uses an architecture where **everything is a plugin**.
|
||||
It is powered by [Cordis](https://github.com/cordiverse/cordis) and uses an architecture where **everything is a plugin**.
|
||||
|
||||
## Internal testing notice
|
||||
## Developer preview
|
||||
|
||||
DeepSeek Harness is under internal testing. Features and interfaces may change.
|
||||
DeepSeek Harness is currently in _developer preview_ and is iterating rapidly. **THERE WILL BE COMPATIBILITY-BREAKING CHANGES.**
|
||||
|
||||
Session Logs stay local by default. Set `DSH_TELEMETRY_MODE=FEEDBACK_ONLY` to share a Session Log only when submitting feedback, or `DSH_TELEMETRY_MODE=FULL` to upload continuously; `FULL` also enables dsh-sdk command telemetry reporting an anonymous ID, the command result, and redacted project configuration. Send feedback through the internal WeChat group.
|
||||
## Run from `npm`
|
||||
|
||||
## Run
|
||||
|
||||
Install Node.js ^22.19 or >= 24 and pnpm 11, then run the published package:
|
||||
Install `Node.js`, then run the published package:
|
||||
|
||||
```sh
|
||||
npx @deepseek-ai/dsh web
|
||||
```
|
||||
|
||||
The command initializes the Web profile and prints the Web UI URL, which is `http://127.0.0.1:3080` by default. Open it, add a DeepSeek API key under **Settings → Models**, then start a session. The invoking directory is the default workspace; try `Summarize this repository and identify its main packages.`
|
||||
|
||||
Continue with the [Web UI guide](docs/user/guide/index.md).
|
||||
The command starts the Web UI, served at `http://127.0.0.1:3080` by default. See [Web UI guide](docs/user/guide/index.md).
|
||||
|
||||
### Run from source
|
||||
|
||||
To run a repository checkout instead:
|
||||
To run from a repository checkout:
|
||||
|
||||
```sh
|
||||
git clone https://github.com/deepseek-ai/deepseek-harness.git
|
||||
@@ -36,28 +32,23 @@ pnpm run build
|
||||
pnpm dsh web
|
||||
```
|
||||
|
||||
`pnpm run build` prepares the repository artifacts. `pnpm dsh web` starts the Web UI without rebuilding and opens the same path.
|
||||
## Community and support
|
||||
|
||||
## Profiles and plugins
|
||||
### Report bugs and suggest improvements
|
||||
|
||||
A profile is an ordered list of plugin bundles. The shipped `web` profile powers `dsh web`. Manage a profile with `dsh plugin --profile <name> <pnpm args>`, which forwards the remaining arguments to pnpm in that profile's directory:
|
||||
- Feel free to submit feedback or bug reports through [GitHub Discussions](https://github.com/deepseek-ai/deepseek-harness/discussions).
|
||||
|
||||
```sh
|
||||
npx -p @deepseek-ai/dsh dsh plugin --profile web add <package>
|
||||
npx -p @deepseek-ai/dsh dsh plugin --profile web remove <package>
|
||||
```
|
||||
### Share a plugin
|
||||
|
||||
`add`, `remove`, `update`, `why`, and other pnpm commands work unchanged. The command initializes a missing profile before changing its packages and updates its bundle list from installed packages that declare `dsh.bundle`. See the [CLI reference](apps/cli/reference/README.md#plugin-management) for the exact behavior.
|
||||
- Add the [`dsh-plugin`](https://github.com/topics/dsh-plugin) topic to your plugin repository for discoverability.
|
||||
|
||||
The [CLI reference](apps/cli/README.md) covers headless execution and custom profiles. The [Python SDK](python/README.md) and [examples](examples/README.md) cover programmatic and custom compositions.
|
||||
## Contributing
|
||||
|
||||
## Community
|
||||
|
||||
Follow <a href="https://x.com/Deepseekharness">DeepSeek Harness on Twitter</a> for project updates.
|
||||
See [CONTRIBUTING.md](CONTRIBUTING.md).
|
||||
|
||||
## Development
|
||||
|
||||
Start with the [development guide](docs/development.md) and read the [architecture](docs/architecture.md) before changing packages.
|
||||
Start with the [development guide](docs/development.md) and [architecture documentation](docs/architecture.md).
|
||||
|
||||
For agents, follow [AGENTS.md](AGENTS.md).
|
||||
|
||||
@@ -66,7 +57,3 @@ For agents, follow [AGENTS.md](AGENTS.md).
|
||||
[BSD 3-Clause](LICENSE)
|
||||
|
||||
Third-party dependencies and their licenses are disclosed in [THIRD_PARTY_NOTICES.md](THIRD_PARTY_NOTICES.md).
|
||||
|
||||
## Contributing
|
||||
|
||||
Read [CONTRIBUTING.md](CONTRIBUTING.md) before contributing to this repository.
|
||||
Reference in New Issue
Block a user