Skip to main content

A CLI tool to interact with various LLM APIs

Project description

LLX - A CLI for Interacting with Large Language Models

LLX is a Python-based command-line interface (CLI) that makes it easy to interact with various Large Language Model (LLM) providers. Whether you need to chat with models, send prompts with attachments, crawl URLs for content extraction, run evaluations, or discover available models, LLX provides a convenient set of commands to streamline the process.

Features

  • 8 LLM Provider Support: OpenAI, Anthropic, Ollama, Deepseek, Mistral, Gemini, XAI, Perplexity
  • Dynamic Model Discovery: List 179+ available models across all providers
  • Model Benchmarking: Compare performance, response times, and costs across models
  • Comparative Judging: Head-to-head model evaluation using LLM judges
  • Plugin System: Extensible architecture with built-in and custom plugins
  • Template System: Predefined prompts for common tasks (code review, translation, etc.)
  • LLM Response Streaming: Real-time streaming responses
  • Multimodal Support: Upload and analyze files with vision-capable models
  • Interactive Chat: Enhanced chat interface with conversation history
  • Content Extraction: Web crawling and file processing capabilities

Installation

  1. Make sure you have Python 3.7+ installed.

  2. (Optional) Create and activate a virtual environment:

    python3 -m venv venv
    source venv/bin/activate  # Linux/Mac
    venv\Scripts\activate     # Windows
    
  3. Install LLX with pip:

    pip install llm-cli-tools
    
  4. (Optional) Create a .env file in your project directory to store your provider API keys (e.g., OPENAI_API_KEY, ANTHROPIC_API_KEY, etc.). You can use .env.example as a reference.

Usage

Once installed, you can run the CLI with:

llx --help

This will list all available subcommands and their required/optional parameters. Below is a summary of each subcommand and example usage.


1. prompt

Send a single prompt to a specified model. The prompt text can be passed in directly or piped in via stdin.

• Required options:
--model / -m : The model in ":<model_name>" format.
• Optional:
--prompt / -p : The prompt string (if not provided, it reads from stdin).
--attachment / -a : Path to an image file to send as an attachment.

Example 1 (inline prompt):

llx prompt --model openai:gpt-3.5-turbo --prompt "Hello, how are you?"

Example 2 (pipe prompt from stdin):

echo "Hello from stdin" | llx prompt -m openai:gpt-3.5-turbo

Example 3 (with attachment):

llx prompt -m openai:gpt-3.5-turbo -p "Extract text from this image" -a /path/to/image.jpg

2. chat

Start an interactive chat session with a specified model. Your local terminal will prompt for user input, and the assistant response will stream back.

• Required option:
--model / -m : The model in ":<model_name>" format.

Example:

llx chat --model openai:gpt-3.5-turbo

Then type your messages. Type /bye or press Ctrl+C to exit.


3. server

Start a small FastAPI server to expose a chat completions endpoint (POST /v1/chat/completions). This is helpful if you want to run your own local API wrapper.

• Options:
--host : Defaults to 127.0.0.1.
--port : Defaults to 8000.

Example:

llx server --host 127.0.0.1 --port 8000

You can then send POST requests to http://127.0.0.1:8000/v1/chat/completions.


4. url-to-prompt

Crawl one or more URLs, optionally extracting text from HTML, and print the content (plus an optional prompt) to stdout.

• Required option:
--url : The starting URL to begin crawling.
• Optional:
--prompt / -p : A prompt to prepend.
--extract-text : Extract text instead of returning raw HTML.
--domain : Restrict crawling to this domain.
--max-depth : Depth of links to follow (defaults to 1).
--max-urls : Max number of links to crawl (defaults to 1).

Example:

llx url-to-prompt --url https://example.com --prompt "Summarize the following:" --extract-text true --max-depth 2 --max-urls 5

This will print the extracted text from up to 5 URLs (within 2 link levels from the start) in a structured format alongside your prompt.


5. files-to-prompt

Concatenate the contents of all files in a directory into a single prompt (printed to stdout). You can prepend an optional prompt string.

• Required options:
--path : Directory path containing the files.
• Optional:
--prompt / -p : A prompt to prepend.

Example:

llx files-to-prompt --path /path/to/documents --prompt "Here are the contents of my documents:"

This command walks through each file, ignoring binary files, and combines them in an XML-like structure printed to stdout.


6. list-models

Discover and list all available models from LLM providers. This command dynamically fetches models using each provider's API.

• Optional:
--provider / -p : Filter to a specific provider (e.g., "openai", "anthropic", "ollama").
--output-format / -f : Output format (table or json).

Example 1 (all providers):

llx list-models

Example 2 (specific provider):

llx list-models -p openai

Example 3 (JSON output):

llx list-models -p anthropic -f json

This command discovers 179+ models across 7 providers including OpenAI GPT models, Anthropic Claude models, Google Gemini models, and more.


7. benchmark

Benchmark a prompt across multiple models and compare their performance, response times, costs, and optionally quality using LLM judges.

• Required options:
--prompt / -p : The prompt to benchmark across models.
--models / -m : Comma-separated list of models to benchmark.
• Optional:
--output-format / -f : Output format (table or json).
--output-file / -o : File to save results to.
--judge-model / -j : Model to use for judging response quality.
--judge-prompt : Custom system prompt for the judge model.
--comparative / -c : Use head-to-head comparative judging instead of individual scoring.

Example 1 (basic benchmark):

llx benchmark -p "Explain quantum computing" -m "openai:gpt-4,anthropic:claude-3-sonnet,ollama:llama3.2"

Example 2 (with quality judging):

llx benchmark -p "Write a Python function to sort a list" -m "openai:gpt-4,anthropic:claude-3-sonnet" -j "openai:gpt-4"

Example 3 (comparative judging):

llx benchmark -p "Explain machine learning" -m "openai:gpt-4,anthropic:claude-3-sonnet" -j "openai:gpt-4" --comparative

This will run the prompt across all specified models and display a comparison table with response times, token counts, estimated costs, and quality scores. Comparative mode provides head-to-head rankings and detailed analysis.


Quick Start Examples

Discover Available Models

# List all available models across providers
llx list-models

# List models for a specific provider
llx list-models -p openai

Benchmark Models

# Basic performance comparison
llx benchmark -p "Write a haiku about coding" -m "openai:gpt-4,anthropic:claude-3-sonnet"

# With AI quality judging
llx benchmark -p "Explain recursion" -m "openai:gpt-4,anthropic:claude-3-sonnet" -j "openai:gpt-4"

# Head-to-head comparative judging
llx benchmark -p "Compare Python vs JavaScript" -m "openai:gpt-4,anthropic:claude-3-sonnet" -j "openai:gpt-4" --comparative

Interactive Chat

# Start chatting with a model
llx chat -m anthropic:claude-3-sonnet

# Chat with local Ollama model
llx chat -m ollama:llama3.2

Plugin System

# List available plugins
llx plugin list

# Show detailed plugin information
llx plugin list --verbose

# Initialize plugin directory with examples
llx plugin init

# Enable/disable plugins
llx plugin enable template
llx plugin disable template

# Show plugin details
llx plugin show template

Template System (Plugin)

# Initialize templates directory with examples
llx template init

# List available templates
llx template list

# Use a template with variables
llx template use code-review --file mycode.py --model anthropic:claude-3-sonnet

# Use template interactively
llx template use translate --var text="Hello world" --var from_language=English --var to_language=Spanish --interactive

# Show template details
llx template show code-review

Environment Variables

Providers require API keys to function. Store them in a .env file in your working directory or set them directly in your shell environment. For example:

• OPENAI_API_KEY
• ANTHROPIC_API_KEY
• DEEPSEEK_API_KEY
• MISTRAL_API_KEY
• GEMINI_API_KEY
• XAI_API_KEY
• PERPLEXITY_API_KEY

Use the .env.example file as a reference.

Example .env:

OPENAI_API_KEY=<your-openai-key>
ANTHROPIC_API_KEY=<your-anthropic-key>
...

Plugin Development

LLX features an extensible plugin system that allows you to create custom commands and functionality.

Creating a Plugin

  1. Create plugin directory:

    llx plugin init
    
  2. Create your plugin file in ~/.llx/plugins/my_plugin.py:

    from llx.plugins.base_plugin import BasePlugin
    import click
    
    class MyPlugin(BasePlugin):
        @property
        def name(self) -> str:
            return "my-plugin"
        
        @property
        def version(self) -> str:
            return "1.0.0"
        
        @property
        def description(self) -> str:
            return "My custom plugin"
        
        def register_commands(self, cli_group):
            @cli_group.command()
            def my_command():
                """My custom command"""
                click.echo("Hello from my plugin!")
    
  3. Enable your plugin:

    llx plugin enable my-plugin
    

Built-in Plugins

  • template: Template system for common LLM tasks
  • example: Example plugin for reference

Plugin API

Plugins inherit from BasePlugin and must implement:

  • name: Unique plugin identifier
  • version: Plugin version
  • description: Brief description
  • register_commands(): Add commands to CLI

Optional properties:

  • author: Plugin author
  • dependencies: Required packages

Contributing

  1. Clone the repository.
  2. Create and activate a virtual environment.
  3. Install dependencies by running pip install -e .
  4. Develop and submit pull requests.

We appreciate bug reports, feature requests, and pull requests!


License

This project is licensed under the MIT License. See the LICENSE file for details.


Happy prompting! If you have any questions or issues, feel free to open a GitHub issue.%

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_cli_tools-0.3.0.tar.gz (41.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

llm_cli_tools-0.3.0-py3-none-any.whl (42.7 kB view details)

Uploaded Python 3

File details

Details for the file llm_cli_tools-0.3.0.tar.gz.

File metadata

  • Download URL: llm_cli_tools-0.3.0.tar.gz
  • Upload date:
  • Size: 41.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.4

File hashes

Hashes for llm_cli_tools-0.3.0.tar.gz
Algorithm Hash digest
SHA256 d54c9165fd4faacea6bcc1a61635db6d3db17f61cf96dc4d4b78decef7a7826d
MD5 01cdaf2aa112dbd2a86a49ca0a14247c
BLAKE2b-256 42f1edfe3fa072b6e41d8f08162ba17ec1275b52f8c311da5005a3462befaf59

See more details on using hashes here.

File details

Details for the file llm_cli_tools-0.3.0-py3-none-any.whl.

File metadata

  • Download URL: llm_cli_tools-0.3.0-py3-none-any.whl
  • Upload date:
  • Size: 42.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.4

File hashes

Hashes for llm_cli_tools-0.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 db397364c5bd27c24043641fbba71ece381818af76af13c9efcb0632edfcdbec
MD5 5739df6f00cc8ae0eec86503c2c69b76
BLAKE2b-256 4205df959d640dd6f1a67ce0efcde25a00cee6f676e87365645e413e40e66e06

See more details on using hashes here.

Supported by

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