Add README.md

This commit is contained in:
Matt Low 2023-11-05 02:18:06 -07:00
parent 6eca84dab8
commit 2d9c6fd6ee

27
README.md Normal file
View File

@ -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-sec prompts with `lmcli prompt
<message>`, and persisted conversatoins 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!