Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sergei-mironov/aicli
A basic command-line interface for interacting with gpt4all ai runner using GNU Readline.
https://github.com/sergei-mironov/aicli
ai gpt gpt4all openai openai-api python python3 readline repl
Last synced: 5 days ago
JSON representation
A basic command-line interface for interacting with gpt4all ai runner using GNU Readline.
- Host: GitHub
- URL: https://github.com/sergei-mironov/aicli
- Owner: sergei-mironov
- Created: 2024-07-06T10:11:06.000Z (4 months ago)
- Default Branch: main
- Last Pushed: 2024-10-25T09:41:32.000Z (20 days ago)
- Last Synced: 2024-10-25T09:47:13.748Z (20 days ago)
- Topics: ai, gpt, gpt4all, openai, openai-api, python, python3, readline, repl
- Language: Python
- Homepage:
- Size: 122 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
A (yet another) GNU Readline-based application for interaction with chat-oriented AI models.
Supported model providers:
* [OpenAI](https://www.openai.com) via REST API
* [GPT4All](https://www.nomic.ai/gpt4all) via Python bindings
Contents
--------
* [Install](#install)
* [Pip](#pip)
* [Nix](#nix)
* [Usage](#usage)
* [Example session](#example-session)
* [Vim integration](#vim-integration)
Install
-------
The following installation options are available:
### Pip
```sh
$ pip install sm_aicli
```
### Nix
```sh
$ git clone --depth=1 https://github.com/sergei-mironov/aicli && cd aicli
# Optionally, change the 'nixpkgs' input of the flake.nix to a more suitable
$ nix profile install ".#python-aicli"
```
Usage
-----
``` result
usage: aicli [-h] [--model-dir MODEL_DIR] [--model [STR1:]STR2]
[--num-threads NUM_THREADS] [--model-apikey STR]
[--model-temperature MODEL_TEMPERATURE] [--device DEVICE]
[--readline-key-send READLINE_KEY_SEND]
[--readline-prompt READLINE_PROMPT] [--readline-history FILE]
[--verbose NUM] [--revision] [--version] [--no-rc]
Command-line arguments
options:
-h, --help show this help message and exit
--model-dir MODEL_DIR
Model directory to prepend to model file names
--model [STR1:]STR2, -m [STR1:]STR2
Model to use. STR1 is 'gpt4all' (the default) or
'openai'. STR2 is the model name
--num-threads NUM_THREADS, -t NUM_THREADS
Number of threads to use
--model-apikey STR Model provider-specific API key
--model-temperature MODEL_TEMPERATURE
Temperature parameter of the model
--device DEVICE, -d DEVICE
Device to use for chatbot, e.g. gpu, amd, nvidia,
intel. Defaults to CPU
--readline-key-send READLINE_KEY_SEND
Terminal code to treat as Ctrl+Enter (default: \C-k)
--readline-prompt READLINE_PROMPT
Input prompt (default: >>>)
--readline-history FILE
History file name (default is '_sm_aicli_history'; set
empty to disable)
--verbose NUM Set the verbosity level 0-no,1-full
--revision Print the revision
--version Print the version
--no-rc Do not read configuration files
```
The console accepts language defined by the following grammar:
``` result
start: (command | escape | text)? (command | escape | text)*
escape.3: /\\./
command.2: /\/ask|\/exit|\/help|\/reset/ | \
/\/model/ / +/ (/"/ model_string /"/ | /"/ /"/) | \
/\/apikey/ / +/ (/"/ apikey_string /"/ | /"/ /"/) | \
/\/nthreads/ / +/ (number | def) | \
/\/verbose/ / +/ (number | def) | \
/\/temp/ / +/ (float | def ) | \
/\/echo/ | /\/echo/ / /
model_string: (model_provider ":")? model_name
model_provider: "gpt4all" -> mp_gpt4all | "openai" -> mp_openai | "dummy" -> mp_dummy
model_name: /[^"]+/
apikey_string: (apikey_schema ":")? apikey_value
apikey_schema: "verbatim" -> as_verbatim | "file" -> as_file
apikey_value: /[^"]+/
number: /[0-9]+/
float: /[0-9]+\.[0-9]*/
def: "default"
text: /(.(?!\/|\\))*./s
```
If run without `--no-rc` arguemnt and no `AICLI_NORC` environmnet variable is set, the application
tries to read configuration files starting from the `/` directory down to the current directory. The
contents of `_aicli`, `.aicli`, `_sm_aicli` and `.sm_aicli` files is interpreted as commands.
### Example session
``` sh
$ aicli
```
``` txt
Type /help or a question followed by the /ask command (or by pressing `C-k` key).
>>> /model "~/.local/share/nomic.ai/GPT4All/Meta-Llama-3-8B-Instruct.Q4_0.gguf"
>>> Hi!
>>> /ask
Hello! I'm happy to help you. What's on your mind?^C
>>> What's your name?
>>> /ask
I don't really have a personal name, but you can call me "Assistant"
```
Vim integration
---------------
Aicli is supported by the [Litrepl](https://github.com/sergei-mironov/litrepl) text processor.
