Offline AI Client Core(WIP)

> 【English|中文】
---
The Offline AI Client core plugin.


Features:

* User-friendly for ai development and creation of intelligent applications...
* Low-code or even no-code solutions for rapid ai development...
* Flexible, adding custom instructions within scripts, and inter-script calls...
* The data is completely open to the script, and the input and output data, even the internal data, can be freely accessed in the script
* Powerful, enabling event transmission seamlessly between client and server with numerous utility functions...
* Secure, supporting encrypted execution and usage limits for scripts(TODO)...
* The AI Agent Script follows the Programmable Prompt Engine Specification.
* Visit the site for the detailed AI Agent script usage.

* Offline AI Client Core(WIP)
* Install
* Commands
* Credit

Install

``bash
npm install -g @offline-ai/cli
`

Commands


* [ai run [FILE] [DATA]](#ai-run-file-data)

ai run [FILE] [DATA]

💻 Run ai-agent script file.

`
USAGE
$ ai run [FILE] [DATA] [--json] [--config ] [--banner] [-u ] [--apiKey ] [-s
...] [--logLevelMaxLen -l trace|debug|verbose|info|notice|warn|error|fatal|print|silence]
[--histories ] [-n] [-k] [-t -i] [--no-chats] [--no-inputs ] [-m] [-f ] [-d ] [-D
...] [-a ] [-b ] [-p ...] [-L ] [-A ] [-e true|false|line] [-C ]
[-P ] [--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.
-C, --streamEchoChars= [default: 80] stream echo max characters limit
-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.
-P, --provider= the LLM provider, defaults to llamacpp
-a, --arguments= the json data which will be passed to the ai-agent script
-b, --brainDir= the brains(LLM) directory
-d, --dataFile= the data file which will be passed to the ai-agent script
-e, --streamEcho= [default: line] stream echo mode

-f, --script= the ai-agent script file name or id
-i, --[no-]interactive interactive mode
-k, --backupChat whether to backup chat history before start, defaults to false
-l, --logLevel= the log level

-m, --[no-]stream stream mode, defaults to true
-n, --[no-]newChat whether to start a new chat history, defaults to false in interactive mode, true
in non-interactive
-p, --promptDirs=... the prompts template directory
-s, --agentDirs=... the search paths for ai-agent script file
-t, --inputs= the input histories folder for interactive mode to record
-u, --api= the api URL
--apiKey= the api key (optional)
--[no-]banner show banner
--config= the config file
--[no-]consoleClear Whether console clear after stream echo output, default to true
--histories= the chat histories folder to record
--logLevelMaxLen= the max length of log item to display
--no-chats disable chat histories, defaults to false
--no-inputs disable input histories, defaults to false

GLOBAL FLAGS
--json Format output as json.

DESCRIPTION
💻 Run ai-agent script file.

Execute ai-agent script file and return result. with -i to interactive.

EXAMPLES
$ ai run -f ./script.yaml "{content: 'hello world'}" -l info
┌────────────────────
│[info]:Start Script: ...
``

_See code: src/commands/run/index.ts_

Credit

* OpenAI
* HuggingFace
* llama-cpp