mlow/lmcli
1
0
Fork 0
Code Issues 3 Pull Requests Packages Projects Releases Wiki Activity

Update README

Browse Source
This commit is contained in:
Matt Low 2024-06-23 21:19:34 +00:00
parent 71397be83f
commit a547c57c9c
1 changed files with 6 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
README.md
View File

@ -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,16 +139,18 @@ $ 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: Tools in `lmcli` are used by agents to to acquire information from and interact with external systems. The following built-in tools are available:
- `dir_tree`: Display a directory structure - `dir_tree`: Display a directory structure
- `read_file`: Read the contents of a file - `read_file`: Read the contents of a file