2.1 KiB
Quick start
English | 中文
This guide gets an agent running in five minutes.
Prerequisites
- Node.js ^22.19 or >= 24
- pnpm 11 through Corepack
- A DeepSeek Platform API key
node -v
corepack enable
pnpm -v
Step 1: install and configure the API key
git clone https://github.com/deepseek-ai/deepseek-harness.git
cd deepseek-harness
pnpm install
Create the gitignored repository-root .env:
DEEPSEEK_API_KEY=sk-your-key-here
Step 2: run one Headless task
Run a non-interactive task and print its final answer:
pnpm dsh --profile headless "summarize the architecture of this workspace"
dsh --profile headless creates and persists a fresh session, prints the final assistant answer, and exits. It starts no Web server or listening port, and a successful run leaves stderr empty.
Step 3: use the Web UI
Start the browser interface:
pnpm dsh web
Open http://127.0.0.1:3080. The agent can read and write files, run commands, delegate subtasks, and track a plan. Try: Create hello.js in the current directory, print "Hello from Harness!", and run it.
What happened
dsh --profile headless boots the headless profile: dsh-base and dsh-headless compose over an empty root, then the runner drives the core Agent and Session services directly. dsh web instead composes dsh-base with dsh-web-app, which owns the Host, HTTP, and browser layers. Both read the same default DeepSeek model route from dsh-base.
Next steps
- Get started with the Python SDK — install the SDK and run a complete Cordis configuration without the Web UI
- Configure models — reach providers beyond DeepSeek, and custom gateways
- Configuration — understand the
cordis.ymlformat - Develop a plugin — build your own tool or backend