dsh-llm-volcengine-plans

Readme

# dsh-llm-volcengine-plans

[English](README.md) | [中文](README.zh.md)

A community DeepSeek Harness bundle for Volcengine Ark Agent Plan and Coding Plan.

## Features

- Registers isolated `volcengine-plan/*` and `volcengine-coding/*` routes.
- Publishes per-model context, output, modality, and thinking-level metadata.
- Applies the OpenAI compatibility switches required by the Coding Plan gateway.
- Resolves `ARK_API_KEY` through the DSH credential service on every request, with legacy variable fallbacks.
- Provides a credential form under **Settings → Plugins → Plugin configuration**.
- Supports validated, live-reloadable route, endpoint, header, timeout, retry, and default-reasoning configuration.
- Avoids the unsupported third-party Models editor registration that broke DSH rc.6's Add provider dialog.

## Install

Install from GitHub:

```sh
dsh plugin --profile web add github:lionXiao/dsh-llm-volcengine-plans#v0.3.1
```

Restart DSH, then select a model such as `volcengine-coding/deepseek-v4-flash`. The old `dsh-llm-volcengine` package must not be installed alongside this bundle because both own the same routes.

The package follows DSH's documented bundle manifest and the community `dsh-*` naming convention without using the reserved-looking `@deepseek-ai` scope. Add the `dsh-plugin` GitHub topic when publishing its repository.

## Credentials

The default credential reference is `ARK_API_KEY`, matching Volcengine's tool integration convention. A previously stored DSH credential under that reference is reused; the old plugin and a custom `ark` provider are not runtime dependencies.

After restarting DSH, open **Settings → Plugins → Plugin configuration → Volcengine Plans** to save, replace, or remove the key. The browser receives only its configured state; the secret is stored by DSH in `$DSH_HOME/.credentials.yaml` and is never returned to the form.

![Volcengine Plans credential form](docs/images/plugin-settings.png)

## Models and Thinking Levels

Select a `volcengine-plan/*` or `volcengine-coding/*` model in the model picker. Models whose endpoint supports it expose DSH's native thinking-level selector.

| Model picker | Thinking-level picker |
| --- | --- |
| ![Volcengine model picker](docs/images/model-picker.png) | ![Thinking-level picker](docs/images/thinking-level.png) |

Never commit a real key. DSH can also read it from the launching environment or `$DSH_HOME/.env`:

```dotenv
ARK_API_KEY=your_key
```

## Configuration

See `cordis.patch.yml` for defaults and `README.zh.md` for the complete configuration example and DSH rc.6 UI limitation.

## Verification

```sh
npm test
npm run pack:check
dsh --profile web --dump-config
```

Real endpoint verification requires a user-supplied Volcengine key and is intentionally excluded from automated tests.

## License

MIT