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-sdk.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 run demo:headless "summarize the architecture of this workspace"

Headless runs one complete model/tool turn, persists the session, prints the result, and exits. Use --output-format stream-json when you need the canonical event stream.

Step 3: use the Web UI

Build and start the browser interface:

pnpm run build
pnpm run 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

headless-agent uses the @deepseek-ai/dsh-cli-demo app. dsh web instead boots the web profile: the dsh-base and dsh-web-app bundle patch layers composed over an empty root. Both select the DeepSeek model and capability plugins appropriate to their entry mode.

Next steps

Configure models — reach providers beyond DeepSeek, and custom gateways
Configuration — understand the cordis.yml format
Develop a plugin — build your own tool or backend

1.8 KiB Raw Blame History