lmcli/README.md

38 lines
762 B
Markdown
Raw Normal View History

2023-11-05 02:18:06 -07:00
# lmcli
2023-11-13 21:33:24 -07:00
`lmcli` is a (Large) Language Model CLI.
2023-11-05 02:18:06 -07:00
2023-11-13 21:33:24 -07:00
Current features:
- Perform one-shot prompts with `lmcli prompt <message>`
- Manage persistent conversations with the `new`, `reply`, `view`, and `rm`
sub-commands.
- Syntax highlighted output
2023-11-13 21:33:24 -07:00
Planned features:
- Ask questions about content received on stdin
- "functions" to allow reading (and possibly writing) to files within the
current working directory
2023-11-13 21:33:24 -07:00
Maybe features:
- Natural language image generation, iterative editing
2023-11-05 02:18:06 -07:00
## 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!