dsh-db-studio 0.0.0-stage → 1.0.2

package/CHANGELOG.md

@@ -0,0 +1,20 @@
+# Changelog
+
+## v1.0.2 — 2026-10-25
+
+- 新增 `/db` 斜杠指令：输入 `/` 后可从指令列表直接打开数据库面板，带数据库图标
+
+## v1.0.1 — 2026-10-24
+
+首个稳定版。
+
+- 左侧栏「数据库」面板：连接管理、表结构浏览、分页数据、SQL 控制台
+- 对话内「数据库」tab：在会话中直接查看和操作已选数据库
+- 输入框旁多选下拉 + 紧凑连接状态条
+- 4 个内置对话工具，按会话选择严格授权
+- SQLite / PostgreSQL / MySQL 支持
+- 中文 / English README、界面演示 GIF、GitHub Actions CI
+
+## v0.2.0
+
+- 首个公开版本：数据库面板、对话数据库 tab、多选、状态条和 agent 工具

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Jianjun Xiao
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.en.md

@@ -0,0 +1,94 @@
+# dsh-db-studio
+
+English ｜ [简体中文](./README.md)
+
+[![test](https://github.com/etShaw-zh/dsh-db-studio/actions/workflows/test.yml/badge.svg)](https://github.com/etShaw-zh/dsh-db-studio/actions/workflows/test.yml)
+[![License](https://img.shields.io/github/license/etShaw-zh/dsh-db-studio)](LICENSE)
+[![release](https://img.shields.io/github/v/release/etShaw-zh/dsh-db-studio)](https://github.com/etShaw-zh/dsh-db-studio/releases)
+[![npm](https://img.shields.io/npm/v/dsh-db-studio)](https://www.npmjs.com/package/dsh-db-studio)
+
+Connect to databases in [DeepSeek Harness](https://github.com/deepseek-ai/deepseek-harness) (DSH), then query and edit data right in the conversation.
+
+![Querying the demo database in a conversation](docs/demo.gif)
+
+## What it does
+
+### Browse and manage databases
+
+- **Database panel in the sidebar**: browse connections, schemas and paginated data, and run SQL.
+- **SQLite / PostgreSQL / MySQL**, with SQLite requiring no extra driver.
+
+### Work in the conversation
+
+- **Database tab in a conversation**: view and work with the selected databases without leaving the chat.
+- **Multi-select picker in the composer**: choose the databases this conversation may use.
+- **Talk to the data**: four agent tools for querying, creating tables and writing data.
+- **`/db` command**: type `/`, pick **Database** from the command list, and open the database panel.
+
+## Install
+
+From npm:
+
+```bash
+# macOS desktop
+DSH_CLI="/Applications/DeepSeek Harness.app/Contents/Resources/runtime/cli/bin/dsh"
+"$DSH_CLI" plugin --profile desktop add dsh-db-studio@1.0.2
+```
+
+Or install directly from GitHub:
+
+```bash
+"$DSH_CLI" plugin --profile desktop add github:etShaw-zh/dsh-db-studio
+```
+
+Restart DeepSeek Harness afterwards. Stable builds are listed in [Releases](https://github.com/etShaw-zh/dsh-db-studio/releases). On Windows / Linux use the `dsh` path installed on your machine.
+
+From source:
+
+```bash
+git clone https://github.com/etShaw-zh/dsh-db-studio.git
+"$DSH_CLI" plugin --profile desktop add "$PWD/dsh-db-studio"
+```
+
+## Getting started
+
+1. Open **Database** in the sidebar and create a connection, or use the built-in demo database.
+2. Select the databases for the conversation, then ask the assistant to work with them:
+
+> Show me the 10 most recent orders in the demo database, sorted by amount.
+>
+> Change every Hangzhou user's city to “Hangzhou · West Lake”.
+>
+> Add a notes field to the orders table.
+
+The assistant can only access databases selected for the conversation; if none are selected, it asks you to choose one first.
+
+## Configuration
+
+Set these in the profile's `cordis.patch.yml`:
+
+| Key | Default | Meaning |
+| --- | --- | --- |
+| `demo` | `true` | Create a demo database when there are no connections |
+| `allowWrite` | `true` | Allow write operations |
+| `agentTools` | `true` | Register the conversation tools |
+| `maxRows` | `200` | Maximum rows returned by a query |
+
+## Data and security
+
+- Connections live in `~/.dsh/dsh-db-studio/connections.json` with file mode `0600`.
+- Passwords stay on this machine and never reach the browser or the model context.
+- For production databases, use a read-only account or connection, or set `allowWrite: false`.
+
+## Development
+
+```bash
+npm install
+npm test
+```
+
+Issues and PRs are welcome: <https://github.com/etShaw-zh/dsh-db-studio>
+
+## License
+
+MIT

package/README.md

@@ -1,3 +1,92 @@
-# Temporary Holding Version
+# dsh-db-studio
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+简体中文 ｜ [English](./README.en.md)
+
+[![test](https://github.com/etShaw-zh/dsh-db-studio/actions/workflows/test.yml/badge.svg)](https://github.com/etShaw-zh/dsh-db-studio/actions/workflows/test.yml)
+[![License](https://img.shields.io/github/license/etShaw-zh/dsh-db-studio)](LICENSE)
+[![release](https://img.shields.io/github/v/release/etShaw-zh/dsh-db-studio)](https://github.com/etShaw-zh/dsh-db-studio/releases)
+[![npm](https://img.shields.io/npm/v/dsh-db-studio)](https://www.npmjs.com/package/dsh-db-studio)
+
+在 [DeepSeek Harness](https://github.com/deepseek-ai/deepseek-harness)（DSH）里连接数据库，直接在对话中查数据、改数据。
+
+![在对话中查询示例数据库](docs/demo.gif)
+
+## 能做什么
+
+### 浏览和管理数据库
+- **左侧栏「数据库」面板**：浏览连接、表结构、分页数据，执行 SQL。
+- **支持 SQLite / PostgreSQL / MySQL**，SQLite 无需额外安装驱动。
+
+### 在对话里直接用
+- **对话内「数据库」标签**：在当前对话里直接查看和操作已选数据库。
+- **输入框旁多选下拉**：选择本次对话要使用的数据库，支持多选。
+- **对话中直接操作**：内置 4 个助手工具，可以帮你查询、建表、写数据。
+- **`/db` 指令**：输入 `/`，在指令列表里选择「数据库」，直接打开数据库面板。
+
+## 安装
+
+从 npm 安装：
+
+```bash
+# macOS 桌面端
+DSH_CLI="/Applications/DeepSeek Harness.app/Contents/Resources/runtime/cli/bin/dsh"
+"$DSH_CLI" plugin --profile desktop add dsh-db-studio@1.0.2
+```
+
+也可以直接从 GitHub 安装：
+
+```bash
+"$DSH_CLI" plugin --profile desktop add github:etShaw-zh/dsh-db-studio
+```
+
+安装后**重启 DeepSeek Harness**。稳定版见 [Releases](https://github.com/etShaw-zh/dsh-db-studio/releases)。Windows / Linux 使用本机对应的 `dsh` 路径即可。
+
+从源码安装：
+
+```bash
+git clone https://github.com/etShaw-zh/dsh-db-studio.git
+"$DSH_CLI" plugin --profile desktop add "$PWD/dsh-db-studio"
+```
+
+## 开始使用
+
+1. 左侧栏点击「数据库」，新建连接，或使用内置示例数据库。
+2. 在对话框里选中要用的数据库；也可以直接在对话里让助手操作：
+
+> 查一下示例数据库里最近 10 笔订单，按金额排序
+>
+> 把 users 表里杭州的用户城市改成「杭州·西湖区」
+>
+> 给 orders 表加一个备注字段
+
+助手只能访问当前对话选中的数据库；没选数据库时会先提示你选择。
+
+## 配置
+
+插件配置写在 profile 的 `cordis.patch.yml`，常用项：
+
+| 配置 | 默认 | 说明 |
+| --- | --- | --- |
+| `demo` | `true` | 没有连接时自动创建示例数据库 |
+| `allowWrite` | `true` | 是否允许写操作 |
+| `agentTools` | `true` | 是否注册对话工具 |
+| `maxRows` | `200` | 查询最多返回行数 |
+
+## 数据与安全
+
+- 连接信息保存在 `~/.dsh/dsh-db-studio/connections.json`，文件权限为 `0600`。
+- 密码只保存在本机，不会发送到浏览器或模型上下文。
+- 生产库建议使用只读账号、只读连接，或设置 `allowWrite: false`。
+
+## 开发
+
+```bash
+npm install
+npm test
+```
+
+欢迎提交 Issue 或 PR：<https://github.com/etShaw-zh/dsh-db-studio>
+
+## License
+
+MIT

package/cordis.patch.yml

@@ -0,0 +1,11 @@
+# dsh-db-studio bundle patch.
+#
+# `dsh plugin --profile <name> add dsh-db-studio` reads this file and appends the
+# row below to the profile's bundle stack. The `name` is the npm package name,
+# so Node module resolution finds the installed package.
+- insert:
+    - id: db-studio
+      name: dsh-db-studio
+      config:
+        demo: true
+        allowWrite: true