Skip to main content

A CLI tool for accessing the LLM API in the terminal.

Project description

pAIpe: Your LLM shell assistant

PyPI version License: MIT

pAIpe is a command-line tool designed to streamline your interactions with Large Language Models (LLMs). It provides a flexible and configurable pipeline to process text input through various LLM providers and models, managed through profiles for ease of use and customization.

Features

  • Command-Line Interface: Simple and intuitive CLI for interacting with LLMs directly from your terminal.
  • Profile-Based Configuration: Define and manage multiple LLM configurations (profiles) in a paipe.yaml file, allowing you to switch between different providers, models, and settings effortlessly.
  • Streaming Output: Supports streaming responses from LLMs for a more interactive and real-time experience.
  • Input from Stdin or File: Read input text from standard input for quick prompts or from files for processing larger documents.
  • Extendable Configurations: Designed to be easily extended with new LLM providers and models by modifying the configuration file.

Installation

python -m pip install -U paipe

Or install using uv(run with uvx paipe):

uv tool install -U paipe

Configuration

paipe is configured using a paipe.yaml file. This file should be placed in one of the following locations (in order of priority):

  1. Current directory (./paipe.yaml)
  2. User local directory (~/.local/share/paipe/paipe.yaml)
  3. System configuration directory (/etc/paipe.yaml)

If no paipe.yaml is found in these locations, paipe will prompt an error message and exit.

Here's an example of a paipe.yaml configuration file(access api via openrouter):

default:
    provider: openai
    api_key: 'YOUR_OPENROUTER_API_KEY_HERE' # Replace with your actual API key
    base_url: 'https://openrouter.ai/api/v1'
    model: 'deepseek/deepseek-chat:free'
deepseek-r1:
    provider: openai
    api_key: 'YOUR_OPENROUTER_API_KEY_HERE' # Replace with your actual API key
    base_url: 'https://openrouter.ai/api/v1'
    model: 'deepseek/deepseek-r1:free'

Each section in the paipe.yaml file defines a profile. Here's a breakdown of the profile settings:

  • provider: Specifies the LLM provider. Currently, paipe is configured to use openai which can interface with various providers through platforms like OpenRouter or directly with specific APIs.
  • api_key: Your API key for the chosen provider. Replace the placeholder 'YOUR_API_KEY_HERE' with your actual API key.
  • base_url: The API base URL for the provider. For OpenRouter, it's typically 'https://openrouter.ai/api/v1'.
  • model: The specific LLM model to use from the provider. The available models depend on your chosen provider and API key access. Examples include 'google/gemini-2.0-pro-exp-02-05:free', 'qwen2-72b-instruct', 'deepseek/deepseek-r1:free', etc.

Usage

Basic usage:

paipe <prompt>

This will execute paipe with the <prompt> you provide, using the default profile defined in your paipe.yaml and stream the response to your terminal.

cat essay.txt | paipe --profile deepseek-r1 "write a summary of the following text:"

This will read the content of essay.txt and send it to the deepseek-r1 profile for processing.

paipe --list

This will list all the available profiles defined in your paipe.yaml file.

License

paipe is released under the MIT License. See the LICENSE file for more details.

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

paipe-0.1.7.tar.gz (1.6 MB view details)

Uploaded Source

Built Distribution

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

paipe-0.1.7-py3-none-any.whl (12.3 kB view details)

Uploaded Python 3

File details

Details for the file paipe-0.1.7.tar.gz.

File metadata

  • Download URL: paipe-0.1.7.tar.gz
  • Upload date:
  • Size: 1.6 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.5.14

File hashes

Hashes for paipe-0.1.7.tar.gz
Algorithm Hash digest
SHA256 94b3cf57a7bf985d6350a101a0f3cf1c879f40d115ead5c026555bda1e0a2ae0
MD5 503dcbe263a40bda47c95a41710b2b02
BLAKE2b-256 58ad923aa2596c57835647e4b00061544c5eac62aa932b0c69a8012102ab041c

See more details on using hashes here.

File details

Details for the file paipe-0.1.7-py3-none-any.whl.

File metadata

  • Download URL: paipe-0.1.7-py3-none-any.whl
  • Upload date:
  • Size: 12.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.5.14

File hashes

Hashes for paipe-0.1.7-py3-none-any.whl
Algorithm Hash digest
SHA256 bba62a94e8cec00438f908a288e6b18199d809d23f51f74e7bac986aa696d53a
MD5 4b10f51cc2261a926e2d06f40b952575
BLAKE2b-256 0fb279e67476e4e03df714997957d141b566a55b89df32d41f198e59d69ef931

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