Skip to content

Commit 709a0b9

Browse files
committed
docs: update readme
1 parent dcc2ec9 commit 709a0b9

File tree

2 files changed

+43
-25
lines changed

2 files changed

+43
-25
lines changed

README.cn.md

+2
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,8 @@ AI Agent 脚本引擎特点:
3737

3838
* [快速上手编程值南](./guide-cn.md)
3939
* 更多的例子: [examples](./examples)
40+
* [智能编程指南 - AI 应用](./guide/) - WIP
41+
* 在项目根目录下运行 `ai run guide --streamEcho line`
4042

4143
### Install
4244

README.md

+41-25
Original file line numberDiff line numberDiff line change
@@ -47,6 +47,8 @@ Developing an intelligent application with AI Agent Script Engine involves just
4747

4848
* [Quick Start Programming Guide](./guide.md)
4949
* [More examples](./examples)
50+
* [Guide AI App](./guide/) - WIP
51+
* `ai run guide --streamEcho line` in the project root folder to run the guide
5052

5153
## [PPE CLI Command](./guide/cli.md)
5254

@@ -342,31 +344,45 @@ Specific script instruction manual see: [Programmable Prompt Engine Specificatio
342344
# Commands
343345

344346
<!-- commands -->
345-
* [`ai agent`](#ai-agent)
346-
* [`ai autocomplete [SHELL]`](#ai-autocomplete-shell)
347-
* [`ai brain [NAME]`](#ai-brain-name)
348-
* [`ai brain dn [NAME]`](#ai-brain-dn-name)
349-
* [`ai brain down [NAME]`](#ai-brain-down-name)
350-
* [`ai brain download [NAME]`](#ai-brain-download-name)
351-
* [`ai brain list [NAME]`](#ai-brain-list-name)
352-
* [`ai brain refresh`](#ai-brain-refresh)
353-
* [`ai brain search [NAME]`](#ai-brain-search-name)
354-
* [`ai config [ITEM_NAME]`](#ai-config-item_name)
355-
* [`ai config save [DATA]`](#ai-config-save-data)
356-
* [`ai help [COMMAND]`](#ai-help-command)
357-
* [`ai plugins`](#ai-plugins)
358-
* [`ai plugins add PLUGIN`](#ai-plugins-add-plugin)
359-
* [`ai plugins:inspect PLUGIN...`](#ai-pluginsinspect-plugin)
360-
* [`ai plugins install PLUGIN`](#ai-plugins-install-plugin)
361-
* [`ai plugins link PATH`](#ai-plugins-link-path)
362-
* [`ai plugins remove [PLUGIN]`](#ai-plugins-remove-plugin)
363-
* [`ai plugins reset`](#ai-plugins-reset)
364-
* [`ai plugins uninstall [PLUGIN]`](#ai-plugins-uninstall-plugin)
365-
* [`ai plugins unlink [PLUGIN]`](#ai-plugins-unlink-plugin)
366-
* [`ai plugins update`](#ai-plugins-update)
367-
* [`ai run [FILE] [DATA]`](#ai-run-file-data)
368-
* [`ai test`](#ai-test)
369-
* [`ai version`](#ai-version)
347+
- [Offline AI PPE CLI(WIP)](#offline-ai-ppe-cliwip)
348+
- [Quick Start](#quick-start)
349+
- [PPE CLI Command](#ppe-cli-command)
350+
- [Programmable Prompt Engine Language](#programmable-prompt-engine-language)
351+
- [I. Core Structure](#i-core-structure)
352+
- [II. Reusability \& Configuration](#ii-reusability--configuration)
353+
- [III. AI Capabilities](#iii-ai-capabilities)
354+
- [IV. Message Text Formatting](#iv-message-text-formatting)
355+
- [V. Script Capabilities](#v-script-capabilities)
356+
- [Install](#install)
357+
- [Run](#run)
358+
- [Usage](#usage)
359+
- [Commands](#commands)
360+
- [`ai agent`](#ai-agent)
361+
- [`ai autocomplete [SHELL]`](#ai-autocomplete-shell)
362+
- [`ai brain [NAME]`](#ai-brain-name)
363+
- [`ai brain dn [NAME]`](#ai-brain-dn-name)
364+
- [`ai brain down [NAME]`](#ai-brain-down-name)
365+
- [`ai brain download [NAME]`](#ai-brain-download-name)
366+
- [`ai brain list [NAME]`](#ai-brain-list-name)
367+
- [`ai brain refresh`](#ai-brain-refresh)
368+
- [`ai brain search [NAME]`](#ai-brain-search-name)
369+
- [`ai config [ITEM_NAME]`](#ai-config-item_name)
370+
- [`ai config save [DATA]`](#ai-config-save-data)
371+
- [`ai help [COMMAND]`](#ai-help-command)
372+
- [`ai plugins`](#ai-plugins)
373+
- [`ai plugins add PLUGIN`](#ai-plugins-add-plugin)
374+
- [`ai plugins:inspect PLUGIN...`](#ai-pluginsinspect-plugin)
375+
- [`ai plugins install PLUGIN`](#ai-plugins-install-plugin)
376+
- [`ai plugins link PATH`](#ai-plugins-link-path)
377+
- [`ai plugins remove [PLUGIN]`](#ai-plugins-remove-plugin)
378+
- [`ai plugins reset`](#ai-plugins-reset)
379+
- [`ai plugins uninstall [PLUGIN]`](#ai-plugins-uninstall-plugin)
380+
- [`ai plugins unlink [PLUGIN]`](#ai-plugins-unlink-plugin)
381+
- [`ai plugins update`](#ai-plugins-update)
382+
- [`ai run [FILE] [DATA]`](#ai-run-file-data)
383+
- [`ai test`](#ai-test)
384+
- [`ai version`](#ai-version)
385+
- [Credit](#credit)
370386

371387
## `ai agent`
372388

0 commit comments

Comments
 (0)