Hopiu/llm
1
0
Fork 0
mirror of https://github.com/Hopiu/llm.git synced 2026-03-17 05:00:25 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Promote llm -s and mention plugins, refs #59

Browse source
This commit is contained in:
Simon Willison 2023-07-11 19:55:33 -07:00
parent d2fcff3f3a
commit c33625faa8
1 changed files with 28 additions and 13 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

41
README.md
View file

@ -16,31 +16,35 @@ See [llm, ttok and strip-tags—CLI tools for working with ChatGPT and other LLM
## Installation
Install this tool using `pip`:
pip install llm
```bash
pip install llm
```
Or using [Homebrew](https://brew.sh/):
brew install simonw/llm/llm
```bash
brew install simonw/llm/llm
```
[Detailed installation instructions](https://llm.datasette.io/en/stable/setup.html).
## Getting started
First, create an OpenAI API key and save it to the tool like this:
If you have an [OpenAI API key](https://platform.openai.com/account/api-keys) you can get started using the OpenAI models right away.
```
(You can [install plugins](https://github.com/simonw/llm-plugins) to access models by other providers, including models that can be installed and run on your own device.)
Save your OpenAI API key like this:
```bash
llm keys set openai
```
This will prompt you for your key like so:
```bash
llm keys set openai
```
$ llm keys set openai
Enter key:
```
Enter key: <paste here>
```
Now that you've saved a key you can run a prompt like this:
```
```bash
llm "Five cute names for a pet penguin"
```
```
@ -52,6 +56,17 @@ llm "Five cute names for a pet penguin"
```
Read the [usage instructions](https://llm.datasette.io/en/stable/usage.html) for more.
## Using a system prompt
You can use the `-s/--system` option to set a system prompt, providing instructions for processing other input to the tool.
To describe how the code a file works, try this:
```bash
cat mycode.py | llm -s "Explain this code"
```
## Help
For help, run: