Development¶
Manual installation¶
The dsh plugin flow is the supported way to install the connector. When you build your own composition and manage cordis.yml directly, install the package and its peers by hand instead.
Add the package with your package manager:
The harness packages are peer dependencies. Install them alongside the plugin if they are not already present:
pnpm add @deepseek-ai/cordis @deepseek-ai/dsh-llm @deepseek-ai/dsh-credentials \
@deepseek-ai/dsh-settings @deepseek-ai/dsh-launch-environment @deepseek-ai/dsh-timeout \
@deepseek-ai/dsh-attachment @deepseek-ai/schemastery
Then register the plugin next to the llm capability in your cordis.yml. The dsh plugin path does this for you through the bundle's patch layer. Every field is optional; the defaults target the public Kimi Code endpoint.
Provide the API key as described in Installation.
Setup¶
Common tasks¶
pnpm run typecheck # tsc --noEmit
pnpm run test # vitest run
pnpm run test:watch # vitest in watch mode
pnpm run build # tsdown bundle to lib/
The build emits lib/index.js and lib/index.d.ts.
Automation with drun¶
The repository ships a drun spec at .drun/spec.drun. List the tasks:
| Task | Description |
|---|---|
default |
Show available automation. |
install |
Install dependencies. |
typecheck |
Type-check the sources without emitting. |
test |
Run the unit test suite. |
watch |
Run the tests in watch mode. |
build |
Bundle the plugin into lib/. |
clean |
Remove build output. |
check |
Type-check, test, and build (CI mode). |
Run the full gate before pushing:
Documentation¶
The documentation site is built with Zensical. Preview and build it from the repository root:
Project layout¶
src/connector sources:index.ts(plugin),adapter.ts(LlmAdapter),serialize.ts(wire request),types.ts(wire message shapes).tests/vitest suites mirroring each source module.docs/this documentation.lib/build output (generated).