Skip to content

Commit

Permalink
docs: update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
snowyu committed Aug 31, 2024
1 parent dcc2ec9 commit 709a0b9
Show file tree
Hide file tree
Showing 2 changed files with 43 additions and 25 deletions.
2 changes: 2 additions & 0 deletions README.cn.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,8 @@ AI Agent 脚本引擎特点:

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

### Install

Expand Down
66 changes: 41 additions & 25 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,8 @@ Developing an intelligent application with AI Agent Script Engine involves just

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

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

Expand Down Expand Up @@ -342,31 +344,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`](#ai-test)
* [`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`](#ai-test)
- [`ai version`](#ai-version)
- [Credit](#credit)

## `ai agent`

Expand Down

0 comments on commit 709a0b9

Please sign in to comment.