Update README
This commit is contained in:
parent
71397be83f
commit
3646434952
10
README.md
10
README.md
@ -87,8 +87,6 @@ Available formatters:
|
|||||||
|
|
||||||
## Usage
|
## Usage
|
||||||
|
|
||||||
Here's the default help output for `lmcli`:
|
|
||||||
|
|
||||||
```console
|
```console
|
||||||
$ lmcli help
|
$ lmcli help
|
||||||
lmcli - Large Language Model CLI
|
lmcli - Large Language Model CLI
|
||||||
@ -141,13 +139,15 @@ $ lmcli prompt "What is the answer to life, the universe, and everything?"
|
|||||||
|
|
||||||
## Agents
|
## Agents
|
||||||
|
|
||||||
Agents in `lmcli` are configurations that combine a system prompt with a set of available tools. You can define agents in the `config.yaml` file and switch between them using the `--agent` or `-a` flag.
|
Agents in `lmcli` combine a system prompt with a set of available tools. Agents are defined in`config.yaml` and you use them with the `-a`/`--agent` flag.
|
||||||
|
|
||||||
Example:
|
Example:
|
||||||
```sh
|
```console
|
||||||
lmcli chat -a financier
|
$ lmcli chat -a financier
|
||||||
```
|
```
|
||||||
|
|
||||||
|
Agent functionality is expected to be expanded on, bringing them to close parity with something like OpenAI's "Assistants" feature.
|
||||||
|
|
||||||
## Tools
|
## Tools
|
||||||
|
|
||||||
`lmcli` supports tool calling. The following built-in tools are currently available:
|
`lmcli` supports tool calling. The following built-in tools are currently available:
|
||||||
|
Loading…
Reference in New Issue
Block a user