kevchess15/deepseek-harness
1
1
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions 1
deepseek-harness/README.md

60 lines
2 KiB
Markdown
Raw Normal View History

Initialize repo with README, AGENTS.md, and CLAUDE.md symlink
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)
Initialize repo with README, AGENTS.md, and CLAUDE.md symlink
2026-06-10 22:57:44 +08:00
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.
2026-08-13 12:02:48 +08:00
DeepSeek Harness (`dsh`) is an open-source agent harness developed by [DeepSeek AI](https://deepseek.com).
docs: separate plugin architecture tagline
2026-07-23 12:15:56 +08:00
docs: add link to preview paper
2026-08-13 18:26:20 +08:00
It uses an architecture where **everything is a plugin**, and is powered by [Cordis](https://github.com/cordiverse/cordis), whose design is described in [_A Programming Paradigm for Spatiotemporal Composability_](https://github.com/cordiverse/paper).
Initialize repo with README, AGENTS.md, and CLAUDE.md symlink
2026-06-10 22:57:44 +08:00
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.
2026-08-13 12:02:48 +08:00
## Developer preview
Retire the readline front door and the repl-agent example Delete packages/ui/stdio and examples/repl-agent; rename stdio-demo to @deepseek-ai/dsh-tui-demo (TUI-only, refuses pipes before Loader boot). tui-agent owns the coding composition inline; echo-agent and the CI demo smoke move to the one-shot cli-demo bin, which gains -p/--prompt. The UI-independent with-key e2es move verbatim to tui-agent. SDK wizard's 'stdio' interface becomes 'tui'. PTY testing stays confined to TUI surfaces; all other subprocess tests ride pipes. See .agents/notes/implemented/simplification/2026-07-20-retire-readline-front-door.md
2026-07-22 10:55:16 +08:00
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.
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.**
Retire the readline front door and the repl-agent example Delete packages/ui/stdio and examples/repl-agent; rename stdio-demo to @deepseek-ai/dsh-tui-demo (TUI-only, refuses pipes before Loader boot). tui-agent owns the coding composition inline; echo-agent and the CI demo smoke move to the one-shot cli-demo bin, which gains -p/--prompt. The UI-independent with-key e2es move verbatim to tui-agent. SDK wizard's 'stdio' interface becomes 'tui'. PTY testing stays confined to TUI surfaces; all other subprocess tests ride pipes. See .agents/notes/implemented/simplification/2026-07-20-retire-readline-front-door.md
2026-07-22 10:55:16 +08:00
docs: restore the Run section heading and retarget guide links Split the quickstart into a Run section with a Run from npm subsection, mirror it in the Chinese pair, and point the Web UI guide and providers docs back at the #run anchor.
2026-08-13 12:16:31 +08:00
## Run
### Run from `npm`
Retire the readline front door and the repl-agent example Delete packages/ui/stdio and examples/repl-agent; rename stdio-demo to @deepseek-ai/dsh-tui-demo (TUI-only, refuses pipes before Loader boot). tui-agent owns the coding composition inline; echo-agent and the CI demo smoke move to the one-shot cli-demo bin, which gains -p/--prompt. The UI-independent with-key e2es move verbatim to tui-agent. SDK wizard's 'stdio' interface becomes 'tui'. PTY testing stays confined to TUI surfaces; all other subprocess tests ride pipes. See .agents/notes/implemented/simplification/2026-07-20-retire-readline-front-door.md
2026-07-22 10:55:16 +08:00
docs: follow-up README wording and community section flattening Reorder the Cordis attribution clause, shorten the install lead-in, and flatten the community section into a single list; sync README.zh.md and the pairing record.
2026-08-13 12:12:13 +08:00
Install `Node.js`, then run:
Retire the readline front door and the repl-agent example Delete packages/ui/stdio and examples/repl-agent; rename stdio-demo to @deepseek-ai/dsh-tui-demo (TUI-only, refuses pipes before Loader boot). tui-agent owns the coding composition inline; echo-agent and the CI demo smoke move to the one-shot cli-demo bin, which gains -p/--prompt. The UI-independent with-key e2es move verbatim to tui-agent. SDK wizard's 'stdio' interface becomes 'tui'. PTY testing stays confined to TUI surfaces; all other subprocess tests ride pipes. See .agents/notes/implemented/simplification/2026-07-20-retire-readline-front-door.md
2026-07-22 10:55:16 +08:00
```sh
docs: make Web UI the primary onboarding path
2026-08-12 10:59:06 +08:00
npx @deepseek-ai/dsh web
Retire the readline front door and the repl-agent example Delete packages/ui/stdio and examples/repl-agent; rename stdio-demo to @deepseek-ai/dsh-tui-demo (TUI-only, refuses pipes before Loader boot). tui-agent owns the coding composition inline; echo-agent and the CI demo smoke move to the one-shot cli-demo bin, which gains -p/--prompt. The UI-independent with-key e2es move verbatim to tui-agent. SDK wizard's 'stdio' interface becomes 'tui'. PTY testing stays confined to TUI surfaces; all other subprocess tests ride pipes. See .agents/notes/implemented/simplification/2026-07-20-retire-readline-front-door.md
2026-07-22 10:55:16 +08:00
```
feat(web,cli): open the ready Web UI by default
2026-08-14 13:44:36 +08:00
The command starts the Web UI at `http://127.0.0.1:3080` by default and opens it in the default browser for a local launch. An SSH launch only prints the host URL because the SSH client or editor owns the local forwarded address. Pass `--no-open` to run the server without opening a browser. See [Web UI guide](docs/user/guide/index.md).
docs: make the top-level README product-first
2026-07-23 00:15:44 +08:00
docs: make Web UI the primary onboarding path
2026-08-12 10:59:06 +08:00
### Run from source
docs: make the top-level README product-first
2026-07-23 00:15:44 +08:00
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.
2026-08-13 12:02:48 +08:00
To run from a repository checkout:
docs: make the top-level README product-first
2026-07-23 00:15:44 +08:00
```sh
replace url
2026-08-12 14:03:34 +08:00
git clone https://github.com/deepseek-ai/deepseek-harness.git
docs: make Web UI the primary onboarding path
2026-08-12 10:59:06 +08:00
cd deepseek-harness
pnpm install
fix(cli): separate dsh from repository build
2026-08-12 11:57:02 +08:00
pnpm run build
docs: make Web UI the primary onboarding path
2026-08-12 10:59:06 +08:00
pnpm dsh web
docs: make the top-level README product-first
2026-07-23 00:15:44 +08:00
```
feat(web,cli): open the ready Web UI by default
2026-08-14 13:44:36 +08:00
`pnpm run build` prepares the repository artifacts. `pnpm dsh web` uses those built artifacts without rebuilding.
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.
2026-08-13 12:02:48 +08:00
## Community and support
docs: make the top-level README product-first
2026-07-23 00:15:44 +08:00
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.
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).
- Add the [`dsh-plugin`](https://github.com/topics/dsh-plugin) topic to your plugin repository for discoverability.
docs: refine localized community links
2026-08-13 15:14:36 +08:00
- Join <a href="https://discord.gg/Ycq5dCaS4">DeepSeek Harness Discord community</a>.
docs: add localized community channels
2026-08-13 14:40:28 +08:00
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.
2026-08-13 12:02:48 +08:00
## Contributing
docs: make the top-level README product-first
2026-07-23 00:15:44 +08:00
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.
2026-08-13 12:02:48 +08:00
See [CONTRIBUTING.md](CONTRIBUTING.md).
docs: make the top-level README product-first
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
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.
2026-08-13 12:02:48 +08:00
Start with the [development guide](docs/development.md) and [architecture documentation](docs/architecture.md).
docs: refine README product copy
2026-07-23 00:37:30 +08:00
For agents, follow [AGENTS.md](AGENTS.md).
docs: make the top-level README product-first
2026-07-23 00:15:44 +08:00
## License
docs: split README guidance by audience
2026-06-14 10:47:32 +08:00
Adopt MIT for DSH packages
2026-08-13 01:46:57 +08:00
[MIT](LICENSE)
docs: add THIRD_PARTY_NOTICES.md disclosing third-party dependencies List direct dependencies by tier (vendored Cordis sources, runtime npm, dev-only npm, Python SDK, build-time tools) with upstream links and licenses, and link it from the License section of both READMEs.
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).
Reference in a new issue Copy permalink