mirror of
https://github.com/deepseek-ai/deepseek-harness
synced 2026-08-15 21:04:50 +00:00
5833d70447
# Conflicts: # .agents/notes/implemented/process/2026-07-13-documentation-site-projection.md # docs/AGENTS.md # docs/rfc/INDEX.md # docs/user/develop/basic/index.zh.md # docs/user/develop/basic/tool.zh.md # docs/user/develop/framework/index.zh.md # docs/user/develop/framework/service.zh.md # docs/user/develop/practice/index.zh.md # docs/user/guide/index.zh.md # docs/user/guide/quickstart.zh.md # knip.json # package.json # pnpm-lock.yaml # scripts/doc-typecheck.ts # scripts/gen-website-api.ts # scripts/translation-pairing.manifest.json # scripts/verify-type-equiv.ts # website/zh-CN/api/cordis/context.md # website/zh-CN/api/cordis/events.md # website/zh-CN/api/cordis/fiber.md # website/zh-CN/api/cordis/registry.md # website/zh-CN/api/cordis/service.md # website/zh-CN/api/harness/agent-loop.md # website/zh-CN/api/harness/agents.md # website/zh-CN/api/harness/approval.md # website/zh-CN/api/harness/bash-env.md # website/zh-CN/api/harness/bash.md # website/zh-CN/api/harness/code-runtime.md # website/zh-CN/api/harness/compact.md # website/zh-CN/api/harness/events.md # website/zh-CN/api/harness/fs.md # website/zh-CN/api/harness/llm.md # website/zh-CN/api/harness/permission.md # website/zh-CN/api/harness/sandbox.md # website/zh-CN/api/harness/session-persistence.md # website/zh-CN/api/harness/session-query.md # website/zh-CN/api/harness/sessions.md # website/zh-CN/api/harness/skills.md # website/zh-CN/api/harness/spill-store.md # website/zh-CN/api/harness/subagents.md # website/zh-CN/api/harness/system-prompt.md # website/zh-CN/api/harness/tasks.md # website/zh-CN/api/harness/token-meter.md # website/zh-CN/api/harness/tools.md # website/zh-CN/api/harness/user-interaction.md # website/zh-CN/api/harness/web.md # website/zh-CN/api/harness/workflows.md # website/zh-CN/api/index.md # website/zh-CN/design/effects-coeffects.md # website/zh-CN/design/index.md # website/zh-CN/guide/config.md
100 lines
2.0 KiB
Markdown
100 lines
2.0 KiB
Markdown
# Quick start
|
|
|
|
English | [中文](quickstart.zh.md)
|
|
|
|
This guide gets an agent running in five minutes.
|
|
|
|
## Prerequisites
|
|
|
|
- [Node.js](https://nodejs.org/) ^22.19 or >= 24
|
|
- [pnpm](https://pnpm.io/) 11 (use Corepack to select the repository-pinned version)
|
|
|
|
```sh
|
|
# Check versions
|
|
node -v # v22.19.x, or v24.x and newer
|
|
corepack enable
|
|
pnpm -v # 11.x
|
|
```
|
|
|
|
## Step 1: run echo-agent
|
|
|
|
echo-agent needs no API key and runs after dependencies are installed.
|
|
|
|
```sh
|
|
# Clone the repository
|
|
git clone https://github.com/deepseek-harness/deepseek-harness.git
|
|
cd deepseek-harness
|
|
|
|
# Install dependencies
|
|
pnpm install
|
|
|
|
# Start echo-agent
|
|
pnpm run demo:echo
|
|
```
|
|
|
|
The process prints:
|
|
|
|
```
|
|
echo-agent ready. Type a message ("echo <text>" triggers the tool).
|
|
>
|
|
```
|
|
|
|
Enter:
|
|
|
|
```
|
|
> echo hello world
|
|
```
|
|
|
|
The model issues a tool call, and the echo tool returns the text in uppercase:
|
|
|
|
```
|
|
[tool call] echo({"text":"hello world"})
|
|
[tool result] ECHO: HELLO WORLD
|
|
```
|
|
|
|
Your local environment is ready.
|
|
|
|
## Step 2: use a real model
|
|
|
|
Next, connect a real DeepSeek model and run the complete command-line agent.
|
|
|
|
### Get an API key
|
|
|
|
Get an API key from [DeepSeek Platform](https://platform.deepseek.com/).
|
|
|
|
### Configure the environment
|
|
|
|
Create a gitignored `.env` file in the repository root:
|
|
|
|
```sh
|
|
DEEPSEEK_API_KEY=sk-your-key-here
|
|
```
|
|
|
|
### Start repl-agent
|
|
|
|
```sh
|
|
pnpm run demo:repl
|
|
```
|
|
|
|
```
|
|
agent REPL ready. Give it a coding task.
|
|
>
|
|
```
|
|
|
|
This is a complete coding assistant that can read and write files, run commands, and delegate subtasks.
|
|
|
|
Try a task:
|
|
|
|
```
|
|
> Create hello.js in the current directory, print "Hello from Harness!", and run it
|
|
```
|
|
|
|
## What happened
|
|
|
|
echo-agent and repl-agent use the same application framework (`@deepseek-ai/dsh-stdio-demo`). Their `cordis.yml` files select different plugins and configuration. Custom agents use the same composition model.
|
|
|
|
## Next steps
|
|
|
|
- [Configuration](./config.md) — understand the `cordis.yml` format
|
|
- [Develop a plugin](../develop/basic/) — build your own tool or backend
|