Metadata-Version: 2.1
Name: llm-cloudflare
Version: 0.2.1
Summary: An LLM CLI plugin for Cloudflare Workers AI models.
Author: elithrar
License: Apache-2.0
Project-URL: Homepage, https://github.com/elithrar/llm-cloudflare
Project-URL: Issues, https://github.com/elithrar/llm-cloudflare/issues
Project-URL: CI, https://github.com/elithrar/llm-cloudflare/actions
Project-URL: Changelog, https://github.com/elithrar/llm-cloudflare/releases
Classifier: License :: OSI Approved :: Apache Software License
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: llm
Requires-Dist: OpenAI

## cloudflare-llm

A plugin for the [`llm`](https://llm.datasette.io/en/stable/) CLI that allows you to use the text generation models (LLMs) running on globally on Cloudflare [Workers AI](https://developers.cloudflare.com/workers-ai/models/#text-generation).

## Usage

**Prerequisite**: You'll need the `llm` CLI [installed first](https://llm.datasette.io/en/stable/setup.html).

Install and setup the plugin:

```sh
# Install the plugin from pip
llm install llm-cloudflare

# Provide a valid Workers AI token
# Docs: https://developers.cloudflare.com/workers-ai/get-started/rest-api/#1-get-api-token-and-account-id
llm keys set cloudflare

# Set your Cloudflare account ID
# Docs: https://developers.cloudflare.com/workers-ai/get-started/rest-api/#1-get-api-token-and-account-id
export CLOUDFLARE_ACCOUNT_ID="33charlonghexstringhere"
```

Use it by specifying a Workers AI model:

```sh
llm -m "@cf/meta/llama-3.1-8b-instruct" "Write a Cloudflare Worker in ESM format that returns an empty JSON object as a response. Show only the code."
```

You can set a Workers AI model as [the default model](https://llm.datasette.io/en/stable/setup.html#setting-a-custom-default-model) in `llm`:

```sh
# Set Llama 3.1 8B as the default
llm models default "@cf/meta/llama-3.1-8b-instruct" 
# See what model is set as the default
llm models default
# @cf/meta/llama-3.1-8b-instruct
```

## Available models

This plugin provides access to the [text generation models](https://developers.cloudflare.com/workers-ai/models/#text-generation) (LLMs) provided by Workers AI.

The supported models are generated by scripts. New models thus rely on this plugin being updated periodically.

In the future, this plugin may also add support for Workers AI's [embedding models](https://developers.cloudflare.com/workers-ai/models/#text-embeddings) for use with [`llm embed`](https://llm.datasette.io/en/stable/embeddings/index.html).

## Credits

Credit to [@hex](https://github.com/hex) for https://github.com/hex/llm-perplexity, which heavily inspired the design of this plugin.

## License

Copyright Cloudflare, Inc (2024). Apache-2.0 licensed. See the LICENSE file for details.
