rl-rockcli 0.0.15 → 0.0.17

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 (3) hide show
  1. package/README.md +2 -74
  2. package/index.js +1 -1
  3. package/package.json +3 -2
package/README.md CHANGED
@@ -5,7 +5,6 @@ ROCK CLI 是一个开源的命令行工具,用于管理和操作沙箱环境
5
5
  ## 功能特性
6
6
 
7
7
  - **沙箱管理** - 启动、停止、执行、上传/下载文件、交互式 REPL
8
- - **会话管理** - 持久化执行环境,支持环境变量继承
9
8
 
10
9
  ## 安装
11
10
 
@@ -28,9 +27,7 @@ rockcli <command> [options]
28
27
  ### 全局选项
29
28
 
30
29
  - `--verbose, -v` - 启用详细日志输出
31
- - `--config` - 配置文件路径(默认:~/.rock/settings.json)
32
30
  - `--base-url` - 服务器地址(覆盖配置文件)
33
- - `--api-key` - API 密钥(覆盖配置文件)
34
31
 
35
32
  ## 命令详解
36
33
 
@@ -161,9 +158,6 @@ rockcli sandbox <sandbox-id> session close --session my-session
161
158
  ```bash
162
159
  # 进入交互式 REPL
163
160
  rockcli sandbox <sandbox-id> attach
164
-
165
- # 或使用旧语法
166
- rockcli attach <sandbox-id>
167
161
  ```
168
162
 
169
163
  REPL 模式支持:
@@ -186,20 +180,16 @@ REPL 模式支持:
186
180
  ```json
187
181
  {
188
182
  "sandbox": {
189
- "base_url": "http://localhost:8080",
190
- "api_key": "your-api-key"
183
+ "base_url": "http://localhost:8080"
191
184
  }
192
185
  }
193
186
  ```
194
187
 
195
188
  ## 环境变量
196
189
 
197
- 支持通过环境变量设置认证信息:
190
+ 支持通过环境变量设置服务器地址:
198
191
 
199
192
  ```bash
200
- # 设置 API Key
201
- export ROCK_API_KEY=your-api-key
202
-
203
193
  # 设置服务器地址
204
194
  export ROCKCLI_BASE_URL=http://localhost:8080
205
195
 
@@ -212,68 +202,6 @@ rockcli sandbox <sandbox-id> status
212
202
 
213
203
  优先级:命令行参数 > 环境变量 > 配置文件
214
204
 
215
- ## 配置管理 (config)
216
-
217
- 配置管理命令用于设置和查看本地配置参数。
218
-
219
- ### 基本语法
220
-
221
- ```bash
222
- rockcli config [options]
223
- ```
224
-
225
- ### 选项说明
226
-
227
- - `--api-key <key>` - 设置 API 密钥
228
- - `--base-url <url>` - 设置服务器基础 URL
229
- - `--list` - 显示当前配置(脱敏敏感值)
230
-
231
- ### 示例
232
-
233
- ```bash
234
- # 设置 API Key 和服务器地址
235
- rockcli config --api-key xxx --base-url http://localhost:8080
236
-
237
- # 显示当前配置
238
- rockcli config --list
239
-
240
- # 仅设置 API Key,其他值保持不变
241
- rockcli config --api-key xxx
242
- ```
243
-
244
- ## 开发指南
245
-
246
- ### 项目结构
247
-
248
- ```
249
- opensource/
250
- ├── bin/
251
- │ └── rockcli.js # CLI 主入口
252
- └── package.json # 包配置
253
-
254
- (引用上层目录的共享代码)
255
- ├── commands/ # 命令模块
256
- ├── sdks/ # SDK 客户端
257
- └── utils/ # 工具类
258
- ```
259
-
260
- ### 本地开发
261
-
262
- ```bash
263
- # 克隆项目
264
- git clone <repository-url>
265
-
266
- # 安装依赖
267
- npm install
268
-
269
- # 本地链接
270
- npm link
271
-
272
- # 测试命令
273
- rockcli --help
274
- rockcli sandbox --help
275
- ```
276
-
277
205
  ## 相关资源
278
206
 
279
207
  - GitHub: https://github.com/your-org/rock-cli
package/index.js CHANGED
@@ -39,7 +39,7 @@ function run() {
39
39
 
40
40
  cli
41
41
  .scriptName('rockcli')
42
- .usage(LOGO + '\n\nUsage: $0 <command> [options]')
42
+ .usage(LOGO + '\n\nUsage: $0 <command> [options]\n\n快捷别名:rc (效果与 rockcli 相同)')
43
43
  .command(sandboxCommand)
44
44
  .demandCommand(1, '请提供一个有效的命令。使用 --help 查看可用命令。')
45
45
  .strict()
package/package.json CHANGED
@@ -1,9 +1,10 @@
1
1
  {
2
2
  "name": "rl-rockcli",
3
- "version": "0.0.15",
3
+ "version": "0.0.17",
4
4
  "description": "Open-source ROCK CLI - Sandbox and Log management tool",
5
5
  "bin": {
6
- "rockcli": "./index.js"
6
+ "rockcli": "./index.js",
7
+ "rc": "./index.js"
7
8
  },
8
9
  "main": "./index.js",
9
10
  "files": [