Where to read dsh docs: README, reference, releases
When one topic has three answers, the usual cause is not a wrong author but a different point in time. Decide what you are asking, then open the source that answers it.
Choosing dsh docs by question and role
Classify first; do not page through everything.
| You want to know | Read | Why |
|---|---|---|
| How to run it fastest | README quick start | Shortest path only |
| What a flag exactly does | CLI reference | Boundaries and precedence |
| What changed in a release | Releases | Per-version record |
| How to use the UI | Docs site guides | Task oriented |
| What this build supports | --help output | Generated by your install |
The last row wins over every web page, because it cannot lag behind the binary you are running.
Knowing each source's role makes the mapping obvious. README gets it running, the reference explains why, Releases tells you when it changed:
- README: install and start commands, aimed at a first contact; it follows the main branch and does not promise full coverage of edge cases.
- CLI reference: argument boundaries, parsing order, exit codes, and failure handling — the authority on whether a given syntax is legal.
- Releases: what changed per version, answering "is this behavior expected after upgrading".
The documentation site is the reader-facing version of all three. It suits task-based reading, but details still belong to the reference.
dsh doc precedence and version alignment
Local help output, then the matching reference, then releases, then the README, then third-party posts.
- Help output is generated by your build;
- The reference tracks the source and describes boundaries completely;
- Releases pin a version, so they explain change points;
- The README targets the latest main branch and may lead or lag your build;
- Third-party guides often omit versions and are only leads.
Check the version before rewriting a command. Two documents can both be right about different versions.
Version alignment comes first. Any comparison starts with three steps:
- Record
dsh --version; - Find that version in Releases and read its notes;
- Open the reference and confirm it describes the same generation of behavior.
When versions do not match, a document is a reference, not a script to copy. Flag names, default ports, and default listen addresses change most often.
A worked dsh example
Suppose two startup forms appear online and you want to know which is correct.
- Run
dsh --helpto see the launcher's own flags; - Run
dsh --profile web --helpto see the web app's flags; - Dump the combined configuration to confirm defaults;
- Start once and read the address actually printed;
- Only if all of that is inconclusive, search the docs site by task.
The order is local first, remote second. Anything verifiable locally should not be settled by reading.
Fast-aging dsh content and how to read Releases
Not all documentation decays at the same rate.
- Screenshots and UI paths: invalidated by the next redesign;
- Default ports and listen addresses: change with versions or bundles;
- Package names and command shorthand: distorted in retelling;
- Plugin counts and marketplace screenshots: move with the ecosystem;
- Installer file names: change with packaging.
For these five, verify against the command and the release page. A screenshot identifies an interface; it does not authorize an operation.
Releases is where that verification starts. It is not a changelog dump; read it for three kinds of information:
- Version number and date, to confirm the upgrade window;
- Breaking changes and behavior adjustments, which most affect your commands;
- Install and runtime entries; ecosystem changes can wait.
Titles are not enough. Many behavior changes sit in body paragraphs while the heading says "improve startup".
dsh lookup checklist
Three lines replace most future deliberation.
- Is this command legal? Use local
--help; - What are the boundaries and precedence? Use the CLI reference;
- What changed in a version? Use the matching Releases entry.
Those three cover install-time questions. UI how-tos go to the docs site.
dsh next steps
Align the version, then trust the documentation. For startup flag behavior, read dsh startup flags. For layered startup triage, read the startup decision tree. For post-install checks, read the acceptance test. For what to collect before asking for help, read the support bundle.
Sources: DeepSeek Harness docs, dsh CLI reference, DeepSeek Harness Releases, deepseek-harness repository
FAQ
Trusting one dsh document over another depends on the question: for getting started, use the README quick start, and for exact flag behavior, use the CLI reference. When they conflict, prefer the source closest to the code and matching your installed version.
Usually it is a dsh version difference rather than a documentation error: release notes describe one specific version, while the README follows the main branch. Check your installed version, then read the notes for that version instead of applying main-branch syntax to an older build.
Ask the command itself: dsh --help shows launcher flags, and dsh --profile web --help shows web app flags. Help output is generated from the installed version, so it is faster and more accurate than any page.
dsh defaults can change between versions or profile bundles, and your patch layers can override them. Read the bound address printed at startup and inspect the combined tree with a config dump rather than trusting a number on a page.
Related Terms
- quick start
- A quick start is the shortest runnable path in the documentation, aimed at showing the interface in minutes without explaining every flag or edge case.— DeepSeek Harness docs
- CLI reference
- The CLI reference is the document that specifies exact behavior for the launcher and each profile, including argument boundaries, precedence, and exit behavior.— dsh CLI reference
- Releases
- Releases is the per-version page recording additions, changes, and fixes for one release rather than the current main branch.— DeepSeek Harness Releases
- config dump
- A config dump is a command that prints the combined configuration tree without starting the service, showing effective values after all patch layers.— dsh CLI reference
Sources
- DeepSeek Harness docs· deepseek-harness
- dsh CLI reference· deepseek-ai
- DeepSeek Harness Releases· deepseek-ai
- deepseek-harness repository· deepseek-ai