Signed-off-by: Christopher Barrera <cb@arda.tx.rr.com> Co-authored-by: Jared Van Bortel <cebtenzzre@gmail.com> |
||
---|---|---|
.. | ||
app.py | ||
developer_notes.md | ||
README.md |
GPT4All Command-Line Interface (CLI)
GPT4All on the command-line.
Documentation
https://docs.gpt4all.io/gpt4all_cli.html
Quickstart
The CLI is based on the gpt4all
Python bindings and the typer
package.
The following shows one way to get started with the CLI, the documentation has more information.
Typically, you will want to replace python
with python3
on Unix-like systems and py -3
on
Windows. Also, it's assumed you have all the necessary Python components already installed.
The CLI is a self-contained Python script named app.py (download). As long as its package dependencies are present, you can download and run it from wherever you like.
# optional but recommended: create and use a virtual environment
python -m venv gpt4all-cli
Windows and Unix-like systems differ slightly in how you activate a virtual environment:
- Unix-like, typically:
. gpt4all-cli/bin/activate
- Windows:
gpt4all-cli\Scripts\activate
Then:
# pip-install the necessary packages; omit '--user' if using a virtual environment
python -m pip install --user --upgrade gpt4all typer
# run the CLI
python app.py repl
By default, it will automatically download the groovy
model to .cache/gpt4all/
in your user
directory, if necessary.
If you have already saved a model beforehand, specify its path with the -m
/--model
argument,
for example:
python app.py repl --model /home/user/my-gpt4all-models/gpt4all-13b-snoozy-q4_0.gguf