Tianyi Cui
7a11f5fde3
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.
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 default model, or DSH_SYSTEM_PROMPT for the deployment persona. --model overrides the model and passes the same value to the profile-owned adapter catalog; --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 str_replace_editorwithview,create,str_replace, andinsert
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.
This variant is intentionally POSIX-only. Its 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.