Skip to content

Commit 2f530fc

Browse files
committed
docs: update
1 parent 591ae70 commit 2f530fc

File tree

1 file changed

+42
-28
lines changed

1 file changed

+42
-28
lines changed

README.md

Lines changed: 42 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ Enjoying this project? Please star it! 🌟
3232
* You can specify or arbitrarily switch LLM large model files in the PPE script.
3333
* By default, it automatically detects memory and GPU, and uses the best computing layer by default. It automatically allocates gpu - layers and context window size (it will adopt the largest possible value) to get the best performance from the hardware without manually configuring anything.
3434
* It is recommended to configure the context window yourself.
35-
* System security: Support for system template anti - injection (to avoid jailbreaking).
35+
* System security: Support for system template anti-injection (to avoid jailbreaking).
3636
* Support for general tool invocation (Tool Funcs) of large models (only for builtin local LLM provider):
3737
* Can be supported without specific training of large models, requiring strong instruction - following ability of the large model.
3838
* Minimum adaptation for 3B models, recommended to use 7B and above.
@@ -211,7 +211,7 @@ $ npm install -g @offline-ai/cli
211211
$ ai COMMAND
212212
running command...
213213
$ ai (--version)
214-
@offline-ai/cli/0.9.3 linux-x64 node-v20.18.0
214+
@offline-ai/cli/0.9.4 linux-x64 node-v20.18.0
215215
$ ai --help [COMMAND]
216216
USAGE
217217
$ ai COMMAND
@@ -389,31 +389,45 @@ Specific script instruction manual see: [Programmable Prompt Engine Specificatio
389389
# Commands
390390

391391
<!-- commands -->
392-
* [`ai agent`](#ai-agent)
393-
* [`ai autocomplete [SHELL]`](#ai-autocomplete-shell)
394-
* [`ai brain [NAME]`](#ai-brain-name)
395-
* [`ai brain dn [NAME]`](#ai-brain-dn-name)
396-
* [`ai brain down [NAME]`](#ai-brain-down-name)
397-
* [`ai brain download [NAME]`](#ai-brain-download-name)
398-
* [`ai brain list [NAME]`](#ai-brain-list-name)
399-
* [`ai brain refresh`](#ai-brain-refresh)
400-
* [`ai brain search [NAME]`](#ai-brain-search-name)
401-
* [`ai config [ITEM_NAME]`](#ai-config-item_name)
402-
* [`ai config save [DATA]`](#ai-config-save-data)
403-
* [`ai help [COMMAND]`](#ai-help-command)
404-
* [`ai plugins`](#ai-plugins)
405-
* [`ai plugins add PLUGIN`](#ai-plugins-add-plugin)
406-
* [`ai plugins:inspect PLUGIN...`](#ai-pluginsinspect-plugin)
407-
* [`ai plugins install PLUGIN`](#ai-plugins-install-plugin)
408-
* [`ai plugins link PATH`](#ai-plugins-link-path)
409-
* [`ai plugins remove [PLUGIN]`](#ai-plugins-remove-plugin)
410-
* [`ai plugins reset`](#ai-plugins-reset)
411-
* [`ai plugins uninstall [PLUGIN]`](#ai-plugins-uninstall-plugin)
412-
* [`ai plugins unlink [PLUGIN]`](#ai-plugins-unlink-plugin)
413-
* [`ai plugins update`](#ai-plugins-update)
414-
* [`ai run [FILE] [DATA]`](#ai-run-file-data)
415-
* [`ai test [FILE]`](#ai-test-file)
416-
* [`ai version`](#ai-version)
392+
- [Offline AI PPE CLI(WIP)](#offline-ai-ppe-cliwip)
393+
- [Quick Start](#quick-start)
394+
- [PPE CLI Command](#ppe-cli-command)
395+
- [Programmable Prompt Engine Language](#programmable-prompt-engine-language)
396+
- [I. Core Structure](#i-core-structure)
397+
- [II. Reusability \& Configuration](#ii-reusability--configuration)
398+
- [III. AI Capabilities](#iii-ai-capabilities)
399+
- [IV. Message Text Formatting](#iv-message-text-formatting)
400+
- [V. Script Capabilities](#v-script-capabilities)
401+
- [Install](#install)
402+
- [Run](#run)
403+
- [Usage](#usage)
404+
- [Commands](#commands)
405+
- [`ai agent`](#ai-agent)
406+
- [`ai autocomplete [SHELL]`](#ai-autocomplete-shell)
407+
- [`ai brain [NAME]`](#ai-brain-name)
408+
- [`ai brain dn [NAME]`](#ai-brain-dn-name)
409+
- [`ai brain down [NAME]`](#ai-brain-down-name)
410+
- [`ai brain download [NAME]`](#ai-brain-download-name)
411+
- [`ai brain list [NAME]`](#ai-brain-list-name)
412+
- [`ai brain refresh`](#ai-brain-refresh)
413+
- [`ai brain search [NAME]`](#ai-brain-search-name)
414+
- [`ai config [ITEM_NAME]`](#ai-config-item_name)
415+
- [`ai config save [DATA]`](#ai-config-save-data)
416+
- [`ai help [COMMAND]`](#ai-help-command)
417+
- [`ai plugins`](#ai-plugins)
418+
- [`ai plugins add PLUGIN`](#ai-plugins-add-plugin)
419+
- [`ai plugins:inspect PLUGIN...`](#ai-pluginsinspect-plugin)
420+
- [`ai plugins install PLUGIN`](#ai-plugins-install-plugin)
421+
- [`ai plugins link PATH`](#ai-plugins-link-path)
422+
- [`ai plugins remove [PLUGIN]`](#ai-plugins-remove-plugin)
423+
- [`ai plugins reset`](#ai-plugins-reset)
424+
- [`ai plugins uninstall [PLUGIN]`](#ai-plugins-uninstall-plugin)
425+
- [`ai plugins unlink [PLUGIN]`](#ai-plugins-unlink-plugin)
426+
- [`ai plugins update`](#ai-plugins-update)
427+
- [`ai run [FILE] [DATA]`](#ai-run-file-data)
428+
- [`ai test [FILE]`](#ai-test-file)
429+
- [`ai version`](#ai-version)
430+
- [Credit](#credit)
417431

418432
## `ai agent`
419433

@@ -441,7 +455,7 @@ EXAMPLES
441455
$ ai agent publish <agent-name>
442456
```
443457

444-
_See code: [src/commands/agent/index.ts](https://github.com/offline-ai/cli/blob/v0.9.3/src/commands/agent/index.ts)_
458+
_See code: [src/commands/agent/index.ts](https://github.com/offline-ai/cli/blob/v0.9.4/src/commands/agent/index.ts)_
445459

446460
## `ai autocomplete [SHELL]`
447461

0 commit comments

Comments
 (0)