Skip to content

Commit

Permalink
docs: update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
@snowyu
snowyu committed Aug 28, 2024
1 parent 4b22143 commit 78a300b
Showing 1 changed file with 35 additions and 49 deletions.
84 changes: 35 additions & 49 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ Developing an intelligent application with AI Agent Script Engine involves just
* One-click packaging into standalone intelligent applications (TODO)

<!-- toc -->
* [Offline AI Client(WIP)](#offline-ai-clientwip)
* [Offline AI PPE CLI(WIP)](#offline-ai-ppe-cliwip)
* [Quick Start](#quick-start)
* [API mode, translate the TODO file to English](#api-mode-translate-the-todo-file-to-english)
* [interactive mode](#interactive-mode)
Expand Down Expand Up @@ -342,45 +342,31 @@ Specific script instruction manual see: [Programmable Prompt Engine Specificatio
# Commands

<!-- commands -->
- [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`](#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)

## `ai agent`

Expand Down Expand Up @@ -483,7 +469,7 @@ EXAMPLES
$ ai brain download <brain-name>
```

_See code: [@offline-ai/cli-plugin-cmd-brain](https://github.com/offline-ai/cli-plugin-cmd-brain.js/blob/v0.3.6/src/commands/brain/index.ts)_
_See code: [@offline-ai/cli-plugin-cmd-brain](https://github.com/offline-ai/cli-plugin-cmd-brain.js/blob/v0.3.7/src/commands/brain/index.ts)_

## `ai brain dn [NAME]`

Expand Down Expand Up @@ -614,7 +600,7 @@ EXAMPLES
$ ai brain download <brain-name> [-q <QUANT>]
```

_See code: [@offline-ai/cli-plugin-cmd-brain](https://github.com/offline-ai/cli-plugin-cmd-brain.js/blob/v0.3.6/src/commands/brain/download.ts)_
_See code: [@offline-ai/cli-plugin-cmd-brain](https://github.com/offline-ai/cli-plugin-cmd-brain.js/blob/v0.3.7/src/commands/brain/download.ts)_

## `ai brain list [NAME]`

Expand Down Expand Up @@ -644,7 +630,7 @@ GLOBAL FLAGS
--json Format output as json.
```

_See code: [@offline-ai/cli-plugin-cmd-brain](https://github.com/offline-ai/cli-plugin-cmd-brain.js/blob/v0.3.6/src/commands/brain/list.ts)_
_See code: [@offline-ai/cli-plugin-cmd-brain](https://github.com/offline-ai/cli-plugin-cmd-brain.js/blob/v0.3.7/src/commands/brain/list.ts)_

## `ai brain refresh`

Expand All @@ -669,7 +655,7 @@ DESCRIPTION
refresh/update brain index from huggingface.co
```

_See code: [@offline-ai/cli-plugin-cmd-brain](https://github.com/offline-ai/cli-plugin-cmd-brain.js/blob/v0.3.6/src/commands/brain/refresh.ts)_
_See code: [@offline-ai/cli-plugin-cmd-brain](https://github.com/offline-ai/cli-plugin-cmd-brain.js/blob/v0.3.7/src/commands/brain/refresh.ts)_

## `ai brain search [NAME]`

Expand Down Expand Up @@ -699,7 +685,7 @@ GLOBAL FLAGS
--json Format output as json.
```

_See code: [@offline-ai/cli-plugin-cmd-brain](https://github.com/offline-ai/cli-plugin-cmd-brain.js/blob/v0.3.6/src/commands/brain/search.ts)_
_See code: [@offline-ai/cli-plugin-cmd-brain](https://github.com/offline-ai/cli-plugin-cmd-brain.js/blob/v0.3.7/src/commands/brain/search.ts)_

## `ai config [ITEM_NAME]`

Expand Down Expand Up @@ -762,7 +748,7 @@ EXAMPLES
}
```

_See code: [@offline-ai/cli-plugin-cmd-config](https://github.com/offline-ai/cli-plugin-cmd-config.js/blob/v0.1.8/src/commands/config/index.ts)_
_See code: [@offline-ai/cli-plugin-cmd-config](https://github.com/offline-ai/cli-plugin-cmd-config.js/blob/v0.1.9/src/commands/config/index.ts)_

## `ai config save [DATA]`

Expand Down Expand Up @@ -811,7 +797,7 @@ GLOBAL FLAGS
--json Format output as json.
```

_See code: [@offline-ai/cli-plugin-cmd-config](https://github.com/offline-ai/cli-plugin-cmd-config.js/blob/v0.1.8/src/commands/config/save.ts)_
_See code: [@offline-ai/cli-plugin-cmd-config](https://github.com/offline-ai/cli-plugin-cmd-config.js/blob/v0.1.9/src/commands/config/save.ts)_

## `ai help [COMMAND]`

Expand Down Expand Up @@ -1181,7 +1167,7 @@ EXAMPLES
│[info]:Start Script: ...
```

_See code: [@offline-ai/cli-plugin-core](https://github.com/offline-ai/cli-plugin-core.js/blob/v0.5.3/src/commands/run/index.ts)_
_See code: [@offline-ai/cli-plugin-core](https://github.com/offline-ai/cli-plugin-core.js/blob/v0.6.0/src/commands/run/index.ts)_

## `ai test`

Expand Down Expand Up @@ -1237,7 +1223,7 @@ EXAMPLES
$ ai test -f ./fixture.yaml -l info
```

_See code: [@offline-ai/cli-plugin-cmd-test](https://github.com/offline-ai/cli-plugin-cmd-test.js/blob/v0.1.7/src/commands/test/index.ts)_
_See code: [@offline-ai/cli-plugin-cmd-test](https://github.com/offline-ai/cli-plugin-cmd-test.js/blob/v0.1.8/src/commands/test/index.ts)_

## `ai version`

Expand Down

0 comments on commit 78a300b

Please sign in to comment.