2026-06-10 22:57:44 +08:00
|
|
|
# DeepSeek Harness
|
|
|
|
|
|
docs: bilingual docs contract, translation skill, and pairing gate
Establish EN->ZH bilingual documentation for the README and docs tree:
- docs/i18n/README.md — the pairing contract: sibling foo.md <-> foo.zh.md,
English canonical, blob-hash source fingerprints, language switchers,
scope/exclusions, and a manifest-driven rollout ratchet.
- docs/i18n/translation-rules.md — how to translate: faithfulness, structure
preservation, terminology discipline over docs/i18n/terminology.md, and
typography rules grounded in MDN/K8s/Vue/clreq conventions.
- .agents/skills/dsh-translate-docs — the committed agent workflow, following
the dsh-code-review pattern of deferring to docs as sources of truth.
- scripts/verify-translation-pairing.ts + manifest — a doc-sync gate: required
pairs exist; every existing .zh.md is fresh (fingerprint = current source
blob), switcher-linked, structure-matched, and non-orphaned; excluded
(generated) docs stay unpaired. --list prints the translation work list.
- RFC (implemented/process) recording the decision and the alternatives.
- Dogfood: README.zh.md and the two i18n docs translated under their own rules.
Gates: doc-sync green including the new gate; red/green proven for stale
fingerprint, orphan, and excluded-file violations.
2026-07-02 23:12:25 -07:00
|
|
|
English | [中文](README.zh.md)
|
2026-06-10 22:57:44 +08:00
|
|
|
|
2026-08-13 12:02:48 +08:00
|
|
|
DeepSeek Harness (`dsh`) is an open-source agent harness developed by [DeepSeek AI](https://deepseek.com).
|
2026-07-23 12:15:56 +08:00
|
|
|
|
2026-08-13 12:02:48 +08:00
|
|
|
It is powered by [Cordis](https://github.com/cordiverse/cordis) and uses an architecture where **everything is a plugin**.
|
2026-06-10 22:57:44 +08:00
|
|
|
|
2026-08-13 12:02:48 +08:00
|
|
|
## Developer preview
|
2026-07-22 10:55:16 +08:00
|
|
|
|
2026-08-13 12:02:48 +08:00
|
|
|
DeepSeek Harness is currently in _developer preview_ and is iterating rapidly. **THERE WILL BE COMPATIBILITY-BREAKING CHANGES.**
|
2026-07-22 10:55:16 +08:00
|
|
|
|
2026-08-13 12:02:48 +08:00
|
|
|
## Run from `npm`
|
2026-07-22 10:55:16 +08:00
|
|
|
|
2026-08-13 12:02:48 +08:00
|
|
|
Install `Node.js`, then run the published package:
|
2026-07-22 10:55:16 +08:00
|
|
|
|
|
|
|
|
```sh
|
2026-08-12 10:59:06 +08:00
|
|
|
npx @deepseek-ai/dsh web
|
2026-07-22 10:55:16 +08:00
|
|
|
```
|
|
|
|
|
|
2026-08-13 12:02:48 +08:00
|
|
|
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).
|
2026-07-23 00:15:44 +08:00
|
|
|
|
2026-08-12 10:59:06 +08:00
|
|
|
### Run from source
|
2026-07-23 00:15:44 +08:00
|
|
|
|
2026-08-13 12:02:48 +08:00
|
|
|
To run from a repository checkout:
|
2026-07-23 00:15:44 +08:00
|
|
|
|
|
|
|
|
```sh
|
2026-08-12 14:03:34 +08:00
|
|
|
git clone https://github.com/deepseek-ai/deepseek-harness.git
|
2026-08-12 10:59:06 +08:00
|
|
|
cd deepseek-harness
|
|
|
|
|
pnpm install
|
2026-08-12 11:57:02 +08:00
|
|
|
pnpm run build
|
2026-08-12 10:59:06 +08:00
|
|
|
pnpm dsh web
|
2026-07-23 00:15:44 +08:00
|
|
|
```
|
|
|
|
|
|
2026-08-13 12:02:48 +08:00
|
|
|
## Community and support
|
2026-07-23 00:15:44 +08:00
|
|
|
|
2026-08-13 12:02:48 +08:00
|
|
|
### Report bugs and suggest improvements
|
2026-07-30 16:47:27 +08:00
|
|
|
|
2026-08-13 12:02:48 +08:00
|
|
|
- Feel free to submit feedback or bug reports through [GitHub Discussions](https://github.com/deepseek-ai/deepseek-harness/discussions).
|
Document the architecture and rewrite AGENTS.md
docs/architecture.md: layering, service map, event taxonomy, the
session/turn/step lifecycle, Cordis waterfall semantics, an extension
cookbook, the plugin sanity checklist mapping every MVP feature to its
extension mechanism, and the deferred-work TODO list (sub-agents,
persistence backends, compaction, DeepSeek V4 adapter, parallel tool
execution, streaming-protocol review).
AGENTS.md: repo layout, commands, conventions (dsh-* naming, ESM,
effect-based registrations, declaration merging, waterfall semantics),
and the vendoring policy pointer.
2026-06-11 10:55:05 +08:00
|
|
|
|
2026-08-13 12:02:48 +08:00
|
|
|
### Share a plugin
|
2026-07-23 00:15:44 +08:00
|
|
|
|
2026-08-13 12:02:48 +08:00
|
|
|
- Add the [`dsh-plugin`](https://github.com/topics/dsh-plugin) topic to your plugin repository for discoverability.
|
2026-07-23 00:15:44 +08:00
|
|
|
|
2026-08-13 12:02:48 +08:00
|
|
|
## Contributing
|
2026-07-23 00:15:44 +08:00
|
|
|
|
2026-08-13 12:02:48 +08:00
|
|
|
See [CONTRIBUTING.md](CONTRIBUTING.md).
|
2026-07-23 00:15:44 +08:00
|
|
|
|
|
|
|
|
## Development
|
Document the architecture and rewrite AGENTS.md
docs/architecture.md: layering, service map, event taxonomy, the
session/turn/step lifecycle, Cordis waterfall semantics, an extension
cookbook, the plugin sanity checklist mapping every MVP feature to its
extension mechanism, and the deferred-work TODO list (sub-agents,
persistence backends, compaction, DeepSeek V4 adapter, parallel tool
execution, streaming-protocol review).
AGENTS.md: repo layout, commands, conventions (dsh-* naming, ESM,
effect-based registrations, declaration merging, waterfall semantics),
and the vendoring policy pointer.
2026-06-11 10:55:05 +08:00
|
|
|
|
2026-08-13 12:02:48 +08:00
|
|
|
Start with the [development guide](docs/development.md) and [architecture documentation](docs/architecture.md).
|
2026-07-23 00:37:30 +08:00
|
|
|
|
|
|
|
|
For agents, follow [AGENTS.md](AGENTS.md).
|
2026-07-23 00:15:44 +08:00
|
|
|
|
|
|
|
|
## License
|
2026-06-14 10:47:32 +08:00
|
|
|
|
2026-07-23 00:15:44 +08:00
|
|
|
[BSD 3-Clause](LICENSE)
|
2026-07-29 21:29:49 -07:00
|
|
|
|
|
|
|
|
Third-party dependencies and their licenses are disclosed in [THIRD_PARTY_NOTICES.md](THIRD_PARTY_NOTICES.md).
|