lmcli/README.md
Matt Low 303c4193cb Update README.md
Clarify planned features, we wouldn't want the model to have free access
to read any file in the system.
2023-11-23 17:44:57 +00:00

38 lines
762 B
Markdown

# lmcli
`lmcli` is a (Large) Language Model CLI.
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
Planned features:
- Ask questions about content received on stdin
- "functions" to allow reading (and possibly writing) to files within the
current working directory
Maybe features:
- Natural language image generation, iterative editing
## 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!