Update README.md
This commit is contained in:
parent
51ce74ad3a
commit
fa966d30db
20
README.md
20
README.md
@ -4,29 +4,25 @@
|
||||
|
||||
Current features:
|
||||
- Perform one-shot prompts with `lmcli prompt <message>`
|
||||
- Manage persistent conversations with the `new`, `reply`, `view`, and `rm`
|
||||
sub-commands.
|
||||
- Manage persistent conversations with the `new`, `reply`, `view`, `rm`,
|
||||
`edit`, `retry`, `continue` sub-commands.
|
||||
- Syntax highlighted output
|
||||
- Tool calling, see the [Tools](#tools) section.
|
||||
|
||||
Planned features:
|
||||
- Ask questions about content received on stdin
|
||||
- Conversation editing
|
||||
|
||||
Maybe features:
|
||||
- Chat-like interface (`lmcli chat`) for rapid back-and-forth conversations
|
||||
- Support for additional models/APIs besides just OpenAI
|
||||
- Natural language image generation, iterative editing
|
||||
|
||||
## Tools
|
||||
Tools must be explicitly enabled by adding the tool's name to the
|
||||
`openai.enabledTools` array in `config.yaml`.
|
||||
|
||||
Note: all filesystem related tools operate relative to the current directory
|
||||
only. They do not accept absolute paths, and all efforts are made to ensure
|
||||
they cannot escape above the working directory (not quite using chroot, but in
|
||||
effect). **Close attention must be paid to where you are running `lmcli`, as
|
||||
the model could at any time decide to use one of these tools to discover and
|
||||
read potentially sensitive information from your filesystem.**
|
||||
only. They do not accept absolute paths, and efforts are made to ensure they
|
||||
cannot escape above the working directory). **Close attention must be paid to
|
||||
where you are running `lmcli`, as the model could at any time decide to use one
|
||||
of these tools to discover and read potentially sensitive information from your
|
||||
filesystem.**
|
||||
|
||||
It's best to only have tools enabled in `config.yaml` when you intend to be
|
||||
using them, since their descriptions (see `pkg/cli/functions.go`) count towards
|
||||
|
Loading…
Reference in New Issue
Block a user