Skip to content

Commit fde3ca3

Browse files
committed
docs: update readme
1 parent ed800b8 commit fde3ca3

File tree

2 files changed

+36
-33
lines changed

2 files changed

+36
-33
lines changed

README.cn.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -22,8 +22,8 @@ AI Agent 脚本引擎特点:
2222
2. 特长的选择,不同的脑子训练的方式不同,训练的素材(dataset)不同,特长也不同...
2323
3. 选择合适的量化程度,量化(压缩)程度越大,速度越快,体积越小,精度越差...
2424
4. 选择合适的最大窗口正文长度(`content_size`), 一般 2048 足够, 这个参数也会影响模型的性能...
25-
5. 然后直接使用客户端(`@offline-ai/client`)下载: `ai brain download`
26-
2. 创建应用的智能代理脚本文件,使用客户端(`@offline-ai/client`)调试代理提示词
25+
5. 然后直接使用客户端(`@offline-ai/cli`)下载: `ai brain download`
26+
2. 创建应用的智能代理脚本文件,使用客户端(`@offline-ai/cli`)调试代理提示词
2727
3. 嵌入到自己的应用中
2828

2929
## Usage

README.md

+34-31
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ The AI agent script CLI
1818
Developing an intelligent application with AI Agent Script Engine involves just three steps:
1919

2020
* Choose an appropriate brain🧠 (LLM Large Language Model)
21-
* Select a parameter size based on your application's requirements; larger sizes offer better performance but consume more resources and increase response time...
21+
* Select a parameter size based on your application's requirements; larger sizes offer better quality but consume more resources and increase response time...
2222
* Choose the model's expertise: Different models are trained with distinct methods and datasets, resulting in unique capabilities...
2323
* Optimize quantization: Higher levels of quantization (compression) result in faster speed and smaller size, but potentially lower accuracy...
2424
* Decide on the optimal context window size (`content_size`): Typically, 2048 is sufficient; this parameter also influences model performance...
@@ -40,7 +40,7 @@ $ npm install -g @offline-ai/cli
4040
$ ai COMMAND
4141
running command...
4242
$ ai (--version)
43-
@offline-ai/cli/0.0.4 linux-x64 node-v20.14.0
43+
@offline-ai/cli/0.0.5 linux-x64 node-v20.14.0
4444
$ ai --help [COMMAND]
4545
USAGE
4646
$ ai COMMAND
@@ -166,28 +166,31 @@ Specific script instruction manual see: [ai-tool-agent](https://www.npmjs.com/pa
166166
## Commands
167167

168168
<!-- commands -->
169-
* [`ai agent`](#ai-agent)
170-
* [`ai autocomplete [SHELL]`](#ai-autocomplete-shell)
171-
* [`ai brain [NAME]`](#ai-brain-name)
172-
* [`ai brain dn [NAME]`](#ai-brain-dn-name)
173-
* [`ai brain down [NAME]`](#ai-brain-down-name)
174-
* [`ai brain download [NAME]`](#ai-brain-download-name)
175-
* [`ai brain list [NAME]`](#ai-brain-list-name)
176-
* [`ai config [ITEM_NAME]`](#ai-config-item_name)
177-
* [`ai config save [DATA]`](#ai-config-save-data)
178-
* [`ai help [COMMAND]`](#ai-help-command)
179-
* [`ai plugins`](#ai-plugins)
180-
* [`ai plugins add PLUGIN`](#ai-plugins-add-plugin)
181-
* [`ai plugins:inspect PLUGIN...`](#ai-pluginsinspect-plugin)
182-
* [`ai plugins install PLUGIN`](#ai-plugins-install-plugin)
183-
* [`ai plugins link PATH`](#ai-plugins-link-path)
184-
* [`ai plugins remove [PLUGIN]`](#ai-plugins-remove-plugin)
185-
* [`ai plugins reset`](#ai-plugins-reset)
186-
* [`ai plugins uninstall [PLUGIN]`](#ai-plugins-uninstall-plugin)
187-
* [`ai plugins unlink [PLUGIN]`](#ai-plugins-unlink-plugin)
188-
* [`ai plugins update`](#ai-plugins-update)
189-
* [`ai run [DATA]`](#ai-run-data)
190-
* [`ai version`](#ai-version)
169+
- [ai-agent](#ai-agent)
170+
- [Usage](#usage)
171+
- [Commands](#commands)
172+
- [`ai agent`](#ai-agent-1)
173+
- [`ai autocomplete [SHELL]`](#ai-autocomplete-shell)
174+
- [`ai brain [NAME]`](#ai-brain-name)
175+
- [`ai brain dn [NAME]`](#ai-brain-dn-name)
176+
- [`ai brain down [NAME]`](#ai-brain-down-name)
177+
- [`ai brain download [NAME]`](#ai-brain-download-name)
178+
- [`ai brain list [NAME]`](#ai-brain-list-name)
179+
- [`ai config [ITEM_NAME]`](#ai-config-item_name)
180+
- [`ai config save [DATA]`](#ai-config-save-data)
181+
- [`ai help [COMMAND]`](#ai-help-command)
182+
- [`ai plugins`](#ai-plugins)
183+
- [`ai plugins add PLUGIN`](#ai-plugins-add-plugin)
184+
- [`ai plugins:inspect PLUGIN...`](#ai-pluginsinspect-plugin)
185+
- [`ai plugins install PLUGIN`](#ai-plugins-install-plugin)
186+
- [`ai plugins link PATH`](#ai-plugins-link-path)
187+
- [`ai plugins remove [PLUGIN]`](#ai-plugins-remove-plugin)
188+
- [`ai plugins reset`](#ai-plugins-reset)
189+
- [`ai plugins uninstall [PLUGIN]`](#ai-plugins-uninstall-plugin)
190+
- [`ai plugins unlink [PLUGIN]`](#ai-plugins-unlink-plugin)
191+
- [`ai plugins update`](#ai-plugins-update)
192+
- [`ai run [DATA]`](#ai-run-data)
193+
- [`ai version`](#ai-version)
191194

192195
## `ai agent`
193196

@@ -206,7 +209,7 @@ EXAMPLES
206209
$ ai agent publish <agent-name>
207210
```
208211

209-
_See code: [src/commands/agent/index.ts](https://github.com/offline-ai/cli/blob/v0.0.4/src/commands/agent/index.ts)_
212+
_See code: [src/commands/agent/index.ts](https://github.com/offline-ai/cli/blob/v0.0.5/src/commands/agent/index.ts)_
210213

211214
## `ai autocomplete [SHELL]`
212215

@@ -278,7 +281,7 @@ EXAMPLES
278281
$ ai brain download <brain-name>
279282
```
280283

281-
_See code: [src/commands/brain/index.ts](https://github.com/offline-ai/cli/blob/v0.0.4/src/commands/brain/index.ts)_
284+
_See code: [src/commands/brain/index.ts](https://github.com/offline-ai/cli/blob/v0.0.5/src/commands/brain/index.ts)_
282285

283286
## `ai brain dn [NAME]`
284287

@@ -406,7 +409,7 @@ EXAMPLES
406409
$ ai brain download <brain-name> [-q <QUANT>]
407410
```
408411

409-
_See code: [src/commands/brain/download.ts](https://github.com/offline-ai/cli/blob/v0.0.4/src/commands/brain/download.ts)_
412+
_See code: [src/commands/brain/download.ts](https://github.com/offline-ai/cli/blob/v0.0.5/src/commands/brain/download.ts)_
410413

411414
## `ai brain list [NAME]`
412415

@@ -434,7 +437,7 @@ GLOBAL FLAGS
434437
--json Format output as json.
435438
```
436439

437-
_See code: [src/commands/brain/list.ts](https://github.com/offline-ai/cli/blob/v0.0.4/src/commands/brain/list.ts)_
440+
_See code: [src/commands/brain/list.ts](https://github.com/offline-ai/cli/blob/v0.0.5/src/commands/brain/list.ts)_
438441

439442
## `ai config [ITEM_NAME]`
440443

@@ -471,7 +474,7 @@ EXAMPLES
471474
}
472475
```
473476

474-
_See code: [src/commands/config/index.ts](https://github.com/offline-ai/cli/blob/v0.0.4/src/commands/config/index.ts)_
477+
_See code: [src/commands/config/index.ts](https://github.com/offline-ai/cli/blob/v0.0.5/src/commands/config/index.ts)_
475478

476479
## `ai config save [DATA]`
477480

@@ -511,7 +514,7 @@ GLOBAL FLAGS
511514
--json Format output as json.
512515
```
513516

514-
_See code: [src/commands/config/save.ts](https://github.com/offline-ai/cli/blob/v0.0.4/src/commands/config/save.ts)_
517+
_See code: [src/commands/config/save.ts](https://github.com/offline-ai/cli/blob/v0.0.5/src/commands/config/save.ts)_
515518

516519
## `ai help [COMMAND]`
517520

@@ -870,7 +873,7 @@ EXAMPLES
870873
│[info]:Start Script: ...
871874
```
872875

873-
_See code: [src/commands/run/index.ts](https://github.com/offline-ai/cli/blob/v0.0.4/src/commands/run/index.ts)_
876+
_See code: [src/commands/run/index.ts](https://github.com/offline-ai/cli/blob/v0.0.5/src/commands/run/index.ts)_
874877

875878
## `ai version`
876879

0 commit comments

Comments
 (0)