Skip to content

Commit 8705bb2

Browse files
committed
docs: document remote workspace
1 parent aa10c57 commit 8705bb2

8 files changed

Lines changed: 168 additions & 14 deletions

File tree

README.md

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,7 @@ Skills-Manager-Plus addresses this with a central library, preset-based switchin
3838
- **Skills Store** — Install from marketplace sources, Git repositories, local scans, ClawHub, and plugin markets.
3939
- **Presets** — Keep separate skill sets for different workflows, clients, or projects, then switch between them quickly without implicitly applying changes to disk.
4040
- **Global Workspace** — Inspect each installed agent's global local skills, compare them with the Skills Center, and run preset-driven bulk sync actions.
41+
- **Remote Workspace** — Connect to SSH hosts, discover remote agent global Skills, and safely install, update, or delete remote Skills with backups.
4142
- **Project Workspaces** — Compare project-local skills against the central library and move changes in either direction.
4243
- **Per-agent sync** — Sync with symlink or copy mode, including independent sync mode for custom agents.
4344
- **Git backup** — Create snapshot-based history for backup, recovery, and multi-machine sync.
@@ -85,6 +86,7 @@ The current app is organized around these modules:
8586
- `Skills Store`
8687
- `Presets`
8788
- `Global Workspace`
89+
- `Remote Workspace`
8890
- `Project Workspaces`
8991
- `Settings`
9092

@@ -97,6 +99,7 @@ Detailed usage guides for each module live in [docs/usage/README.md](./docs/usag
9799
- [Skills Store](./docs/usage/skills-store.md)
98100
- [Skills Management](./docs/usage/skills-management.md)
99101
- [Presets](./docs/usage/presets.md)
102+
- [Remote Workspace](./docs/usage/remote-workspace.md)
100103
- [Project Workspaces](./docs/usage/project-workspaces.md)
101104
- [Settings](./docs/usage/settings.md)
102105
- [Git Backup](./docs/usage/git-backup.md)
@@ -114,9 +117,10 @@ You can also add custom tools in `Settings`.
114117
2. Open `Skills Store` to import skills from marketplace, Git, local folders, ClawHub, or plugins.
115118
3. Open `Skills Management` to decide which skills belong to the current preset.
116119
4. Open `Global Workspace` when you want to inspect agent-global local skills or apply a preset to a specific agent in bulk.
117-
5. Use `Project Workspaces` if you need to compare or exchange project-local skills.
118-
6. Configure `Git Backup` if you want history, restore points, or multi-machine sync.
119-
7. Use `skills-manager-plus-cli` for automation or recovery tasks that should share the desktop app's repository and preset state.
120+
5. Use `Remote Workspace` when you need to manage agent-global Skills on SSH hosts without local/remote sync.
121+
6. Use `Project Workspaces` if you need to compare or exchange project-local skills.
122+
7. Configure `Git Backup` if you want history, restore points, or multi-machine sync.
123+
8. Use `skills-manager-plus-cli` for automation or recovery tasks that should share the desktop app's repository and preset state.
120124

121125
The repository also includes `skills/manage-skills/SKILL.md`, an optional Agent Skill that teaches compatible agents to call `skills-manager-plus-cli` instead of writing directly into one agent-specific skills directory.
122126

README.zh-CN.md

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,7 @@ Skills-Manager-Plus 通过中央库、预设切换、全局工作区、项目工
3838
- **技能商店** — 从市场、Git、本地扫描、ClawHub 和插件市场安装 Skills。
3939
- **预设管理** — 为不同工作流、客户或项目维护不同的技能组合,并把“浏览预设”和“应用到磁盘”分离。
4040
- **全局工作区** — 查看每个已安装 Agent 的全局本地技能、对比 Skills 中心,并按 Agent 执行基于预设的批量同步。
41+
- **远程工作区** — 连接 SSH 主机,发现远程 Agent 全局 Skills,并在备份保护下安装、更新或删除远程 Skills。
4142
- **项目工作区** — 将项目本地 Skills 与中央库进行对比,并支持双向导入导出。
4243
- **按 Agent 同步** — 支持软链接或复制模式,并允许自定义 Agent 使用独立同步策略。
4344
- **Git 备份** — 提供快照式版本历史,用于备份、恢复和多机同步。
@@ -85,6 +86,7 @@ Skills-Manager-Plus 通过中央库、预设切换、全局工作区、项目工
8586
- `技能商店`
8687
- `预设`
8788
- `全局工作区`
89+
- `远程工作区`
8890
- `项目工作区`
8991
- `设置`
9092

@@ -97,6 +99,7 @@ Skills-Manager-Plus 通过中央库、预设切换、全局工作区、项目工
9799
- [技能商店](./docs/usage/zh-CN/skills-store.md)
98100
- [技能管理](./docs/usage/zh-CN/skills-management.md)
99101
- [预设](./docs/usage/zh-CN/presets.md)
102+
- [远程工作区](./docs/usage/zh-CN/remote-workspace.md)
100103
- [项目工作区](./docs/usage/zh-CN/project-workspaces.md)
101104
- [设置](./docs/usage/zh-CN/settings.md)
102105
- [Git 备份](./docs/usage/zh-CN/git-backup.md)
@@ -114,9 +117,10 @@ Cursor · Claude Code · Codex · OpenCode · Amp · Kilo Code · Roo Code · Go
114117
2. 打开 `技能商店`,从市场、Git、本地、ClawHub 或插件市场导入 Skills。
115118
3. 打开 `技能管理`,决定当前预设需要启用哪些 Skills。
116119
4. 打开 `全局工作区`,查看各 Agent 的全局本地技能,或把某个预设批量同步到指定 Agent。
117-
5. 如果需要处理项目本地 Skills,使用 `项目工作区`
118-
6. 如果需要历史记录、恢复点或多机同步,配置 `Git 备份`
119-
7. 如果需要自动化或恢复操作,使用 `skills-manager-plus-cli` 复用桌面端的仓库和预设状态。
120+
5. 如果需要管理 SSH 主机上的 Agent 全局 Skills,使用 `远程工作区`,它不是本地/远程双向同步。
121+
6. 如果需要处理项目本地 Skills,使用 `项目工作区`
122+
7. 如果需要历史记录、恢复点或多机同步,配置 `Git 备份`
123+
8. 如果需要自动化或恢复操作,使用 `skills-manager-plus-cli` 复用桌面端的仓库和预设状态。
120124

121125
仓库同时提供 `skills/manage-skills/SKILL.md`,这是一个可选 Agent Skill,用于让兼容的 Agent 优先调用 `skills-manager-plus-cli`,而不是直接写入某个单独 Agent 的 skills 目录。
122126

docs/usage/README.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@ This directory contains the complete usage documentation for Skills-Manager-Plus
99
- [Skills Store](./skills-store.md)
1010
- [Skills Management](./skills-management.md)
1111
- [Presets](./presets.md)
12+
- [Remote Workspace](./remote-workspace.md)
1213
- [Project Workspaces](./project-workspaces.md)
1314
- [Settings](./settings.md)
1415
- [Git Backup](./git-backup.md)
@@ -18,6 +19,6 @@ This directory contains the complete usage documentation for Skills-Manager-Plus
1819

1920
1. Read `overview.md` to understand the central-library workflow.
2021
2. Read `skills-store.md` and `skills-management.md` to understand the main daily workflow.
21-
3. Read `presets.md`, `project-workspaces.md`, and `Global Workspace` in the app if you manage multiple workflows or project-local skills.
22+
3. Read `presets.md`, `remote-workspace.md`, `project-workspaces.md`, and `Global Workspace` in the app if you manage multiple workflows, SSH hosts, or project-local skills.
2223
4. Read `settings.md` and `git-backup.md` when configuring environments, custom agents, or backup.
23-
5. Read `cli.md` when scripting repository checks, preset sync, Global Workspace operations, or Git recovery.
24+
5. Read `cli.md` when scripting repository checks, preset sync, Global Workspace operations, Remote Workspace read-only checks, or Git recovery.

docs/usage/overview.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@ The main concepts are:
99
- `Central library`: the main repository where imported skills are stored.
1010
- `Preset`: a named workflow configuration with its own enabled skill set.
1111
- `Global workspace`: the per-agent surface for browsing real agent-global local skills and comparing them with the Skills Center.
12+
- `Remote workspace`: the SSH-host surface for managing remote agent-global Skills without local/remote sync.
1213
- `Installed tool`: a supported AI coding tool that can receive synced skills.
1314
- `Project workspace`: a project-local skills area that can be compared with the central library.
1415
- `Custom agent`: a user-defined tool path with its own sync configuration.
@@ -19,8 +20,9 @@ The main concepts are:
1920
2. Install skills through `Skills Store`.
2021
3. Open `Skills Management` and choose which skills are enabled in the current preset.
2122
4. Open `Global Workspace` when you want to inspect agent-global local skills or apply a preset to a specific agent.
22-
5. Use `Project Workspaces` when a repository has its own local skills that need to be reviewed or exchanged.
23-
6. Use `Git Backup` when you want restore points or multi-machine sync.
23+
5. Use `Remote Workspace` when you need to manage agent-global Skills on an SSH host.
24+
6. Use `Project Workspaces` when a repository has its own local skills that need to be reviewed or exchanged.
25+
7. Use `Git Backup` when you want restore points or multi-machine sync.
2426

2527
## Main Navigation
2628

@@ -29,5 +31,6 @@ The main concepts are:
2931
- `Skills Store`: import new skills from external sources.
3032
- `Presets`: switch between different workflow setups.
3133
- `Global Workspace`: inspect and manage each installed agent's global local skills.
34+
- `Remote Workspace`: connect to SSH hosts and manage remote agent-global Skills with backup-first writes.
3235
- `Project Workspaces`: inspect and synchronize repository-local skills.
3336
- `Settings`: configure paths, tools, sync, search keys, and environment behavior.

docs/usage/remote-workspace.md

Lines changed: 69 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,69 @@
1+
# Remote Workspace
2+
3+
`Remote Workspace` manages agent-global Skills on SSH hosts. It is a remote management surface, not a local/remote synchronization system.
4+
5+
## Host Setup
6+
7+
Add a host from `Remote Workspace` with:
8+
9+
- Host name or IP address.
10+
- SSH port.
11+
- Username.
12+
- Password or private key authentication.
13+
- Optional SSH config import for hosts already defined in your local SSH config.
14+
15+
Connection tests verify the SSH login and detect the remote home directory before scanning Skills.
16+
17+
## Credentials
18+
19+
Remote credentials are stored through the operating system credential store. Saving a password is optional. When you edit a host, saved secrets are not shown back in the form; enter a new secret only when you want to replace the stored one.
20+
21+
## Scan
22+
23+
Scanning checks the remote agent global Skills directories for supported tools, such as Codex or Claude Code. It does not scan remote project workspaces, arbitrary folders, Git repositories, plugin markets, or ClawHub sources.
24+
25+
The scan result records each detected remote Skill, agent, path, and last scan time.
26+
27+
## Install From Skills Center
28+
29+
Use `Install` to copy a local Skills Center Skill to a selected remote agent global Skills directory. If the target Skill already exists, Remote Workspace creates a remote backup before replacing it.
30+
31+
## Update From Skills Center
32+
33+
V1 remote update is conservative: it updates a remote Skill only when there is exactly one enabled local Skills Center Skill with the same name. The existing remote directory is backed up before replacement.
34+
35+
Remote update does not fetch directly from the remote Skill's original Git, plugin, or ClawHub source.
36+
37+
## Delete With Backup
38+
39+
Delete removes a selected remote Skill only after creating a backup on the remote host. Backups are stored under:
40+
41+
```text
42+
~/.skills-manager-plus/backups/remote/<host-id>/<agent-id>/<skill-name>/<timestamp>
43+
```
44+
45+
The operation log records the backup path so you can locate the saved copy later.
46+
47+
## Operation Logs
48+
49+
Remote Workspace records install, update, delete, and failure events with operation type, status, timestamp, error message when present, and backup path when a backup was created.
50+
51+
## CLI Read-Only Commands
52+
53+
The CLI supports read-only Remote Workspace checks:
54+
55+
```bash
56+
skills-manager-plus-cli remote hosts list
57+
skills-manager-plus-cli remote hosts test <host-id-or-name>
58+
skills-manager-plus-cli remote scan <host-id-or-name>
59+
skills-manager-plus-cli remote skills list <host-id-or-name>
60+
```
61+
62+
These commands use saved host profiles and saved credentials. They do not install, update, or delete remote Skills.
63+
64+
## V1 Non-Goals
65+
66+
- No bidirectional local/remote sync.
67+
- No remote Project Workspace support.
68+
- No batch operations across multiple hosts.
69+
- No direct remote update from Git, plugin markets, or ClawHub.

docs/usage/zh-CN/README.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@
99
- [技能商店](./skills-store.md)
1010
- [技能管理](./skills-management.md)
1111
- [预设](./presets.md)
12+
- [远程工作区](./remote-workspace.md)
1213
- [项目工作区](./project-workspaces.md)
1314
- [设置](./settings.md)
1415
- [Git 备份](./git-backup.md)
@@ -18,6 +19,6 @@
1819

1920
1. 先看 `overview.md`,理解中央库工作流。
2021
2. 再看 `skills-store.md``skills-management.md`,理解日常主流程。
21-
3. 如果你管理多个工作流或项目本地技能,再看 `presets.md``project-workspaces.md`,并结合应用里的「全局工作区」一起使用。
22+
3. 如果你管理多个工作流、SSH 主机或项目本地技能,再看 `presets.md``remote-workspace.md``project-workspaces.md`,并结合应用里的「全局工作区」一起使用。
2223
4. 当你需要配置环境、自定义 Agent 或备份时,再看 `settings.md``git-backup.md`
23-
5. 当你需要脚本化仓库检查、预设同步、全局工作区操作或 Git 恢复时,再看 `cli.md`
24+
5. 当你需要脚本化仓库检查、预设同步、全局工作区操作、远程工作区只读检查或 Git 恢复时,再看 `cli.md`

docs/usage/zh-CN/overview.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@ Skills-Manager-Plus 的核心思路是:先维护一个中央技能库,再决
99
- `中央库`:所有导入技能的主存储位置。
1010
- `预设`:一个具名工作流配置,拥有自己独立的启用技能集合。
1111
- `全局工作区`:按 Agent 查看真实的全局本地技能,并与 Skills 中心进行对比和管理的入口。
12+
- `远程工作区`:通过 SSH 管理远程主机上的 Agent 全局 Skills,不提供本地/远程双向同步。
1213
- `已安装工具`:可以接收同步技能的支持工具。
1314
- `项目工作区`:可以与中央库对比的项目本地技能区域。
1415
- `自定义 Agent`:由用户定义路径和同步配置的额外工具目标。
@@ -19,8 +20,9 @@ Skills-Manager-Plus 的核心思路是:先维护一个中央技能库,再决
1920
2. 通过 `技能商店` 导入 Skills。
2021
3. 打开 `技能管理`,决定当前预设启用哪些 Skills。
2122
4. 打开 `全局工作区`,查看各 Agent 的全局本地技能,或将某个预设批量同步到指定 Agent。
22-
5. 如果仓库中存在本地 Skills,则使用 `项目工作区` 进行对比和流转。
23-
6. 如果需要恢复点或多机同步,则使用 `Git 备份`
23+
5. 如果需要管理 SSH 主机上的 Agent 全局 Skills,则使用 `远程工作区`
24+
6. 如果仓库中存在本地 Skills,则使用 `项目工作区` 进行对比和流转。
25+
7. 如果需要恢复点或多机同步,则使用 `Git 备份`
2426

2527
## 主导航
2628

@@ -29,5 +31,6 @@ Skills-Manager-Plus 的核心思路是:先维护一个中央技能库,再决
2931
- `技能商店`:从外部来源导入新 Skills。
3032
- `预设`:切换不同工作流配置。
3133
- `全局工作区`:查看并管理每个已安装 Agent 的全局本地技能。
34+
- `远程工作区`:连接 SSH 主机,并以先备份后写入的方式管理远程 Agent 全局 Skills。
3235
- `项目工作区`:检查和同步仓库本地 Skills。
3336
- `设置`:配置路径、工具、同步、搜索 Key 和环境行为。
Lines changed: 69 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,69 @@
1+
# 远程工作区
2+
3+
`远程工作区` 用来管理 SSH 主机上的 Agent 全局 Skills。它是远程管理入口,不是本地/远程双向同步系统。
4+
5+
## 主机设置
6+
7+
`远程工作区` 中添加主机时,需要填写:
8+
9+
- 主机名或 IP 地址。
10+
- SSH 端口。
11+
- 用户名。
12+
- 密码或私钥认证信息。
13+
- 可选的 SSH config 导入,用于复用本机 SSH config 中已有的主机配置。
14+
15+
连接测试会验证 SSH 登录,并在扫描 Skills 前识别远程用户主目录。
16+
17+
## 凭据行为
18+
19+
远程凭据通过操作系统凭据存储保存。密码是否保存由你选择。编辑主机时,已保存的密钥或密码不会回显到表单中;只有在需要替换凭据时才需要重新输入。
20+
21+
## 扫描
22+
23+
扫描只检查支持工具的远程 Agent 全局 Skills 目录,例如 Codex 或 Claude Code。它不会扫描远程项目工作区、任意目录、Git 仓库、插件市场或 ClawHub 来源。
24+
25+
扫描结果会记录每个发现的远程 Skill、所属 Agent、路径和最近扫描时间。
26+
27+
## 从 Skills 中心安装
28+
29+
使用 `安装` 可以把本地 Skills 中心里的某个 Skill 复制到选中的远程 Agent 全局 Skills 目录。如果目标 Skill 已存在,远程工作区会先创建远程备份,再替换目录。
30+
31+
## 从 Skills 中心更新
32+
33+
V1 的远程更新是保守策略:只有当本地 Skills 中心里存在唯一一个同名且已启用的 Skill 时,才允许更新远程 Skill。替换前会先备份现有远程目录。
34+
35+
远程更新不会直接从远程 Skill 的原始 Git、插件或 ClawHub 来源拉取内容。
36+
37+
## 带备份删除
38+
39+
删除远程 Skill 时,会先在远程主机上创建备份,然后再删除选中的远程目录。备份位置为:
40+
41+
```text
42+
~/.skills-manager-plus/backups/remote/<host-id>/<agent-id>/<skill-name>/<timestamp>
43+
```
44+
45+
操作日志会记录备份路径,便于之后定位保留的副本。
46+
47+
## 操作日志
48+
49+
远程工作区会记录安装、更新、删除和失败事件,包括操作类型、状态、时间戳、错误信息以及已创建的备份路径。
50+
51+
## CLI 只读命令
52+
53+
CLI 支持远程工作区的只读检查:
54+
55+
```bash
56+
skills-manager-plus-cli remote hosts list
57+
skills-manager-plus-cli remote hosts test <host-id-or-name>
58+
skills-manager-plus-cli remote scan <host-id-or-name>
59+
skills-manager-plus-cli remote skills list <host-id-or-name>
60+
```
61+
62+
这些命令使用已保存的主机配置和凭据,不会安装、更新或删除远程 Skills。
63+
64+
## V1 非目标
65+
66+
- 不提供本地/远程双向同步。
67+
- 不支持远程项目工作区。
68+
- 不支持跨多主机批量操作。
69+
- 不支持直接从远程 Git、插件市场或 ClawHub 更新。

0 commit comments

Comments
 (0)