-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
74 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,74 @@ | ||
# `llm` | ||
|
||
Utilities for text completion. | ||
|
||
## Configuration | ||
|
||
Currently `llm` sources its config from `$XDG_CONFIG_HOME/voice/config.toml`. | ||
|
||
### File structure | ||
|
||
```toml | ||
[transcription] | ||
model_dir = "/path/to/whisper.cpp/models" | ||
|
||
[llm.providers.openai] | ||
enabled = true | ||
|
||
# works well with CLI utilities like `pass` or 1Password's `op` | ||
api_key_command = [ | ||
"command", | ||
"that", | ||
"writes", | ||
"api_key", | ||
"to", | ||
"stdout", | ||
] | ||
|
||
[llm.providers.groq] | ||
enabled = true | ||
api_key_command = [ ... ] | ||
|
||
[llm.providers.ollama] | ||
enabled = true | ||
host = "localhost" | ||
port = 11434 | ||
``` | ||
|
||
## Usage | ||
|
||
``` | ||
Usage: voice-llm <COMMAND> | ||
Commands: | ||
completion | ||
list-models | ||
help Print this message or the help of the given subcommand(s) | ||
Options: | ||
-h, --help Print help | ||
-V, --version Print version | ||
``` | ||
|
||
### `completion` | ||
|
||
``` | ||
Usage: voice-llm completion [OPTIONS] --provider <PROVIDER> <USER_MESSAGE> | ||
Arguments: | ||
<USER_MESSAGE> | ||
Options: | ||
-p, --provider <PROVIDER> [possible values: openai, groq, ollama] | ||
-s, --system-message <SYSTEM_MESSAGE> | ||
-h, --help Print help | ||
``` | ||
|
||
### `list-models` | ||
|
||
``` | ||
Usage: voice-llm list-models | ||
Options: | ||
-h, --help Print help | ||
``` |