Introduction¶
In the DSH plugin scenario, architectural descriptions, process descriptions, and sequence descriptions often need to be organized from the code repository and handed over to the team for viewing and sharing. dsh-archify provides an agent skill: generating architecture diagrams, flowcharts, sequence diagrams, data flow diagrams, and lifecycle diagrams using JSON specifications, and outputting a standalone HTML.
Its approach is to first create a specification file, then perform validation and delivery. Below is an introduction to its features, installation methods, typical usage, and considerations.
This plugin is maintained by GongYuanCaiJi and is licensed under MIT. It is ported from tt-a1i/archify v2.14.0; the official DSH package @tt-a1i/archify-dsh@0.1.0 shares the same source and version. The core skill files archify/ and examples/ are preserved verbatim, only adapted for DSH’s packaging and naming.
Positioning¶
- Input: JSON specifications, where one JSON specification corresponds to one type of diagram.
- Output: Standalone HTML, also supports PNG, SVG, WebM, and 1200×630 sharing cards.
- Acceptance: Run
validatebefore submission; deterministic validation provides 9 acceptance criteria (showcase) or basic acceptance (standard). - Theme: Supports light and dark themes; visual presets include
classic(default),signal-flow,blueprint, andeditorial.
Core Features¶
Five diagram types:
architecture
workflow
sequence
dataflow
lifecycle
Each JSON specification corresponds to one of these diagram types.
Verifiable delivery:
validate
showcase: 9 项验收
standard: 基础验收
Run validate before submission to use deterministic validation for acceptance results.
Multi-format export:
HTML
PNG
SVG
WebM
1200×630 分享卡片
Mermaid input:
flowchart
sequenceDiagram
stateDiagram
After pasting Mermaid content, it can be converted to Archify JSON and then beautified.
Architecture comparison:
compare
Before / Delta / After
Use compare on two snapshots to output a three-state HTML of Before / Delta / After.
Installation and Activation¶
First, confirm the environment requirements:
Node.js: ^22.19.0 || >=24.0.0
dsh: 0.1.0-rc.6
After confirming the environment, install from GitHub:
dsh plugin --profile <你的 profile> add github:GongYuanCaiJi/dsh-archify
During installation, the prepare script temporarily stages archify/ as skills/. If pnpm blocks the build step, add this package to allowBuilds in the profile’s pnpm-workspace.yaml and run it again:
pnpm-workspace.yaml -> allowBuilds 中加入 dsh-archify
When installing from a local directory, clone it first, install dependencies, and then let dsh add it:
git clone https://github.com/GongYuanCaiJi/dsh-archify.git
cd dsh-archify && npm install
dsh plugin --profile <你的 profile> add ../dsh-archify
Here, npm install is used to trigger the prepare script to temporarily store skill files in skills/.
Typical Usage¶
Instruct the agent to load the skill by name:
Use the archify skill to map this repository's runtime architecture.
If you want more complete delivery requirements, you can provide this prompt:
Show 8–12 core components, one primary path, external dependencies, and trust boundaries.
Put supporting detail in cards instead of adding more edges.
After delivery, return the exact workspace paths of the specification JSON and the HTML artifact.
An example workflow is to first write runtime.architecture.json, then perform validation and delivery:
node bin/archify.mjs validate architecture runtime.architecture.json --quality showcase
node bin/archify.mjs deliver architecture runtime.architecture.json runtime.html --quality showcase
After the above steps, deliver runtime.html.
Note on Opening Artifacts¶
Files generated by shell commands will not automatically appear in the Produced Files section on the web interface.
You need to ask the agent to return the exact workspace paths of the specification JSON and the HTML artifact, then open them from the workspace. This is the same for the upstream official DSH package.
Security and Licensing¶
Security posture:
- No telemetry
- No network client
- No credential handling
- No background service
- No
install/postinstall/preinstalllifecycle hooks; onlyprepareis used to temporarily store skill files
The license is MIT.
The copyright of the upstream tt-a1i/archify is:
Copyright (c) 2026 tt-a1i (Archify)
Copyright (c) 2025 Cocoon AI
The copyright of this port is:
Copyright (c) 2026 GongYuanCaiJi (dsh port)
The plugin runs with the current DSH process permissions. You should check the source code and license before installation.
Package Information and Testing Limitations¶
Package information is as follows:
version: 0.1.0
type: module
main: ./lib/index.js
engines.node: ^22.19.0 || >=24.0.0
dsh.bundle.patch: ./cordis.patch.yml
Testing limitations: scripts/run-skill-tests.mjs will skip 19 skill tests that cannot run in the ported repository, including:
- 18 tests bound to the upstream repository’s root directory website/release files
- 1 test
generate-validators.test.mjsthat depends on theajvdevDependency
Uninstallation¶
Uninstallation command:
dsh plugin --profile <你的 profile> remove dsh-archify
Links¶
GitHub repository:
https://github.com/GongYuanCaiJi/dsh-archify
If you need to find it from the directory page, search for:
dsh-archify