From 9ca9238603f2fbd9dd0042c02b359eff52aaa04b Mon Sep 17 00:00:00 2001 From: Riceball LEE Date: Wed, 28 Aug 2024 18:27:46 +0800 Subject: [PATCH] docs: update readme --- README.md | 12 +++++++----- 1 file changed, 7 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 001c8fa..dcaf9b6 100644 --- a/README.md +++ b/README.md @@ -36,25 +36,27 @@ npm install -g @offline-ai/cli # Commands -* [`ai run [DATA]`](#ai-run-data) +* [`ai run [FILE] [DATA]`](#ai-run-file-data) -## `ai run [DATA]` +## `ai run [FILE] [DATA]` 💻 Run ai-agent script file. ``` USAGE - $ ai run [DATA] [--json] [-c ] [--banner] [-u ] [-s ...] [-l + $ ai run [FILE] [DATA] [--json] [-c ] [--banner] [-u ] [-s ...] [-l silence|fatal|error|warn|info|debug|trace] [-h ] [-n] [-k] [-t -i] [--no-chats] [--no-inputs ] [-m] - [-f ] [-d ] [-a ] [-b ] [-p ...] [-L ] [-A ] [-e true|false|line] - [--consoleClear] + [-f ] [-d ] [-D ...] [-a ] [-b ] [-p ...] [-L ] [-A ] [-e + true|false|line] [--consoleClear] ARGUMENTS + FILE the script file path, or the json data when `-f` switch is set DATA the json data which will be passed to the ai-agent script FLAGS -A, --aiPreferredLanguage= the ISO 639-1 code for the AI preferred language to translate the user input automatically, eg, en, etc. + -D, --data=... the data which will be passed to the ai-agent script: key1=value1 key2=value2 -L, --userPreferredLanguage= the ISO 639-1 code for the user preferred language to translate the AI result automatically, eg, en, zh, ja, ko, etc. -a, --arguments= the json data which will be passed to the ai-agent script