llm/docs/index.md
2023-09-03 11:50:18 -07:00

2.5 KiB

LLM

PyPI Changelog Tests License Discord Homebrew

A CLI utility and Python library for interacting with Large Language Models, including OpenAI, PaLM and local models installed on your own machine.

Background on this project:

For more check out the llm tag on my blog.

Quick start

First, install LLM using pip or Homebrew:

pip install llm

Or with Homebrew:

brew install llm

If you have an OpenAI API key key you can run this:

# Paste your OpenAI API key into this
llm keys set openai

# Run a prompt
llm "Ten fun names for a pet pelican"

# Run a system prompt against a file
cat myfile.py | llm -s "Explain this code"

Or you can {ref}install a plugin <installing-plugins> and use models that can run on your local device:

# Install the plugin
llm install llm-gpt4all

# Download and run a prompt against the Orca Mini 7B model
llm -m orca-mini-7b 'What is the capital of France?'

Contents

---
maxdepth: 3
---
setup
usage
other-models
embeddings/index
plugins/index
aliases
python-api
templates
logging
related-tools
help
contributing
changelog