mirror of https://github.com/deepseek-ai/deepseek-harness synced 2026-08-15 21:04:50 +00:00

Files

Yichen Jiang 318142ebe9 docs(user): add a model-provider configuration guide

The guide tier said how to compose plugins with `cordis.yml` but never how to
reach a provider other than DeepSeek, so the two things a person actually does
— give a catalog provider its key from the Models page, and declare a gateway
the installed catalog does not ship — had no home outside package READMEs.

The new page covers both entry points and the relationship between them: the
Models page and `$DSH_HOME/settings.yaml` write one document, over a
`llm-pi-ai` adapter that mounts dormant until that document names routes. It
carries the settings shape, catalog replacement and its capacity fallbacks,
credential references, and the four failures a misconfigured route produces,
and links the generated config catalog for exhaustive fields.

It sits between Quick start and Configuration in the guide sidebar, which is
where a reader hits the question.

2026-08-06 19:21:04 +08:00

1.8 KiB

Raw Blame History

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-harness/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 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 composes apps/cli/config/base.cordis.yml with apps/cli/config/web.cordis.yml and no app bundle. Both select the DeepSeek model and capability plugins appropriate to their entry mode.

Next steps

Model providers — 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