Skip to main content

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

Project description

LLM

PyPI Documentation Changelog Tests License Discord Homebrew

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, store the results in SQLite, generate embeddings and more.

Consult the LLM plugins directory for plugins that provide access to remote and local models.

Full documentation: llm.datasette.io

Background on this project:

Installation

Install this tool using pip:

pip install llm

Or using Homebrew:

brew install llm

Detailed installation instructions.

Getting started

If you have an OpenAI API key you can get started using the OpenAI models right away.

As an alternative to OpenAI, you can install 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:

llm keys set openai

This will prompt you for your key like so:

Enter key: <paste here>

Now that you've saved a key you can run a prompt like this:

llm "Five cute names for a pet penguin"
1. Waddles
2. Pebbles
3. Bubbles
4. Flappy
5. Chilly

Read the usage instructions for more.

Installing a model that runs on your own machine

LLM plugins can add support for alternative models, including models that run on your own machine.

To download and run Mistral 7B Instruct locally, you can install the llm-gpt4all plugin:

llm install llm-gpt4all

Then run this command to see which models it makes available:

llm models
gpt4all: all-MiniLM-L6-v2-f16 - SBert, 43.76MB download, needs 1GB RAM
gpt4all: orca-mini-3b-gguf2-q4_0 - Mini Orca (Small), 1.84GB download, needs 4GB RAM
gpt4all: mistral-7b-instruct-v0 - Mistral Instruct, 3.83GB download, needs 8GB RAM
...

Each model file will be downloaded once the first time you use it. Try Mistral out like this:

llm -m mistral-7b-instruct-v0 'difference between a pelican and a walrus'

You can also start a chat session with the model using the llm chat command:

llm chat -m mistral-7b-instruct-v0
Chatting with mistral-7b-instruct-v0
Type 'exit' or 'quit' to exit
Type '!multi' to enter multiple lines, then '!end' to finish
> 

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 in a file works, try this:

cat mycode.py | llm -s "Explain this code"

Help

For help, run:

llm --help

You can also use:

python -m llm --help

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

llm-0.19a2.tar.gz (42.7 kB view details)

Uploaded Source

Built Distribution

llm-0.19a2-py3-none-any.whl (44.3 kB view details)

Uploaded Python 3

File details

Details for the file llm-0.19a2.tar.gz.

File metadata

  • Download URL: llm-0.19a2.tar.gz
  • Upload date:
  • Size: 42.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.1 CPython/3.12.7

File hashes

Hashes for llm-0.19a2.tar.gz
Algorithm Hash digest
SHA256 106b489960bb5879f3fd06ae9e0d9911d437e6eac40582812b956acb02bc4fe3
MD5 58e2a9d0e65f0acb08eb89ae5bf85547
BLAKE2b-256 d5476bc1d538aafb6a391fdba5df2ec84bae018ddf110270065b1f48503273b1

See more details on using hashes here.

Provenance

The following attestation bundles were made for llm-0.19a2.tar.gz:

Publisher: publish.yml on simonw/llm

Attestations:

File details

Details for the file llm-0.19a2-py3-none-any.whl.

File metadata

  • Download URL: llm-0.19a2-py3-none-any.whl
  • Upload date:
  • Size: 44.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.1 CPython/3.12.7

File hashes

Hashes for llm-0.19a2-py3-none-any.whl
Algorithm Hash digest
SHA256 47ee6b3934447d2bcc71a4a5974b3efae4177261bf94e09db7d76bb95534f044
MD5 ee60fa1883b4dca0bb50c2bef9b6cb1d
BLAKE2b-256 b698eaaad39bdb9cff982826653afd282dc2eb5c6816bc844a161cf9f6f42029

See more details on using hashes here.

Provenance

The following attestation bundles were made for llm-0.19a2-py3-none-any.whl:

Publisher: publish.yml on simonw/llm

Attestations:

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page