docs: fix examples file, closed #24

snowyu · snowyu · commit 6ffd866cef5a · 2025-10-24T18:09:25.000+08:00
diff --git a/README.cn.md b/README.cn.md
@@ -196,7 +196,7 @@ cd llamacpp/build/bin
 
 ```bash
 # 进入交互对话模式
-$ai run --interactive --script examples/char-dobby
+$ai run --interactive --script examples/char-dobby.ai.yaml
 ```
 
 直接运行 `translator` 脚本库:
@@ -316,14 +316,14 @@ cd build/bin
 #默认脚本的搜索路径是当前目录和`~/.local/share/ai/agent`目录 . 你可以在`agentDirs`中配置, 或者直接在命令行中指定,注意命令行指定将覆盖配置文件中的设置.
 #`-f` means the agent file
 #`-i` means 进入交互模式, char-dobby 是一个角色智能体脚本,扮演哈利波特中的dobby.
-$ai run -if examples/char-dobby
+$ai run -if examples/char-dobby.ai.yaml
 Dobby: I am Dobby. Dobby is happy.
 You: intro yourself pls.
 Dobby: I am Dobby. I'm a brave and loyal house-elf, and I'm very proud to be a free elf. I love socks and wearing mismatched pairs.
 
 #在命令行上输入内容(content)和内容的json schema 规范(output), 它就会产出该内容对应的json数据.
 #注意其生成质量受所选脑子🧠的影响.
-$ai run -f examples/json '{content: "I recently purchased the Razer BlackShark V2 X Gaming Headset, and it has significantly enhanced my gaming experience. This headset offers incredible sound quality, comfort, and features that are perfect for any serious gamer. Here’s why I highly recommend it: The 7.1 surround sound feature is a game-changer. The audio quality is superb, providing a truly immersive experience. I can clearly hear directional sounds, which is crucial for competitive gaming. The depth and clarity of the sound make it feel like I’m right in the middle of the action. The 50mm drivers deliver powerful, high-quality sound. The bass is deep and punchy without being overwhelming, while the mids and highs are crisp and clear. This balance makes the headset versatile, not only for gaming but also for listening to music and watching movies.", "output":{"type":"object","properties":{"sentiment":{"type":"string","description":"Sentiment (positive or negative)"},"products":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Name of the product"},"brand":{"type":"string","description":"Company that made the product"}}},"description":"Products mentioned in the review"},"anger":{"type":"boolean","description":"Is the reviewer expressing anger?"}},"required":["sentiment","products","anger"]}}'
+$ai run -f examples/json.ai.yaml '{content: "I recently purchased the Razer BlackShark V2 X Gaming Headset, and it has significantly enhanced my gaming experience. This headset offers incredible sound quality, comfort, and features that are perfect for any serious gamer. Here’s why I highly recommend it: The 7.1 surround sound feature is a game-changer. The audio quality is superb, providing a truly immersive experience. I can clearly hear directional sounds, which is crucial for competitive gaming. The depth and clarity of the sound make it feel like I’m right in the middle of the action. The 50mm drivers deliver powerful, high-quality sound. The bass is deep and punchy without being overwhelming, while the mids and highs are crisp and clear. This balance makes the headset versatile, not only for gaming but also for listening to music and watching movies.", "output":{"type":"object","properties":{"sentiment":{"type":"string","description":"Sentiment (positive or negative)"},"products":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Name of the product"},"brand":{"type":"string","description":"Company that made the product"}}},"description":"Products mentioned in the review"},"anger":{"type":"boolean","description":"Is the reviewer expressing anger?"}},"required":["sentiment","products","anger"]}}'
 
 {
   "sentiment": "positive",
@@ -351,7 +351,7 @@ import { AIScriptServer } from '@isdk/ai-tool-agent';
 
 // 配置你的脚本搜索路径
 AIScriptEx.searchPaths = ['.']
-const script = AIScriptServer.load('examples/json')
+const script = AIScriptServer.load('examples/json.ai.yaml')
 // 设置默认为大模型流式响应
 script.llmStream = stream
 
diff --git a/README.md b/README.md
@@ -200,7 +200,7 @@ npm install -g @offline-ai/cli
 run your ai agent script, eg, the `Dobby` character:
 
 ```bash
-$ai run --interactive --script examples/char-dobby
+$ai run --interactive --script examples/char-dobby.ai.yaml
 ```
 
 run the `translator` script lib directly:
@@ -324,13 +324,13 @@ Now you can run your AI agent:
 #defaults will search current working dir. you can config the search paths in `agentDirs`.
 #`-f` means the agent file
 #`-i` means entering the interactive mode
-$ai run -if examples/char-dobby
+$ai run -if examples/char-dobby.ai.yaml
 Dobby: I am Dobby. Dobby is happy.
 You: intro yourself pls.
 Dobby: I am Dobby. I'm a brave and loyal house-elf, and I'm very proud to be a free elf. I love socks and wearing mismatched pairs.
 
 #provide the content and the json schema in output field, it will output the json data.
-$ai run -f examples/json '{content: "I recently purchased the Razer BlackShark V2 X Gaming Headset, and it has significantly enhanced my gaming experience. This headset offers incredible sound quality, comfort, and features that are perfect for any serious gamer. Here’s why I highly recommend it: The 7.1 surround sound feature is a game-changer. The audio quality is superb, providing a truly immersive experience. I can clearly hear directional sounds, which is crucial for competitive gaming. The depth and clarity of the sound make it feel like I’m right in the middle of the action. The 50mm drivers deliver powerful, high-quality sound. The bass is deep and punchy without being overwhelming, while the mids and highs are crisp and clear. This balance makes the headset versatile, not only for gaming but also for listening to music and watching movies.", "output":{"type":"object","properties":{"sentiment":{"type":"string","description":"Sentiment (positive or negative)"},"products":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Name of the product"},"brand":{"type":"string","description":"Company that made the product"}}},"description":"Products mentioned in the review"},"anger":{"type":"boolean","description":"Is the reviewer expressing anger?"}},"required":["sentiment","products","anger"]}}'
+$ai run -f examples/json.ai.yaml '{content: "I recently purchased the Razer BlackShark V2 X Gaming Headset, and it has significantly enhanced my gaming experience. This headset offers incredible sound quality, comfort, and features that are perfect for any serious gamer. Here’s why I highly recommend it: The 7.1 surround sound feature is a game-changer. The audio quality is superb, providing a truly immersive experience. I can clearly hear directional sounds, which is crucial for competitive gaming. The depth and clarity of the sound make it feel like I’m right in the middle of the action. The 50mm drivers deliver powerful, high-quality sound. The bass is deep and punchy without being overwhelming, while the mids and highs are crisp and clear. This balance makes the headset versatile, not only for gaming but also for listening to music and watching movies.", "output":{"type":"object","properties":{"sentiment":{"type":"string","description":"Sentiment (positive or negative)"},"products":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Name of the product"},"brand":{"type":"string","description":"Company that made the product"}}},"description":"Products mentioned in the review"},"anger":{"type":"boolean","description":"Is the reviewer expressing anger?"}},"required":["sentiment","products","anger"]}}'
 
 {
   "sentiment": "positive",
@@ -358,7 +358,7 @@ import { AIScriptServer } from '@isdk/ai-tool-agent';
 
 // Configure your script search path
 AIScriptEx.searchPaths = ['.']
-const script = AIScriptServer.load('examples/json')
+const script = AIScriptServer.load('examples/json.ai.yaml')
 // Set the default to large model streaming response
 script.llmStream = stream
 
@@ -401,31 +401,45 @@ Specific script instruction manual see: [Programmable Prompt Engine Specificatio
 # Commands
 
 <!-- commands -->
-* [`ai agent`](#ai-agent)
-* [`ai autocomplete [SHELL]`](#ai-autocomplete-shell)
-* [`ai brain [NAME]`](#ai-brain-name)
-* [`ai brain dn [NAME]`](#ai-brain-dn-name)
-* [`ai brain down [NAME]`](#ai-brain-down-name)
-* [`ai brain download [NAME]`](#ai-brain-download-name)
-* [`ai brain list [NAME]`](#ai-brain-list-name)
-* [`ai brain refresh`](#ai-brain-refresh)
-* [`ai brain search [NAME]`](#ai-brain-search-name)
-* [`ai config [ITEM_NAME]`](#ai-config-item_name)
-* [`ai config save [DATA]`](#ai-config-save-data)
-* [`ai help [COMMAND]`](#ai-help-command)
-* [`ai plugins`](#ai-plugins)
-* [`ai plugins add PLUGIN`](#ai-plugins-add-plugin)
-* [`ai plugins:inspect PLUGIN...`](#ai-pluginsinspect-plugin)
-* [`ai plugins install PLUGIN`](#ai-plugins-install-plugin)
-* [`ai plugins link PATH`](#ai-plugins-link-path)
-* [`ai plugins remove [PLUGIN]`](#ai-plugins-remove-plugin)
-* [`ai plugins reset`](#ai-plugins-reset)
-* [`ai plugins uninstall [PLUGIN]`](#ai-plugins-uninstall-plugin)
-* [`ai plugins unlink [PLUGIN]`](#ai-plugins-unlink-plugin)
-* [`ai plugins update`](#ai-plugins-update)
-* [`ai run [FILE] [DATA]`](#ai-run-file-data)
-* [`ai test [FILE]`](#ai-test-file)
-* [`ai version`](#ai-version)
+- [Offline AI PPE CLI(WIP)](#offline-ai-ppe-cliwip)
+- [Quick Start](#quick-start)
+  - [PPE CLI Command](#ppe-cli-command)
+  - [Programmable Prompt Engine Language](#programmable-prompt-engine-language)
+    - [I. Core Structure](#i-core-structure)
+    - [II. Reusability \& Configuration](#ii-reusability--configuration)
+    - [III. AI Capabilities](#iii-ai-capabilities)
+      - [IV. Message Text Formatting](#iv-message-text-formatting)
+    - [V. Script Capabilities](#v-script-capabilities)
+  - [Install](#install)
+  - [Run](#run)
+- [Usage](#usage)
+- [Commands](#commands)
+  - [`ai agent`](#ai-agent)
+  - [`ai autocomplete [SHELL]`](#ai-autocomplete-shell)
+  - [`ai brain [NAME]`](#ai-brain-name)
+  - [`ai brain dn [NAME]`](#ai-brain-dn-name)
+  - [`ai brain down [NAME]`](#ai-brain-down-name)
+  - [`ai brain download [NAME]`](#ai-brain-download-name)
+  - [`ai brain list [NAME]`](#ai-brain-list-name)
+  - [`ai brain refresh`](#ai-brain-refresh)
+  - [`ai brain search [NAME]`](#ai-brain-search-name)
+  - [`ai config [ITEM_NAME]`](#ai-config-item_name)
+  - [`ai config save [DATA]`](#ai-config-save-data)
+  - [`ai help [COMMAND]`](#ai-help-command)
+  - [`ai plugins`](#ai-plugins)
+  - [`ai plugins add PLUGIN`](#ai-plugins-add-plugin)
+  - [`ai plugins:inspect PLUGIN...`](#ai-pluginsinspect-plugin)
+  - [`ai plugins install PLUGIN`](#ai-plugins-install-plugin)
+  - [`ai plugins link PATH`](#ai-plugins-link-path)
+  - [`ai plugins remove [PLUGIN]`](#ai-plugins-remove-plugin)
+  - [`ai plugins reset`](#ai-plugins-reset)
+  - [`ai plugins uninstall [PLUGIN]`](#ai-plugins-uninstall-plugin)
+  - [`ai plugins unlink [PLUGIN]`](#ai-plugins-unlink-plugin)
+  - [`ai plugins update`](#ai-plugins-update)
+  - [`ai run [FILE] [DATA]`](#ai-run-file-data)
+  - [`ai test [FILE]`](#ai-test-file)
+  - [`ai version`](#ai-version)
+- [Credit](#credit)
 
 ## `ai agent`
 
diff --git a/package.json b/package.json
@@ -10,46 +10,45 @@
   "repository": "https://github.com/offline-ai/cli",
   "bugs": "https://github.com/@offline-ai/cli/issues",
   "dependencies": {
-    "@oclif/core": "^4.2.10",
-    "@oclif/plugin-autocomplete": "^3.2.25",
-    "@oclif/plugin-help": "^6.2.26",
-    "@oclif/plugin-not-found": "^3.2.45",
+    "@oclif/core": "^4.5.3",
+    "@oclif/plugin-autocomplete": "^3.2.34",
+    "@oclif/plugin-help": "^6.2.33",
+    "@oclif/plugin-not-found": "^3.2.68",
     "@oclif/plugin-plugins": "^5",
-    "@oclif/plugin-version": "^2.2.25",
-    "@oclif/plugin-warn-if-update-available": "^3.1.37",
+    "@oclif/plugin-version": "^2.2.33",
+    "@oclif/plugin-warn-if-update-available": "^3.1.48",
     "@offline-ai/cli-common": "workspace:*",
     "@offline-ai/cli-plugin-cmd-brain": "workspace:*",
     "@offline-ai/cli-plugin-cmd-config": "workspace:*",
     "@offline-ai/cli-plugin-cmd-test": "workspace:*",
     "@offline-ai/cli-plugin-core": "workspace:*",
     "ansi-colors": "^4.1.3",
-    "better-sqlite3": "^11.8.1",
+    "better-sqlite3": "*",
     "color-json": "^3.0.5",
     "enquirer": "^2.4.1",
     "lodash-es": "^4.17.21",
-    "log-update": "^6.1.0",
-    "node-fetch-native": "^1.6.6",
-    "util-ex": "2.2.1"
+    "log-update": "^7.0.0",
+    "node-fetch-native": "^1.6.7",
+    "util-ex": "2.3.0"
   },
   "devDependencies": {
-    "@oclif/prettier-config": "^0.2.1",
     "@oclif/test": "^4",
     "@types/chai": "^5",
     "@types/lodash-es": "^4.17.12",
     "@types/mocha": "^10",
-    "@types/node": "^22",
+    "@types/node": "^24.3.0",
     "chai": "^5",
-    "eslint": "^9",
-    "eslint-config-oclif": "^6.0.28",
-    "eslint-config-prettier": "^10",
+    "eslint": "^9.34.0",
+    "eslint-config-oclif": "^6.0.104",
+    "eslint-config-prettier": "^10.1.8",
     "mocha": "^11",
-    "oclif": "^4.17.41",
+    "oclif": "^4.22.16",
     "shx": "^0.3.4",
-    "terser": "^5.39.0",
+    "terser": "^5.44.0",
     "ts-node": "^10",
-    "tsup": "^8.4.0",
-    "tsx": "^4.19.3",
-    "typescript": "^5"
+    "tsup": "^8.5.0",
+    "tsx": "^4.20.5",
+    "typescript": "~5.7.3"
   },
   "engines": {
     "node": ">=18.0.0"
diff --git a/tsup.config.ts b/tsup.config.ts
@@ -7,7 +7,12 @@ export default defineConfig({
   // splitting: true,
   // sourcemap: true,
   clean: true,
-  minify: 'terser',
+  // minify: 'terser',
+  // esbuildOptions: (options) => {
+  //   options.banner = {
+  //       js: "import { createRequire } from 'module'; const require = createRequire(import.meta.url);",
+  //   }
+  // },
   terserOptions: {
     // compress: {
     //   drop_console: true,
