paul
/
llm-chat
1
0
Fork 0
Code Issues 5 Pull Requests Packages Projects Releases 3 Wiki Activity
23 Commits 1 Branch 3 Tags 478 KiB
Python 97%
Makefile 3%
Go to file
Paul Harrison a5ece48ba8 Incorporate custom bots into chat CLI 
This commit will add the ability to create custom bots in the form of
automatically prepending additional bot-specific context to your chat
session. A new `chat` CLI argument will be added allowing users to
provide the name of an existing bot. For example:

```
llm chat -b "My Bot"
```

An addional `bot` CLI is added for creating and removing bots.

Closes #13
 		2024-06-27 17:04:44 +01:00
src/llm_chat Incorporate custom bots into chat CLI 2024-06-27 17:04:44 +01:00
tests Incorporate custom bots into chat CLI 2024-06-27 17:04:44 +01:00
.gitignore Add macOS files to .gitignore 2024-02-17 15:46:15 +00:00
LICENSE Initial commit 2023-08-13 19:53:05 +01:00
Makefile Add linting checks and code formatting 2023-08-16 10:10:06 +01:00
README.md Add installation and usage instructions 2023-09-28 13:14:26 +01:00
llm-chat.png Add installation and usage instructions 2023-09-28 13:14:26 +01:00
poetry.lock Bot create and load class methods 2024-02-23 16:52:56 +00:00
pyproject.toml Incorporate custom bots into chat CLI 2024-06-27 17:04:44 +01:00

README.md

LLM Chat

This project is currently a CLI interface for OpenAI's GPT model API. The long term goal is to be much more general and interface with any LLM, whether that be a cloud service or a model running locally.

Usage

Installation

The package is not currently published so you will need to build it yourself. To do so you will need Poetry v1.5 or later. Once you have that installed, run the following commands:

git clone https://code.harrison.sh/paul/llm-chat.git
cd llm-chat
poetry build

This will create a wheel file in the dist directory. You can then install it with pip:

pip install dist/llm_chat-0.6.1-py3-none-any.whl

Note, a much better way to install this package system wide is to use pipx. This will install the package in an isolated environment and make the llm command available on your path.

Configuration

Your OpenAI API key must be set in the OPENAI_API_KEY environment variable. The following additional environment variables are supported:

Variable Description
OPENAI_MODEL The model to use. Defaults to gpt-3.5-turbo.
OPENAI_TEMPERATURE The temperature to use when generating text. Defaults to 0.7.
OPENAI_HISTORY_DIR The directory to store chat history in. Defaults to ~/.llm_chat.

The settings can also be configured via command line arguments. Run llm chat --help for more information.

Usage

To start a chat session, run the following command:

llm chat

This will start a chat session with the default settings looking something like the image below:

Chat session

The CLI accepts multi-line input, so to send the input to the model press Esc + Enter. After each message a running total cost will be displayed. To exit the chat session, send the message /q.

There are several additional options available:

  • --context allows you to provide one or more text files as context for your chat, which is sent as an initial system message at the start of the conversation. You can provide the argument multiple times to add multiple files.
  • --name gives your chat session a name. This is used to name the history file.

See llm chat --help for a full description of all options and their usage.

Finally, you can load a previous chat session using the llm load command. For example:

llm load /path/to/session.json

See llm load --help for more information.