Files
deepseek-harness/examples/python-sdk-agent/README.zh.md
T
Tianyi Cui 7a11f5fde3 docs(python): define the standalone minimal profile
Record sdk-minimal as the narrow repository-owned exception to base-first profile composition: callers still launch only dsh and cannot provide an arbitrary Cordis tree, while the shipped bundle may own a complete explicit roster. Cross-link the launcher, profile-bundle, Python-runtime, minimal-agent, snapshot, and telemetry decisions; the supersession audit keeps each older note active because its remaining rationale is independent.

Update the CLI, architecture, Python tutorial/reference, example, runtime-wheel reference, and bundle documentation. The docs distinguish the full sdk profile from sdk-minimal, explain explicit-home/plugin/patch customization, state the minimal permission and persistence choices, and retain the separately packaged web profile and frontend assets for direct dsh use.

Correct dsh-base descriptions to cover base-backed profiles, make SDK startup configuration visible in the generated config catalog, add sdk-minimal to the module graph, and regenerate the base-composition graph. English and Chinese pairs are re-recorded at the exact reviewed contents.
2026-08-24 17:28:29 +08:00

2.8 KiB
Raw Blame History

python-sdk-agent

English | 中文

基于唯一应用启动器 dsh --profile sdk-minimal 的可运行 Python SDK 示例。Python 客户端负责 JSON-RPC stdioprofile 负责 agent 组合、持久化、执行策略与插件。

运行极简 agent

安装 deepseek-harness-sdk、导出模型凭据,然后提供隔离的 Harness home 与 workspace

export DEEPSEEK_API_KEY=sk-your-key-here
python examples/python-sdk-agent/minimal.py \
  --dsh-home /absolute/path/to/example-dsh-home \
  --workspace /absolute/path/to/disposable-workspace \
  --session-id example-001 \
  "Inspect the repository and fix the failing tests."

兼容代理使用 DEEPSEEK_BASE_URL,默认模型使用 DSH_MODELdeployment persona 使用 DSH_SYSTEM_PROMPT--model 会覆盖模型,并将同一值传给 profile 自有的适配器目录;--profile 可以选择另一个提供 SDK 服务的 profile。所选 home 保存生成的 sdk-minimal profile,并在 sessions/ 下保存未压缩 JSONL 会话日志;脚本绝不会隐式读取 ~/.dsh

随附的 @deepseek-ai/dsh-sdk-minimal 组合包是该模式完整且显式的 Cordis 配置树。它只暴露:

  • agent 所有的持久 bash
  • 支持 viewcreatestr_replaceinsertstr_replace_editor

该组合包不包含 dsh-base,因此每一个新增配置项都是显式 profile 变更。运行时上下文、本地指令发现、compaction、settings、托管凭据、遥测、Web 工具、subagent 与完整默认工具清单均不存在。配置树保留 SDK 启动与 JSON-RPC 服务、一个由环境配置的 DeepSeek 适配器、本地执行和 JSONL 持久化。

此变体刻意只支持 POSIX。其持久 PTY 与 editor 可以修改运行时进程可访问的任何路径,因此只应在一次性 checkout 或容器中使用。

添加插件

对同一个显式 home 使用运行时 wheel 提供的 dsh 命令,以进行持久 profile 变更:

export DSH_HOME=/absolute/path/to/example-dsh-home
dsh plugin --profile sdk-minimal add file:/absolute/path/to/my-plugin-bundle

在该命令中使用 sdk-minimal 可扩展本示例,使用 sdk 则扩展基于完整 base 的 SDK profile。Python 调用也可以在 patches=(...) 中传入更多绝对 patch 路径;后面的文件优先。所选 profile 必须保留 @deepseek-ai/dsh-sdk-app 或另一个 JSON-RPC server 配置项。该示例不接受完整 Cordis 文件或任意进程 argv。

同一个运行时 wheel 还为直接 CLI 使用打包 web profile 及其前端产物:dsh web 会启动这个独立应用。Python SDK client 不能选择 web,因为其中没有 JSON-RPC server 配置项。

另见 Python SDK 教程SDK 参考