@x-era/dsh-forge 0.1.0 → 0.1.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +83 -61
  2. package/package.json +3 -3
package/README.md CHANGED
@@ -2,108 +2,130 @@ English | [中文](https://github.com/PhyAgentOS/dsh-PhyAgentOS/blob/main/README
2
2
 
3
3
  # dsh-PhyAgentOS
4
4
 
5
- DeepSeek Harness (DSH) plugins and tools for installing, running and managing
6
- [Forge](https://github.com/PhyAgentOS/forge) skills. A skill combines a Dora
7
- dataflow, node artifacts and Gateway Tool APIs.
5
+ DeepSeek Harness (DSH) plugins and tools for installing, running and managing [Forge](https://github.com/PhyAgentOS/forge) skills: Dora dataflows, node artifacts and Gateway Tool APIs.
8
6
 
9
- | Package | Purpose |
10
- | --- | --- |
11
- | `@x-era/forge-core` | Host-neutral manifests, registry, verified installation, node storage, runtime and Tool API client |
12
- | `@x-era/dsh-forge-skill` | DSH skill provider, management tools, configuration UI and built-in usage/development skills |
13
- | `@x-era/forge-cli` | `forge` shell command sharing the same home and state |
14
- | `@x-era/forge-mcp` | MCP stdio server exposing management and forwarding tools |
15
- | `@x-era/dsh-forge` | Installable DSH bundle that mounts the plugin |
7
+ [User guide](https://github.com/PhyAgentOS/dsh-PhyAgentOS/blob/main/docs/usage_en.md) · [Release guide](https://github.com/PhyAgentOS/dsh-PhyAgentOS/blob/main/docs/releasing.md) · [npm packages](https://www.npmjs.com/org/x-era) · [GitHub Releases](https://github.com/PhyAgentOS/dsh-PhyAgentOS/releases) · [npm package management — maintainers](https://www.npmjs.com/settings/x-era/packages)
16
8
 
17
- ## Install
9
+ ## Packages
18
10
 
19
- Use a supported DSH installation. The plugin packages require Node.js >=22;
20
- this repository's release workflow uses Node.js 24 and pnpm 11.28.5.
11
+ All five packages are public on npm and support independent, tag-triggered releases through GitHub Actions trusted publishing.
12
+
13
+ | Package | Purpose | Installed with the DSH bundle? |
14
+ | --- | --- | --- |
15
+ | [`@x-era/dsh-forge`](https://www.npmjs.com/package/@x-era/dsh-forge) | DSH bundle and plugin entry point | Yes |
16
+ | [`@x-era/dsh-forge-skill`](https://www.npmjs.com/package/@x-era/dsh-forge-skill) | Skill provider, management tools and built-in instructions | Yes, dependency |
17
+ | [`@x-era/forge-core`](https://www.npmjs.com/package/@x-era/forge-core) | Manifests, registry, verified installation, runtime and Tool API client | Yes, transitive dependency |
18
+ | [`@x-era/forge-cli`](https://www.npmjs.com/package/@x-era/forge-cli) | Standalone `forge` command | No, optional |
19
+ | [`@x-era/forge-mcp`](https://www.npmjs.com/package/@x-era/forge-mcp) | MCP stdio server for other agent clients | No, optional |
20
+
21
+ The npm management page requires an npm account with organization permissions. Public package pages are available to consumers.
22
+
23
+ ## Quick start: DSH Web
24
+
25
+ Use Node.js **>=24.9.0** for the tested DSH host. If `dsh` is not installed:
26
+
27
+ ```sh
28
+ node --version
29
+ npm install --global @deepseek-ai/dsh@0.2.2-rc.1
30
+ dsh --version
31
+ ```
32
+
33
+ Install into the profile you will launch:
34
+
35
+ ```sh
36
+ dsh plugin --profile web add @x-era/dsh-forge
37
+ dsh web
38
+ ```
39
+
40
+ For a DSH source checkout, run these commands in the **deepseek-harness repository**:
21
41
 
22
42
  ```sh
23
- dsh plugin --profile dev add @x-era/dsh-forge
24
- dsh --profile dev --dump-config
25
- dsh --profile dev
43
+ pnpm dsh plugin --profile web add @x-era/dsh-forge
44
+ pnpm dsh web
26
45
  ```
27
46
 
28
- Restart an already-running profile after installing the bundle. The composition
29
- should contain `forge-skill`; the running host should expose `forge-usage`,
30
- `forge-skill-development` and `forge_*` tools. The `dev` profile name is arbitrary.
31
- The CLI and MCP server are separate packages; installing the DSH bundle does not
32
- install global commands or the Dora runtime.
47
+ `dsh web` selects the `web` profile. Installing with `--profile dev` only affects `dev`; it does not enable the plugin in `web`. Restart an already-running profile after adding the bundle and open a new conversation.
48
+
49
+ Expected capabilities: `forge-usage`, `forge-skill-development` and `forge_*` management tools. This installs the plugin, not a robot skill, Dora or hardware/model dependencies. See the [user guide](https://github.com/PhyAgentOS/dsh-PhyAgentOS/blob/main/docs/usage_en.md) for checks and configuration.
50
+
51
+ Validation baselines: npm DSH `0.2.2-rc.1`; Web plugin registration also checked with a DSH `0.2.2-rc.2` source checkout.
52
+
53
+ ## Usage examples
54
+
55
+ In DSH, ask for the operation directly:
56
+
57
+ | Goal | Example request | Main tool |
58
+ | --- | --- | --- |
59
+ | Installed skills | “List installed Forge skills and their runtime states.” | `forge_skill_list` |
60
+ | Available skills | “Search the Forge registry for robot simulation skills.” | `forge_skill_search` |
61
+ | Choose a profile | “Inspect robot-control-sim and list its profiles and requirements.” | `forge_skill_inspect` after installation |
62
+ | Install | “Install robot-control-sim with its nodes and report installation progress.” | `forge_skill_install`, `forge_install_status` |
63
+ | Start simulation | “Check robot-control-sim / mujoco-piper, then start it if preflight passes.” | `forge_skill_doctor`, `forge_runtime_start` |
64
+ | Read robot state | “Call sim.get_robot_info on the running robot-control-sim skill.” | `forge_tool_call` |
65
+ | Stop | “Stop the robot-control-sim runtime and confirm its state.” | `forge_runtime_stop`, `forge_runtime_status` |
66
+
67
+ The registry currently provides `robot-control-sim` / `mujoco-piper`. Inspect its current requirements and platform support before starting it.
68
+
69
+ For a shell workflow, install the optional CLI first:
33
70
 
34
71
  ```sh
35
72
  npm install --global @x-era/forge-cli
36
73
  forge search robot
74
+ forge list
75
+ forge install robot-control-sim --wait
76
+ forge inspect robot-control-sim
77
+ forge doctor robot-control-sim --profile mujoco-piper
78
+ # Continue only if the required binaries, environment and platform checks pass.
79
+ forge start robot-control-sim mujoco-piper
80
+ forge status robot-control-sim
81
+ forge call robot-control-sim sim.get_robot_info
82
+ forge stop robot-control-sim
37
83
  ```
38
84
 
39
- ## Capabilities
40
-
41
- - Search, install, update and remove registry skills with digest/size validation,
42
- resumable downloads and asynchronous installation of large node artifacts.
43
- - Preflight, materialization, Dora lifecycle, Gateway readiness and state reconciliation.
44
- - Forge 1 (Dora 0.4.x) and Forge 2 (Dora 1.x), with coordinator and isolated run modes.
45
- - Environment injection, invocation polling/cancellation, diagnostics and structured logs.
46
- - Built-in agent instructions for skill use and development.
85
+ CLI output is JSON. Action/session acceptance is not completion: use `forge_invocation_read` in DSH/MCP to check an invocation; do not repeat an action with an unknown result. See [workflow details](https://github.com/PhyAgentOS/dsh-PhyAgentOS/blob/main/docs/usage_en.md#run-a-skill).
47
86
 
48
87
  ## Configuration
49
88
 
50
- Configure the `forge-skill` row in `$DSH_HOME/profiles/<name>/cordis.patch.yml`:
89
+ Set the `forge-skill` row in `$DSH_HOME/profiles/web/cordis.patch.yml` (default home: `~/.dsh`):
51
90
 
52
91
  ```yaml
53
92
  - id: forge-skill
54
93
  config:
55
- home: ~/.dsh/forge
56
94
  registry:
57
95
  url: https://paos-resource-platform.dev.x-era.com
96
+ tokenEnv: DSH_FORGE_REGISTRY_TOKEN
58
97
  runtime:
59
98
  dora: /path/to/dora
60
99
  dora1: /path/to/dora1
61
100
  ```
62
101
 
63
- `DSH_FORGE_HOME`, `DSH_FORGE_DORA` and `DSH_FORGE_DORA1` can supply paths.
64
- Use a reachable registry for your deployment and install the appropriate Dora
65
- CLI and skill-specific hardware/simulation prerequisites before starting a skill.
102
+ Replace the executable paths with those required by your skill. `DSH_FORGE_HOME`, `DSH_FORGE_REGISTRY_URL`, `DSH_FORGE_DORA` and `DSH_FORGE_DORA1` provide environment defaults. See [configuration and data](https://github.com/PhyAgentOS/dsh-PhyAgentOS/blob/main/docs/usage_en.md#configuration-and-data) for precedence, authenticated registries and the optional console.
66
103
 
67
- ## Develop from source
104
+ ## Develop and release
68
105
 
69
106
  ```sh
70
107
  git clone https://github.com/PhyAgentOS/dsh-PhyAgentOS.git
71
108
  cd dsh-PhyAgentOS
72
109
  pnpm install --frozen-lockfile
73
110
  pnpm test
74
- dsh plugin --profile dev add file:/absolute/path/to/dsh-PhyAgentOS/bundle
111
+ dsh plugin --profile web add file:/absolute/path/to/dsh-PhyAgentOS/bundle
75
112
  ```
76
113
 
77
- Use the explicit `file:` form on DSH 0.2.2-rc.1 so the installed package uses
78
- the profile resolver for host-provided peers. Reinstall after rebuilding source.
79
- The repository does not include the DSH host. Compatibility baseline:
80
- `compat/dsh-baseline.json`. `DSH_CHECKOUT=/path/to/deepseek-harness pnpm check:dsh`
81
- detects changes in upstream interfaces; update the baseline only after reviewing
82
- the change and validating a real host. A hash change alone does not establish
83
- runtime incompatibility or compatibility.
114
+ Use the explicit `file:` form and reinstall after rebuilding. The DSH host is a separate project. `DSH_CHECKOUT=/path/to/deepseek-harness pnpm check:dsh` checks the declared upstream API baseline; a changed hash alone does not establish runtime compatibility.
84
115
 
85
- ## Release
116
+ Release one package by updating its own manifest, merging a personal-fork PR into `main`, then creating its matching tag, such as `forge-cli/v0.1.2`. A new remote tag triggers tests, npm publishing and a GitHub Release with the tarball. Upload processing is polled every 15 seconds for up to approximately 15 minutes.
86
117
 
87
- Each package has an independent version and Git tag. For example,
88
- `forge-core/v0.1.0` publishes only core; `dsh-forge/v0.1.0` publishes only the bundle.
89
- Stable versions use npm `latest`; prereleases use `next`. Release checks require
90
- an exact tag checkout, a clean working tree, a matching manifest and published
91
- internal dependencies. The npm tarball records its source commit.
92
- After npm accepts an upload, the release waits up to approximately 15 minutes
93
- for public metadata instead of failing on a temporary 404.
94
-
95
- See the [release guide](https://github.com/PhyAgentOS/dsh-PhyAgentOS/blob/main/docs/releasing.md)
96
- for bootstrap, OIDC, independent releases and safe retry instructions.
118
+ See the [release guide](https://github.com/PhyAgentOS/dsh-PhyAgentOS/blob/main/docs/releasing.md) for all five version files, tag naming, OIDC setup, GitHub-page steps and recovery. Maintainers can use [npm package management](https://www.npmjs.com/settings/x-era/packages).
97
119
 
98
120
  ## Documentation
99
121
 
100
- The existing detailed guides are in Chinese:
101
- [usage](https://github.com/PhyAgentOS/dsh-PhyAgentOS/blob/main/docs/usage.md),
102
- [deployment](https://github.com/PhyAgentOS/dsh-PhyAgentOS/blob/main/docs/deployment.md),
103
- [operations](https://github.com/PhyAgentOS/dsh-PhyAgentOS/blob/main/docs/operations.md),
104
- [security](https://github.com/PhyAgentOS/dsh-PhyAgentOS/blob/main/docs/security.md),
105
- [skill development](https://github.com/PhyAgentOS/dsh-PhyAgentOS/blob/main/docs/skill-development.md).
122
+ | Guide | English | 中文 |
123
+ | --- | --- | --- |
124
+ | Installation, usage, CLI/MCP and troubleshooting | [User guide](https://github.com/PhyAgentOS/dsh-PhyAgentOS/blob/main/docs/usage_en.md) | [使用手册](https://github.com/PhyAgentOS/dsh-PhyAgentOS/blob/main/docs/usage.md) |
125
+ | Independent releases, tags and npm authorization | [Release guide](https://github.com/PhyAgentOS/dsh-PhyAgentOS/blob/main/docs/releasing.md) | [发布手册](https://github.com/PhyAgentOS/dsh-PhyAgentOS/blob/main/docs/releasing_zh.md) |
126
+
127
+ Additional guides in Chinese: [deployment](https://github.com/PhyAgentOS/dsh-PhyAgentOS/blob/main/docs/deployment.md) · [operations](https://github.com/PhyAgentOS/dsh-PhyAgentOS/blob/main/docs/operations.md) · [security](https://github.com/PhyAgentOS/dsh-PhyAgentOS/blob/main/docs/security.md) · [skill development](https://github.com/PhyAgentOS/dsh-PhyAgentOS/blob/main/docs/skill-development.md) · [portability](https://github.com/PhyAgentOS/dsh-PhyAgentOS/blob/main/docs/portability.md).
106
128
 
107
129
  ## License
108
130
 
109
- MIT. Published packages include `LICENSE`.
131
+ MIT. See [LICENSE](https://github.com/PhyAgentOS/dsh-PhyAgentOS/blob/main/LICENSE).
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@x-era/dsh-forge",
3
- "version": "0.1.0",
3
+ "version": "0.1.2",
4
4
  "description": "DeepSeek Harness bundle for Forge skill management",
5
5
  "type": "module",
6
6
  "files": [
@@ -17,7 +17,7 @@
17
17
  "dsh": ">=0.2.0 <0.3.0"
18
18
  },
19
19
  "dependencies": {
20
- "@x-era/dsh-forge-skill": "0.1.0"
20
+ "@x-era/dsh-forge-skill": "0.1.2"
21
21
  },
22
22
  "repository": {
23
23
  "type": "git",
@@ -28,5 +28,5 @@
28
28
  "access": "public",
29
29
  "registry": "https://registry.npmjs.org"
30
30
  },
31
- "gitHead": "6606cbf9aa70fc29c59ed05a9beb0349ec6921dc"
31
+ "gitHead": "0314aebe2682b58f2f32578df6177a7f359bc08b"
32
32
  }