@agentscope-ai/chat 1.1.24 → 1.1.26

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.
package/README.md CHANGED
@@ -21,21 +21,36 @@ A free, open-source React chat framework based on **Alibaba Cloud Spark Design**
21
21
 
22
22
  The quickest way is to use our CLI tool:
23
23
 
24
+ ```bash
25
+ # Option 1: Install globally (recommended)
26
+ npm install -g @agentscope-ai/chat
27
+ agentscope-runtime-webui -p 3000
28
+
29
+ # Option 2: Use npx (no installation required)
30
+ npx @agentscope-ai/chat agentscope-runtime-webui -p 3000
31
+
32
+ # Option 3: Local development (npm link first)
33
+ npm link
34
+ agentscope-runtime-webui -p 3000
35
+ ```
36
+
37
+ **Common Command Examples:**
38
+
24
39
  ```bash
25
40
  # Start with default configuration (port 3000)
26
- npx agentscope-runtime-webui
41
+ agentscope-runtime-webui
27
42
 
28
43
  # Specify port
29
- npx agentscope-runtime-webui --port 8080
44
+ agentscope-runtime-webui --port 8080
30
45
 
31
46
  # Specify backend API URL
32
- npx agentscope-runtime-webui --url http://api.example.com
47
+ agentscope-runtime-webui --url http://api.example.com
33
48
 
34
49
  # Specify authentication token
35
- npx agentscope-runtime-webui --token your-auth-token
50
+ agentscope-runtime-webui --token your-auth-token
36
51
 
37
52
  # Combine options
38
- npx agentscope-runtime-webui -p 8080 -u http://api.example.com -t your-token
53
+ agentscope-runtime-webui -p 8080 -u http://api.example.com -t your-token
39
54
  ```
40
55
 
41
56
  **CLI Options:**
@@ -46,8 +61,6 @@ npx agentscope-runtime-webui -p 8080 -u http://api.example.com -t your-token
46
61
  | `--url` | `-u` | Specify backend API URL | - |
47
62
  | `--token` | `-t` | Specify authentication token | - |
48
63
 
49
- For more CLI usage details, see [CLI Documentation](./bin/README.md).
50
-
51
64
  ### Method 2: Integrate into Project
52
65
 
53
66
  #### Installation
package/README.zh-CN.md CHANGED
@@ -21,21 +21,36 @@
21
21
 
22
22
  最快速的方式是使用我们提供的 CLI 工具:
23
23
 
24
+ ```bash
25
+ # 方式 1: 全局安装后使用(推荐)
26
+ npm install -g @agentscope-ai/chat
27
+ agentscope-runtime-webui -p 3000
28
+
29
+ # 方式 2: 使用 npx(无需安装)
30
+ npx @agentscope-ai/chat agentscope-runtime-webui -p 3000
31
+
32
+ # 方式 3: 本地开发(先 npm link)
33
+ npm link
34
+ agentscope-runtime-webui -p 3000
35
+ ```
36
+
37
+ **常用命令示例:**
38
+
24
39
  ```bash
25
40
  # 使用默认配置启动(端口 3000)
26
- npx agentscope-runtime-webui
41
+ agentscope-runtime-webui
27
42
 
28
43
  # 指定端口
29
- npx agentscope-runtime-webui --port 8080
44
+ agentscope-runtime-webui --port 8080
30
45
 
31
46
  # 指定后端 API 地址
32
- npx agentscope-runtime-webui --url http://api.example.com
47
+ agentscope-runtime-webui --url http://api.example.com
33
48
 
34
49
  # 指定认证 token
35
- npx agentscope-runtime-webui --token your-auth-token
50
+ agentscope-runtime-webui --token your-auth-token
36
51
 
37
52
  # 组合使用
38
- npx agentscope-runtime-webui -p 8080 -u http://api.example.com -t your-token
53
+ agentscope-runtime-webui -p 8080 -u http://api.example.com -t your-token
39
54
  ```
40
55
 
41
56
  **CLI 参数说明:**
@@ -46,8 +61,6 @@ npx agentscope-runtime-webui -p 8080 -u http://api.example.com -t your-token
46
61
  | `--url` | `-u` | 指定后端 API 地址 | 无 |
47
62
  | `--token` | `-t` | 指定认证 token | 无 |
48
63
 
49
- 更多 CLI 使用说明请查看 [CLI 文档](./bin/README.md)。
50
-
51
64
  ### 方式二:集成到项目
52
65
 
53
66
  #### 安装