diff --git a/README.md b/README.md index 5e93b18..f345486 100644 --- a/README.md +++ b/README.md @@ -8,7 +8,9 @@ [![Discord](https://img.shields.io/discord/823971286308356157?label=discord)](https://datasette.io/discord-llm) [![Homebrew](https://img.shields.io/homebrew/installs/dy/llm?color=yellow&label=homebrew&logo=homebrew)](https://formulae.brew.sh/formula/llm) -A CLI utility and Python library for interacting with Large Language Models, including OpenAI, PaLM and local models installed on your own machine. +A CLI utility and Python library for interacting with Large Language Models, both via remote APIs and models that can be installed and run on your own machine. + +[Run prompts from the command-line](https://llm.datasette.io/en/stable/usage.html#executing-a-prompt), [store the results in SQLite](https://llm.datasette.io/en/stable/logging.html), [generate embeddings](https://llm.datasette.io/en/stable/embeddings/index.html) and more. Full documentation: **[llm.datasette.io](https://llm.datasette.io/)** diff --git a/docs/index.md b/docs/index.md index 34fb3b8..5f99b9d 100644 --- a/docs/index.md +++ b/docs/index.md @@ -7,7 +7,9 @@ [![Discord](https://img.shields.io/discord/823971286308356157?label=discord)](https://datasette.io/discord-llm) [![Homebrew](https://img.shields.io/homebrew/installs/dy/llm?color=yellow&label=homebrew&logo=homebrew)](https://formulae.brew.sh/formula/llm) -A CLI utility and Python library for interacting with Large Language Models, including OpenAI, PaLM and local models installed on your own machine. +A CLI utility and Python library for interacting with Large Language Models, both via remote APIs and models that can be installed and run on your own machine. + +{ref}`Run prompts from the command-line `, {ref}`store the results in SQLite `, {ref}`generate embeddings ` and more. Background on this project: - [llm, ttok and strip-tags—CLI tools for working with ChatGPT and other LLMs](https://simonwillison.net/2023/May/18/cli-tools-for-llms/) diff --git a/docs/usage.md b/docs/usage.md index 3231148..48ec844 100644 --- a/docs/usage.md +++ b/docs/usage.md @@ -1,7 +1,9 @@ +(usage)= # Usage The default command for this is `llm prompt` - you can use `llm` instead if you prefer. +(usage-executing-prompts)= ## Executing a prompt These examples use the default OpenAI `gpt-3.5-turbo` model, which requires you to first {ref}`set an OpenAI API key `.