docs: install from this fork instead of the upstream repository
The published fork now carries the bundle, so the installation and uninstallation snippets point at newbieQQ/dsh-better-workspace-group and the dependency name it installs as (workspace-groups-local).
This commit is contained in:
parent
63c193bca1
commit
47227d33c2
10
README.md
10
README.md
|
|
@ -162,14 +162,14 @@
|
||||||
> installed (`dsh` available) with a target profile initialized (e.g. the built-in `web`).
|
> installed (`dsh` available) with a target profile initialized (e.g. the built-in `web`).
|
||||||
|
|
||||||
```sh
|
```sh
|
||||||
dsh plugin --profile web add github:z-col/dsh-workspace-groups
|
dsh plugin --profile web add github:newbieQQ/dsh-better-workspace-group
|
||||||
```
|
```
|
||||||
|
|
||||||
This automatically:
|
This automatically:
|
||||||
|
|
||||||
1. Adds `"dsh-workspace-groups": "github:z-col/dsh-workspace-groups"` (pinned to
|
1. Adds `"workspace-groups-local": "github:newbieQQ/dsh-better-workspace-group"` (pinned to
|
||||||
version/commit) to `dependencies` in `~/.dsh/profiles/web/package.json`
|
version/commit) to `dependencies` in `~/.dsh/profiles/web/package.json`
|
||||||
2. Appends `"dsh-workspace-groups"` to `dsh.profile.bundles`
|
2. Appends `"workspace-groups-local"` to `dsh.profile.bundles`
|
||||||
3. Runs pnpm install and validates the bundle layer
|
3. Runs pnpm install and validates the bundle layer
|
||||||
|
|
||||||
**Restart the web profile after installing** (both the bundle and the host half only load
|
**Restart the web profile after installing** (both the bundle and the host half only load
|
||||||
|
|
@ -184,7 +184,7 @@ Verify the install:
|
||||||
|
|
||||||
```sh
|
```sh
|
||||||
dsh --profile web --dump-config | grep -A3 workspace-groups
|
dsh --profile web --dump-config | grep -A3 workspace-groups
|
||||||
# expect: - id: workspace-groups / name: dsh-workspace-groups / config: {}
|
# expect: - id: workspace-groups / name: workspace-groups-local / config: {}
|
||||||
curl http://127.0.0.1:3080/workspace-groups/config
|
curl http://127.0.0.1:3080/workspace-groups/config
|
||||||
# expect: the sidecar YAML parsed as JSON
|
# expect: the sidecar YAML parsed as JSON
|
||||||
```
|
```
|
||||||
|
|
@ -192,7 +192,7 @@ curl http://127.0.0.1:3080/workspace-groups/config
|
||||||
## Uninstall
|
## Uninstall
|
||||||
|
|
||||||
```sh
|
```sh
|
||||||
dsh plugin --profile web remove dsh-workspace-groups
|
dsh plugin --profile web remove workspace-groups-local
|
||||||
```
|
```
|
||||||
|
|
||||||
This removes the dependency from `dependencies` and the matching line from
|
This removes the dependency from `dependencies` and the matching line from
|
||||||
|
|
|
||||||
14
README_ZH.md
14
README_ZH.md
|
|
@ -134,14 +134,14 @@ DeepSeek峰谷小组件 等)归入一个「DSH 插件」分类文件夹,点
|
||||||
> (`dsh` 命令可用),并已初始化好目标 profile(如内置 `web`)。
|
> (`dsh` 命令可用),并已初始化好目标 profile(如内置 `web`)。
|
||||||
|
|
||||||
```sh
|
```sh
|
||||||
dsh plugin --profile web add github:z-col/dsh-workspace-groups
|
dsh plugin --profile web add github:newbieQQ/dsh-better-workspace-group
|
||||||
```
|
```
|
||||||
|
|
||||||
这会自动:
|
这会自动:
|
||||||
|
|
||||||
1. 在 `~/.dsh/profiles/web/package.json` 的 `dependencies` 加入
|
1. 在 `~/.dsh/profiles/web/package.json` 的 `dependencies` 加入
|
||||||
`"dsh-workspace-groups": "github:z-col/dsh-workspace-groups"`(含版本/commit)
|
`"workspace-groups-local": "github:newbieQQ/dsh-better-workspace-group"`(含版本/commit)
|
||||||
2. 在 `dsh.profile.bundles` 末尾追加 `"dsh-workspace-groups"`
|
2. 在 `dsh.profile.bundles` 末尾追加 `"workspace-groups-local"`
|
||||||
3. 运行 pnpm 安装并校验 bundle 层
|
3. 运行 pnpm 安装并校验 bundle 层
|
||||||
|
|
||||||
**安装后重启 web profile**(bundle 与 host 半只有在重启后才会被加载):
|
**安装后重启 web profile**(bundle 与 host 半只有在重启后才会被加载):
|
||||||
|
|
@ -155,7 +155,7 @@ dsh web
|
||||||
|
|
||||||
```sh
|
```sh
|
||||||
dsh --profile web --dump-config | grep -A3 workspace-groups
|
dsh --profile web --dump-config | grep -A3 workspace-groups
|
||||||
# 应出现 - id: workspace-groups / name: dsh-workspace-groups / config: {}
|
# 应出现 - id: workspace-groups / name: workspace-groups-local / config: {}
|
||||||
curl http://127.0.0.1:3080/workspace-groups/config
|
curl http://127.0.0.1:3080/workspace-groups/config
|
||||||
# 应返回 sidecar YAML 解析后的 JSON
|
# 应返回 sidecar YAML 解析后的 JSON
|
||||||
```
|
```
|
||||||
|
|
@ -163,15 +163,15 @@ curl http://127.0.0.1:3080/workspace-groups/config
|
||||||
## 卸载
|
## 卸载
|
||||||
|
|
||||||
```sh
|
```sh
|
||||||
dsh plugin --profile web remove dsh-workspace-groups
|
dsh plugin --profile web remove workspace-groups-local
|
||||||
```
|
```
|
||||||
|
|
||||||
这会自动从 `dependencies` 删除该依赖并从 `dsh.profile.bundles` 移除对应行。
|
这会自动从 `dependencies` 删除该依赖并从 `dsh.profile.bundles` 移除对应行。
|
||||||
同样需要**重启 web profile** 后生效。
|
同样需要**重启 web profile** 后生效。
|
||||||
|
|
||||||
> 手动等价做法(任选其一,不要重复):编辑 `~/.dsh/profiles/web/package.json`,
|
> 手动等价做法(任选其一,不要重复):编辑 `~/.dsh/profiles/web/package.json`,
|
||||||
> 从 `dependencies` 删除 `dsh-workspace-groups` 行、从 `dsh.profile.bundles`
|
> 从 `dependencies` 删除 `workspace-groups-local` 行、从 `dsh.profile.bundles`
|
||||||
> 删除 `"dsh-workspace-groups"`,然后在该目录 `pnpm install`。
|
> 删除 `"workspace-groups-local"`,然后在该目录 `pnpm install`。
|
||||||
|
|
||||||
## 分类配置(sidecar)
|
## 分类配置(sidecar)
|
||||||
|
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue