Files
deepseek-harness/examples/python-sdk-agent/README.md
T
Tianyi Cui 28442337cf feat(python-example): select the persistent shell by platform
Make the checked-in minimal SDK overlay disable both one-shot shell rows and mount exactly one persistent PTY stack: Bash on Linux/macOS and PowerShell on Windows. The SDK server, explicit dsh home, persistence, editor, timeout, and reduced tool catalog remain unchanged.

Update the runnable example and tutorial to list Windows x64 as supported, describe the platform-selected shell, and remove the obsolete POSIX-only restriction. This keeps the documented first Python task executable through the packaged Windows dsh profile instead of advertising a Linux-only overlay on a Windows-capable SDK.
2026-08-24 19:09:40 +08:00

2.9 KiB

python-sdk-agent

English | 中文

Runnable Python SDK example over the sole application launcher, dsh --profile sdk-minimal. The Python client owns JSON-RPC stdio; the profile owns the agent composition, persistence, execution policy, and plugins.

Run the minimal agent

Install deepseek-harness-sdk, export a model credential, then supply an isolated Harness home and 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."

Set DEEPSEEK_BASE_URL for a compatible proxy, DSH_MODEL for the script's default model, or DSH_SYSTEM_PROMPT for the deployment persona. --model is the single runtime model selection; no matching environment variable is required. --profile can select another SDK-serving profile. The selected home stores the generated sdk-minimal profile and uncompressed JSONL session logs under sessions/; the script never reads ~/.dsh implicitly.

The shipped @deepseek-ai/dsh-sdk-minimal bundle is the complete explicit Cordis tree for this mode. It exposes exactly:

  • owner-scoped persistent bash on Linux/macOS or pwsh on Windows
  • str_replace_editor with view, create, str_replace, and insert

The bundle does not include dsh-base, so every additional row is an explicit profile change. Runtime context, local instruction discovery, compaction, settings, managed credentials, telemetry, Web tools, subagents, and the full default tool roster are absent. The tree retains SDK startup and JSON-RPC serving, one environment-configured DeepSeek adapter, local execution, and JSONL persistence.

The persistent PTY and editor can modify any path available to the runtime process, so use a disposable checkout or container.

Add plugins

Use the runtime wheel's dsh command against the same explicit home for persistent profile changes:

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

Use sdk-minimal in that command to extend this example, or sdk to extend the full base-backed SDK profile. The Python call can also pass additional absolute patch paths in patches=(...); later files win. A selected profile must retain @deepseek-ai/dsh-sdk-app or another JSON-RPC server row. The example accepts no complete Cordis file or arbitrary process argv.

The same runtime wheel packages the web profile and its frontend assets for direct CLI use: dsh web starts that separate application. A Python SDK client cannot select web because it has no JSON-RPC server row.

See the Python SDK tutorial and SDK reference.