@opencangjie/skills 0.0.37 → 0.0.38

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 (4) hide show
  1. package/CHANGELOG.md +2 -2
  2. package/README.md +63 -7
  3. package/README_cn.md +63 -7
  4. package/package.json +2 -2
package/CHANGELOG.md CHANGED
@@ -1,4 +1,4 @@
1
- # Changelog
1
+ # Changelog
2
2
 
3
3
  All notable changes to the `@opencangjie/skills` SDK will be documented in this file.
4
4
 
@@ -7,7 +7,7 @@ All notable changes to the `@opencangjie/skills` SDK will be documented in this
7
7
  ### Fixed
8
8
  - **Windows `npx skills stop` command**: Now uses `taskkill /F /PID` on Windows to properly terminate runtime process
9
9
  - Previous `process.kill(pid, 'SIGTERM')` didn't work on Windows for detached processes
10
- - **Runtime v0.0.13**: Temporary directory now uses sibling `temp` directory of `SKILL_INSTALL_PATH`
10
+ - **Runtime v0.0.16**: Temporary directory now uses sibling `temp` directory of `SKILL_INSTALL_PATH`
11
11
  - If `SKILL_INSTALL_PATH=./skills`, temp directory will be `./temp/git-clone`
12
12
  - This ensures proper permissions and accessibility for the temp directory
13
13
 
package/README.md CHANGED
@@ -1,4 +1,4 @@
1
- # @opencangjie/skills
1
+ # @opencangjie/skills
2
2
 
3
3
  JavaScript/TypeScript SDK for AgentSkills Runtime - Install, manage, and execute AI agent skills with built-in runtime support.
4
4
 
@@ -32,10 +32,46 @@ npx @opencangjie/skills add ./my-skill
32
32
  npx skills install-runtime
33
33
 
34
34
  # Or specify a version
35
- npx skills install-runtime --runtime-version 0.0.13
35
+ npx skills install-runtime --runtime-version 0.0.16
36
36
  ```
37
37
 
38
- ### 2. Start the Runtime
38
+ ### 2. Configure the Runtime
39
+
40
+ Before starting the runtime, you need to configure the AI model API key. The runtime requires an AI model to process skill execution and natural language understanding.
41
+
42
+ Edit the `.env` file in the runtime directory:
43
+ - **Windows**: `%USERPROFILE%\.agentskills-runtime\release\.env`
44
+ - **macOS/Linux**: `~/.agentskills-runtime/release/.env`
45
+
46
+ Add your AI model configuration (choose one provider):
47
+
48
+ ```ini
49
+ # Option 1: StepFun (阶跃星辰)
50
+ MODEL_PROVIDER=stepfun
51
+ MODEL_NAME=step-1-8k
52
+ STEPFUN_API_KEY=your_stepfun_api_key_here
53
+ STEPFUN_BASE_URL=https://api.stepfun.com/v1
54
+
55
+ # Option 2: DeepSeek
56
+ MODEL_PROVIDER=deepseek
57
+ MODEL_NAME=deepseek-chat
58
+ DEEPSEEK_API_KEY=your_deepseek_api_key_here
59
+
60
+ # Option 3: 华为云 MaaS
61
+ MODEL_PROVIDER=maas
62
+ MAAS_API_KEY=your_maas_api_key_here
63
+ MAAS_BASE_URL=https://api.modelarts-maas.com/v2
64
+ MAAS_MODEL_NAME=qwen3-coder-480b-a35b-instruct
65
+
66
+ # Option 4: Sophnet
67
+ MODEL_PROVIDER=sophnet
68
+ SOPHNET_API_KEY=your_sophnet_api_key_here
69
+ SOPHNET_BASE_URL=https://www.sophnet.com/api/open-apis/v1
70
+ ```
71
+
72
+ > **Note**: Without proper AI model configuration, the runtime will fail to start with an error like "Get env variable XXX_API_KEY error."
73
+
74
+ ### 3. Start the Runtime
39
75
 
40
76
  ```bash
41
77
  # Start in background (default)
@@ -48,7 +84,7 @@ npx skills start --foreground
48
84
  npx skills start --port 3000 --host 0.0.0.0
49
85
  ```
50
86
 
51
- ### 3. Manage Skills
87
+ ### 4. Manage Skills
52
88
 
53
89
  ```bash
54
90
  # Find and install skills
@@ -72,7 +108,7 @@ Download and install the AgentSkills runtime binary.
72
108
 
73
109
  ```bash
74
110
  npx skills install-runtime
75
- npx skills install-runtime --runtime-version 0.0.13
111
+ npx skills install-runtime --runtime-version 0.0.16
76
112
  ```
77
113
 
78
114
  #### `npx skills start`
@@ -136,11 +172,23 @@ npx skills find skill --source atomgit --limit 5
136
172
  Install a skill from GitHub or local path.
137
173
 
138
174
  ```bash
175
+ # Install from local directory
139
176
  npx skills add ./my-skill
177
+
178
+ # Install from GitHub repository
140
179
  npx skills add github.com/user/skill-repo
141
180
  npx skills add github.com/user/skill-repo --branch develop
181
+
182
+ # Install from multi-skill repository (specify subdirectory)
183
+ npx skills add https://github.com/user/skills-repo/tree/main/skills/my-skill
184
+ npx skills add https://atomgit.com/user/skills-repo/tree/main/skills/skill-creator
185
+
186
+ # Install with options
187
+ npx skills add github.com/user/skill-repo -y # Skip confirmation
142
188
  ```
143
189
 
190
+ > **Tip**: For repositories containing multiple skills, use the `/tree/<branch>/<skill-path>` format to specify the exact subdirectory. This avoids the interactive selection prompt.
191
+
144
192
  #### `npx skills list`
145
193
 
146
194
  List installed skills.
@@ -653,18 +701,26 @@ onMounted(loadSkills);
653
701
  // apps/backend/package.json
654
702
  {
655
703
  "dependencies": {
656
- "@opencangjie/skills": "^0.0.13"
704
+ "@opencangjie/skills": "^0.0.16"
657
705
  }
658
706
  }
659
707
 
660
708
  // apps/uctoo-app-client-pc/package.json
661
709
  {
662
710
  "dependencies": {
663
- "@opencangjie/skills": "^0.0.13"
711
+ "@opencangjie/skills": "^0.0.16"
664
712
  }
665
713
  }
666
714
  ```
667
715
 
716
+ ## Links
717
+
718
+ - [NPM Package](https://www.npmjs.com/package/@opencangjie/skills)
719
+ - [Documentation](https://atomgit.com/uctoo/agentskills-runtime#readme)
720
+ - [Repository](https://atomgit.com/uctoo/agentskills-runtime)
721
+ - [Issue Tracker](https://atomgit.com/uctoo/agentskills-runtime/issues)
722
+ - [Python SDK](../python)
723
+
668
724
  ## License
669
725
 
670
726
  MIT
package/README_cn.md CHANGED
@@ -1,4 +1,4 @@
1
- # @opencangjie/skills
1
+ # @opencangjie/skills
2
2
 
3
3
  AgentSkills Runtime 的 JavaScript/TypeScript SDK - 安装、管理和执行 AI 代理技能，内置运行时支持。
4
4
 
@@ -32,10 +32,46 @@ npx @opencangjie/skills add ./my-skill
32
32
  npx skills install-runtime
33
33
 
34
34
  # 或指定版本
35
- npx skills install-runtime --version 0.0.1
35
+ npx skills install-runtime --runtime-version 0.0.16
36
36
  ```
37
37
 
38
- ### 2. 启动运行时
38
+ ### 2. 配置运行时
39
+
40
+ 在启动运行时之前，您需要配置 AI 模型 API 密钥。运行时需要 AI 模型来处理技能执行和自然语言理解。
41
+
42
+ 编辑运行时目录中的 `.env` 文件：
43
+ - **Windows**: `%USERPROFILE%\.agentskills-runtime\release\.env`
44
+ - **macOS/Linux**: `~/.agentskills-runtime/release/.env`
45
+
46
+ 添加您的 AI 模型配置（选择一个提供商）：
47
+
48
+ ```ini
49
+ # 选项 1: StepFun (阶跃星辰)
50
+ MODEL_PROVIDER=stepfun
51
+ MODEL_NAME=step-1-8k
52
+ STEPFUN_API_KEY=your_stepfun_api_key_here
53
+ STEPFUN_BASE_URL=https://api.stepfun.com/v1
54
+
55
+ # 选项 2: DeepSeek
56
+ MODEL_PROVIDER=deepseek
57
+ MODEL_NAME=deepseek-chat
58
+ DEEPSEEK_API_KEY=your_deepseek_api_key_here
59
+
60
+ # 选项 3: 华为云 MaaS
61
+ MODEL_PROVIDER=maas
62
+ MAAS_API_KEY=your_maas_api_key_here
63
+ MAAS_BASE_URL=https://api.modelarts-maas.com/v2
64
+ MAAS_MODEL_NAME=qwen3-coder-480b-a35b-instruct
65
+
66
+ # 选项 4: Sophnet
67
+ MODEL_PROVIDER=sophnet
68
+ SOPHNET_API_KEY=your_sophnet_api_key_here
69
+ SOPHNET_BASE_URL=https://www.sophnet.com/api/open-apis/v1
70
+ ```
71
+
72
+ > **注意**：如果没有正确配置 AI 模型，运行时将无法启动，并显示类似 "Get env variable XXX_API_KEY error" 的错误。
73
+
74
+ ### 3. 启动运行时
39
75
 
40
76
  ```bash
41
77
  # 后台启动（默认）
@@ -48,7 +84,7 @@ npx skills start --foreground
48
84
  npx skills start --port 3000 --host 0.0.0.0
49
85
  ```
50
86
 
51
- ### 3. 管理技能
87
+ ### 4. 管理技能
52
88
 
53
89
  ```bash
54
90
  # 查找并安装技能
@@ -72,7 +108,7 @@ npx skills run my-skill -p '{"input": "data"}'
72
108
 
73
109
  ```bash
74
110
  npx skills install-runtime
75
- npx skills install-runtime --runtime-version 0.0.13
111
+ npx skills install-runtime --runtime-version 0.0.16
76
112
  ```
77
113
 
78
114
  #### `npx skills start`
@@ -136,11 +172,23 @@ npx skills find skill --source atomgit --limit 5
136
172
  从 GitHub 或本地路径安装技能。
137
173
 
138
174
  ```bash
175
+ # 从本地目录安装
139
176
  npx skills add ./my-skill
177
+
178
+ # 从 GitHub 仓库安装
140
179
  npx skills add github.com/user/skill-repo
141
180
  npx skills add github.com/user/skill-repo --branch develop
181
+
182
+ # 从多技能仓库安装（指定子目录）
183
+ npx skills add https://github.com/user/skills-repo/tree/main/skills/my-skill
184
+ npx skills add https://atomgit.com/user/skills-repo/tree/main/skills/skill-creator
185
+
186
+ # 带选项安装
187
+ npx skills add github.com/user/skill-repo -y # 跳过确认
142
188
  ```
143
189
 
190
+ > **提示**：对于包含多个技能的仓库，使用 `/tree/<分支>/<技能路径>` 格式指定具体的子目录。这样可以避免交互式选择提示。
191
+
144
192
  #### `npx skills list`
145
193
 
146
194
  列出已安装的技能。
@@ -653,18 +701,26 @@ onMounted(loadSkills);
653
701
  // apps/backend/package.json
654
702
  {
655
703
  "dependencies": {
656
- "@opencangjie/skills": "^0.0.13"
704
+ "@opencangjie/skills": "^0.0.16"
657
705
  }
658
706
  }
659
707
 
660
708
  // apps/uctoo-app-client-pc/package.json
661
709
  {
662
710
  "dependencies": {
663
- "@opencangjie/skills": "^0.0.13"
711
+ "@opencangjie/skills": "^0.0.16"
664
712
  }
665
713
  }
666
714
  ```
667
715
 
716
+ ## 相关链接
717
+
718
+ - [NPM 包](https://www.npmjs.com/package/@opencangjie/skills)
719
+ - [文档](https://atomgit.com/uctoo/agentskills-runtime#readme)
720
+ - [仓库](https://atomgit.com/uctoo/agentskills-runtime)
721
+ - [问题追踪](https://atomgit.com/uctoo/agentskills-runtime/issues)
722
+ - [Python SDK](../python)
723
+
668
724
  ## 许可证
669
725
 
670
726
  MIT
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@opencangjie/skills",
3
- "version": "0.0.37",
3
+ "version": "0.0.38",
4
4
  "description": "JavaScript/TypeScript SDK for AgentSkills Runtime - Install, manage, and execute AI agent skills with built-in runtime support",
5
5
  "main": "dist/index.js",
6
6
  "types": "dist/index.d.ts",
@@ -89,7 +89,7 @@
89
89
  }
90
90
  },
91
91
  "runtime": {
92
- "version": "0.0.15",
92
+ "version": "0.0.16",
93
93
  "downloadUrl": "https://atomgit.com/UCToo/agentskills-runtime/releases",
94
94
  "platforms": {
95
95
  "win32-x64": "agentskills-runtime-win-x64.tar.gz",