From 1bfdeb23ecd36e65d208b339af547bd064c457e7 Mon Sep 17 00:00:00 2001 From: Matt Low Date: Sun, 5 Nov 2023 02:18:06 -0700 Subject: [PATCH] Add README.md --- README.md | 27 +++++++++++++++++++++++++++ 1 file changed, 27 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..bc9b28c --- /dev/null +++ b/README.md @@ -0,0 +1,27 @@ +# lmcli + +`lmcli` is a (Large) Language Model (and maybe other types of models) CLI. + +It currently allows you to perform one-shot prompts with `lmcli prompt +`, and persisted conversations are underway. + +## Install + +```shell +$ go install git.mlow.ca/mlow/lmcli@latest + +``` + +## Usage + +Invoke `lmcli` at least once: + +```shell +$ lmcli help +``` + +Edit `~/.config/lmcli/config.yaml` and set `openai.apiKey` to your API key. + +Refer back to the output of `lmcli help` for usage. + +Enjoy!