@klarkxy/dsh-magpie 0.0.0-stage → 0.1.0

package/LICENSE

@@ -0,0 +1,42 @@
+            The Star And Thank Author License (SATA)
+                  Version 2.1, September 2026
+
+Copyright © 2026 Klarkxy(278370456@qq.com)
+
+Project Url: https://github.com/klarkxy/dsh-editor
+             https://github.com/klarkxy/sata-license
+             https://github.com/klarkxy/dsh-plugins
+
+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.
+
+And wait, one more thing — an invitation, not a condition: it would be best if
+you star/+1/like the project(s) in the project url section above, and thank the
+author(s) in the Copyright section. You may, and arguably you should — but the
+permissions above hold either way, star or no star.
+
+Here are some suggested ways:
+
+ - Email the authors a thank-you letter, and make friends with him/her/them.
+ - Report bugs or issues.
+ - Tell friends what a wonderful project this is.
+ - And, sure, you can just express thanks in your mind without telling the world.
+
+Contributors of this project by forking have the option to add his/her name and
+forked project url at copyright and project url sections, but shall not delete
+or modify anything else in these two sections.
+
+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.md

@@ -1,3 +1,36 @@
-# Temporary Holding Version
+# Magpie
 
-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.
+<!-- release-state-note -->
+
+[简体中文](docs/README.zh-CN.md)
+
+Connects DSH to a [magpie](https://usemagpie.ai) gateway running on this computer, your local network, or elsewhere. From the plugin's settings page you point DSH at the gateway, and it fetches the gateway's model list and writes the same provider routes that `magpie dsh` writes — Magpie, Magpie · Responses, and Magpie · Anthropic — plus the default model and web search, so the models show up in the model picker.
+
+## Install
+
+```bash
+dsh plugin --profile <name> add @klarkxy/dsh-magpie
+```
+
+Replace `<name>` with your profile name and restart the profile.
+
+## Use
+
+- Open **Plugins → Magpie**. Enter the gateway address (the local default is `http://127.0.0.1:3425`), paste the gateway key if the gateway requires one, and choose **Save**, then **Sync now**.
+- **Test** checks the connection without changing anything.
+- Choose a **default model** for new conversations, and turn on **web search** to run it through the gateway's model.
+- **Sync at startup** refreshes the routes once per profile start.
+- **Disconnect** removes the magpie routes and reverts the default model and web search; your saved key is kept.
+
+## Limits
+
+- One gateway at a time. The routes are the same ones `magpie dsh` writes, so either tool replaces the other's setup.
+- A gateway on another machine needs **Share on local network** turned on in magpie and a gateway key (`magpie gateway-key add <name>`).
+- The models shown follow magpie's model list for DSH.
+- The default model applies to new conversations; existing sessions keep their model.
+- Web search goes through the gateway's model.
+- On hosts without a credential store (for example headless), the gateway key is read from the `MAGPIE_GATEWAY_KEY` environment variable.
+
+## License
+
+[SATA License 2.1](LICENSE)

package/cordis.patch.yml

@@ -0,0 +1,5 @@
+# Enabled when installed. Adds a Magpie gateway connection and its settings page.
+- insert:
+    - id: magpie
+      name: '@klarkxy/dsh-magpie'
+      disabled: false

package/docs/README.zh-CN.md

@@ -0,0 +1,36 @@
+# Magpie
+
+<!-- release-state-note -->
+
+[English](../README.md)
+
+把 DSH 连接到本机、局域网或其他位置的 [magpie](https://usemagpie.ai) 网关。在插件设置页填写网关地址后，插件会拉取网关的模型列表，写入与 `magpie dsh` 相同的供应商路由——Magpie、Magpie · Responses、Magpie · Anthropic——并同步默认模型和网络搜索，模型随即出现在模型选择器中。
+
+## 安装
+
+```bash
+dsh plugin --profile <name> add @klarkxy/dsh-magpie
+```
+
+把 `<name>` 换成你的 profile 名，安装后重启 profile。
+
+## 使用
+
+- 打开「插件 → Magpie」。填写网关地址（本机默认 `http://127.0.0.1:3425`），网关要求时粘贴网关 Key，点「保存」，再点「立即同步」。
+- 「测试」只检查连接，不改动任何配置。
+- 可选一个**默认模型**用于新会话；打开**网络搜索**可用网关模型执行搜索。
+- 「启动时同步」会在每次启动 profile 时刷新一次路由。
+- 「断开连接」移除三条 magpie 路由并还原默认模型与网络搜索；已保存的 Key 保留。
+
+## 限制
+
+- 同时只接一个网关。路由与 `magpie dsh` 写出的相同，两者可互相替换配置。
+- 其他机器上的网关需要在 magpie 中打开 Share on local network，并创建网关 Key（`magpie gateway-key add <name>`）。
+- 可用模型以 magpie 提供给 DSH 的列表为准。
+- 默认模型作用于新会话；已有会话保持当前模型。
+- 网络搜索经由网关的模型执行。
+- 没有凭据存储的宿主（如 headless）从 `MAGPIE_GATEWAY_KEY` 环境变量读取网关 Key。
+
+## 许可证
+
+[SATA License 2.1](../LICENSE)

package/icon.svg

@@ -0,0 +1,17 @@
+<svg xmlns="http://www.w3.org/2000/svg" width="36" height="36" viewBox="0 0 36 36" fill="none">
+  <defs>
+    <linearGradient id="mgp-body" x1="11" y1="5" x2="28" y2="25" gradientUnits="userSpaceOnUse">
+      <stop stop-color="#4D75F5"/>
+      <stop offset="1" stop-color="#8EB6FF"/>
+    </linearGradient>
+  </defs>
+  <g transform="translate(3.6 3.6) scale(.8)">
+  <path d="M14.5 20.5L4.5 31L8.5 31.6L17 23.5Z" fill="#39ABA9"/>
+  <path d="M11 19C11 13 15.5 9 21 9C25.5 9 28 11.5 28 14.5C28 20 23.5 25 17 25C13.5 25 11 22.5 11 19Z" fill="url(#mgp-body)"/>
+  <circle cx="24.5" cy="9" r="4.2" fill="#4D75F5"/>
+  <path d="M28.4 7.9L32 9.2L28.5 10.6Z" fill="#39ABA9"/>
+  <circle cx="25.6" cy="8.3" r=".9" fill="#E0EBFF"/>
+  <path d="M17 15.5C19.5 14 23 14.2 25 15.8C23.2 19.8 19.6 21.6 16.2 21.2C15.4 19 15.7 17 17 15.5Z" fill="#E0EBFF" fill-opacity=".9"/>
+  <path d="M19 25V28.5M22.5 24.2V28.5M14 28.5H31" stroke="#6392FF" stroke-width="1.8" stroke-linecap="round"/>
+  </g>
+</svg>