Answer in brief
The shortest supported path is to run the official npm launcher, open the local Web UI, confirm that a model provider is configured, and create a disposable first workspace. Treat the project as Developer Preview software: record the version and avoid using sensitive production repositories for the first run.
This path uses the official package published to npm; you don’t need to clone the source first.
1. Check Node.js
Open a terminal and run:
node --versionIf the command doesn’t exist, install a supported stable version from the official Node.js channels first. Do not download installers from unknown download sites.
2. Start the Web UI
Run the following in the project directory you intend to use as your workspace:
npx @deepseek-ai/dsh webThe default address documented in the official README is:
http://127.0.0.1:3080The terminal process needs to keep running. If the browser can’t reach the page, first check the terminal for port conflicts, installation errors, or permission prompts.
3. Configure a Model
Once inside the Web UI, open Settings → Models, fill in the API Key required by your model Provider, and save. According to the official guide, the model routing works immediately after saving — no service restart needed.
Never put a real API Key:
- in chat logs;
- in files that will be committed to Git;
- in screenshots or tutorial examples;
- in public Issues.
4. Choose a Workspace
Click Choose workspace, then add and select the project directory where you launched dsh. Until a workspace is selected, the session editor may remain unavailable.
For your first try, use a test project with no sensitive files.
5. Run Your First Task
Create a session and send:
Summarize this repository and point out the main directories and packages. Read-only for now — do not modify any files.This request is easy to verify and lets you observe the basic flow of workspace reads, planning, and tool approvals.
6. Add an Acceptance Contract
Goal: explain the repository purpose and main entry points.
Scope: read README, package.json, and top-level src directories only.
Constraints: do not edit, install dependencies, or use the network.
Deliverable: a table of directories, responsibilities, and evidence files.Watch which files are read, whether paths point into the selected workspace, and whether conclusions cite results. If a read-only task asks for write permission, reject it and ask why.
Failure Branches
| Symptom | Check first |
|---|---|
npx unavailable | Node and npm installation |
| UI unreachable | Running terminal and listen address |
| Editor disabled | Workspace selection |
| Authentication error | Provider, model ID, credential |
| Files invisible | Workspace path and sandbox |
Success Criteria
- The Web UI opens.
- The model configuration saves successfully.
- A workspace is selected.
- The session returns a repository summary.
- No API Key was committed at any point.
Next, read Configure Model Providers.