@ashllll/dsh-open-code-review

Readme

# dsh-open-code-review

A [DeepSeek Harness](https://github.com/deepseek-ai/deepseek-harness) plugin that
brings [Alibaba Open Code Review](https://github.com/alibaba/open-code-review)'s
deterministic review engine to DSH agents.

Open Code Review (OCR) is built on a deliberate split: engineering hard-constrains
what *must not* go wrong — which files are in scope, which rules apply to each —
and a model does the judging. This plugin keeps that split and puts **your DSH
model** on the judging side. OCR's own LLM is never called, so there is no second
provider to configure and **no API key**.

```
ocr_review_scope  →  which changed files are reviewable (deterministic)
ocr_review_rules  →  which review rules apply to those files (deterministic)
       you        →  read the diffs, judge, report with coverage
```

## Requirements

| | |
|---|---|
| `ocr` | **1.9.0 or later** — `--format json` landed in 1.9.0. Verified against 1.12.11 on Windows x64. **Installed with the plugin**; no separate setup step. |
| git | 2.41 or later (OCR reads diffs through git). |
| DSH | Any build with plugin support. Verified on DSH Desktop 0.1.7-rc.2. |

## Install

```sh
dsh plugin --profile web add github:ashllll/dsh-open-code-review
```

A local checkout works too — `dsh plugin --profile web add <abs-path-to-.tgz>`.
Note that pnpm resolves a *relative* tarball path against the current directory,
not the profile, so pass an absolute path.

The unscoped npm name `dsh-open-code-review` belongs to an unrelated project, so
this package is scoped: once published, it installs as
`dsh plugin --profile web add @ashllll/dsh-open-code-review`.

Refresh the page and the tools appear as `ocr_review_scope`, `ocr_review_rules`
and `ocr_health`, and the `open-code-review` skill joins the skill catalog. That
is the whole install: **the `ocr` binary arrives with the plugin.**

### Where `ocr` comes from

The plugin declares `@alibaba-group/open-code-review` as an
`optionalDependency`, so your package manager fetches the native binary as part
of installing the plugin. Upstream ships it in six `os`/`cpu`-gated platform
packages with `preferUnplugged`, which means the right one lands as a real file
on disk, and the launcher's `postinstall` — a download fallback — is never
needed. That matters because the plugin market blocks build scripts by default.

The binary is resolved in this order, and `ocr_health` reports which one won:

| Order | Source | When it is used |
|---|---|---|
| 1 | `ocrPath` | You set it explicitly. |
| 2 | `vendorDir` | A plugin-managed install at `<DSH_HOME>/open-code-review`. |
| 3 | **bundled dependency** | The default: whatever your package manager installed with the plugin. |
| 4 | `PATH` | A machine-wide `npm install -g @alibaba-group/open-code-review`, including by following npm's `ocr.cmd` shim to the native binary beside it. |

Override with `ocrPath` if you want a specific build, or install into `vendorDir`
if you would rather the binary sit outside the profile:

```sh
npm install --prefix "<DSH_HOME>/open-code-review" @alibaba-group/open-code-review
```

`<DSH_HOME>` is the harness data root (`$env:DSH_HOME`; `~/.dsh` by default, and
`%APPDATA%\dsh-desktop\harness` for DSH Desktop).

## What it adds

### Tools

| Tool | Purpose |
|---|---|
| `ocr_review_scope` | Which changed files are reviewable, plus the mode and refs needed to fetch diffs. `commit`, or `from`+`to`, or nothing for workspace changes. |
| `ocr_review_rules` | The review rules OCR resolves for specific paths, grouped so files sharing a rule appear once. Use the rule text as the review checklist. |
| `ocr_health` | Which `ocr` executable was resolved, from where, its version, and whether it is new enough. Also prints the install command when nothing is found. |

### Skill

`open-code-review` carries the full workflow — resolve scope, resolve rules, read
diffs with git, review every file in scope, report with line-level references and
a coverage count. It loads on demand, so the always-present prompt contribution
stays to a few lines.

### A note on the port

Upstream ships this same contract for four other hosts: an
[opencode plugin](https://github.com/alibaba/open-code-review/blob/main/plugins/open-code-review/opencode/open-code-review.ts),
Claude Code and Kimi Code slash commands, and two portable skills. This package is
the DSH-shaped member of that set. Nothing about the OCR engine was reimplemented —
the plugin drives the real `ocr` binary.

## Configuration

The plugin mounts with one patch row and declares three settings:

```yaml
- id: open-code-review
  name: '@ashllll/dsh-open-code-review'
  config:
    vendorDir: !!js dshHomePath('open-code-review')   # default
    ocrPath: ''                                       # explicit binary or install dir; wins over everything
    timeoutMs: 180000                                 # per-invocation ceiling
```

Write overrides into your profile's own `cordis.patch.yml`
(`<DSH_HOME>/profiles/<name>/cordis.patch.yml`). Note that DSH replaces `config`
wholesale rather than merging, so repeat any field you want to keep. To disable
the plugin without uninstalling it:

```yaml
- id: open-code-review
  disabled: true
```

## Scope

Deliberately **not** ported:

- `ocr review` and `ocr scan` — the LLM-driven pipeline. It needs its own provider
  and API key, which is precisely what delegation exists to avoid. If you want it,
  configure OCR's LLM (`ocr config provider`, `ocr config model`) and call the CLI
  through the `pwsh` tool.
- `ocr viewer`, `ocr session *`, `ocr config *` — interactive or stateful surfaces
  with no useful tool-shaped contract.

Custom rules are still fully available: put a `.opencodereview/rule.json` in the
repository and `ocr_review_rules` resolves it automatically, reporting
`source: project`. See
[OCR's rule documentation](https://github.com/alibaba/open-code-review).

## Listing in the Plugin Market

The market browses a curated registry —
[awesome-dsh-plugin](https://github.com/awesome-dsh-plugin/awesome-dsh-plugin) —
so being listed is one YAML file in a PR against that repository, not a change
here. The entry is prepared and ready to submit:

`data/plugins/ashllll__dsh-open-code-review.yml`

```yaml
url: https://github.com/ashllll/dsh-open-code-review
name: ashllll/dsh-open-code-review
category: git
description:
  en: 'Review code with Open Code Review: deterministic scope and rule resolution, judged by your own DSH model, no API key.'
  zh: '用 Open Code Review 评审代码：确定性的范围与规则解析，由你自己的 DSH 模型判断，无需 API Key。'
```

`git` is the registry's "Git & Code Review" category. The description is quoted
because it contains `: `, which YAML would otherwise parse as a nested key.

**The PR is open — [#6343](https://github.com/awesome-dsh-plugin/awesome-dsh-plugin/pull/6343).**
The registry enforces a 24-hour minimum repository age, and this repository was
created on 2026-10-01, so the only failing check is that one. It re-runs by
itself and clears without a resubmission; running the registry's own
`scripts/check-submission.mjs` against this entry reports that single problem and
nothing else. The remaining gates — `dsh.bundle` declared, repo present and not
archived, not DSH itself — pass, and both locales are present.

## Security

- **No network access at call time.** The plugin itself never makes a request.
  The `ocr` binary is fetched by your package manager as part of installing the
  plugin (about 55 MB), not by the plugin while a tool runs. If it is missing,
  the tool fails with the exact command to restore it.
- **No shell.** `ocr` is spawned with `shell: false` from a resolved native
  executable, so model-supplied refs and paths are never interpolated into a
  command line. npm's `.cmd` shim is treated as a signpost to the native binary
  rather than executed, which also skips the launcher's background update check.
- **Delegation is read-only.** `ocr delegate` writes no session files; it prints a
  JSON document to stdout and exits.
- **Sandbox boundary.** The plugin spawns `ocr` as a child process directly, so
  this call does not pass through DSH's shell sandbox or its approval gate the way
  `pwsh` does. It reads the target git repository — file names, statuses, and the
  resolved rule text, never file contents. Point `repo` at something you are
  willing to have inspected, and disable the plugin on profiles where that is not
  acceptable.
- **Bounded.** A 10 MiB output ceiling, a wall-clock timeout, and process-tree
  termination (including `taskkill /T` on Windows) on timeout or cancellation.

## Development

```sh
node test/smoke.mjs
```

32 checks covering argument building, binary resolution across the npm layouts
(bundled dependency, npm shims, vendor directory, `PATH`), delegation JSON
parsing, and frontmatter handling. When an `ocr` binary is
resolvable, it also runs the real thing: `ocr version`, a `delegate preview`
against a throwaway git repository, and a `delegate rule` resolving the Python
ruleset. With no `ocr` present those three are reported as skipped rather than
failing.

## License

Apache-2.0. Derived in part from
[alibaba/open-code-review](https://github.com/alibaba/open-code-review); see
[NOTICE](NOTICE) for exactly what was reused and what changed. Not affiliated with
or endorsed by Alibaba Group.