Skip to main content

No project description provided

Project description

TLDR AI CLI Tool

PyPI version License

Overview

TLDR AI CLI Tool is a command-line interface (CLI) designed to provide quick and efficient solutions to complex queries using Large Language Models (LLMs). The tool integrates various AI models to fetch, process, and summarize information from sources like Stack Overflow.

The TLDR AI CLI Tool is inspired by howdoi. Unlike howdoi, this tool leverages the power of LLMs and can even work offline if Stack Overflow is not used.

Features

  • Summarizes complex topics into concise, understandable summaries.
  • Fetches and processes Stack Overflow questions and answers.
  • Utilizes multiple LLMs, including Ollama and other transformers.
  • Configurable via YAML files.
  • Supports real-time response streaming.

Installation

Prerequisites

  • Python 3.8+
  • Ollama

Install Ollama

Ollama is required for some functionalities of this tool. Please install Ollama according to your operating system by following the instructions provided in their Quickstart Guide.

Install TLDR AI CLI Tool

You can install the TLDR AI CLI Tool via pip:

pip install tldrai

Usage

To use the tool, simply run:

tldrai apply function to pandas column

You can also override specific configuration settings using the --set argument:

tldrai apply function to pandas column --set summarization_pipeline.model=stable-code precision=float32 -v

CLI Options

  • question: The question or query to process.
  • --config: Path to the configuration file (default: config/config.yaml).
  • --set: Override configuration key-value pairs (e.g., key=value).
  • -v, --verbose: Output all logs verbose.
  • -s, --search: Search for similar quetions on Stack Overflow and feed it to the model as suggestions

Configuration

The TLDR AI CLI Tool is highly configurable. Configuration settings are managed through YAML files. Currently, the default configuration file used is config/ollama_stable_code.yml.

Contributing

We welcome contributions to the TLDR AI CLI Tool! If you have any suggestions or find any issues, please open an issue or subApache 2.0 a pull request on our GitHub repository.

License

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

Acknowledgements


Thank you for using TLDR AI CLI Tool. We hope it enhances your productivity and makes working with complex information easier and more efficient.

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

tldrai-0.1.0.tar.gz (27.5 kB view details)

Uploaded Source

Built Distribution

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

tldrai-0.1.0-py3-none-any.whl (18.0 kB view details)

Uploaded Python 3

File details

Details for the file tldrai-0.1.0.tar.gz.

File metadata

  • Download URL: tldrai-0.1.0.tar.gz
  • Upload date:
  • Size: 27.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.4.0 CPython/3.11.7 Linux/6.9.3-76060903-generic

File hashes

Hashes for tldrai-0.1.0.tar.gz
Algorithm Hash digest
SHA256 0adeb7dc7aef7424dfb78987ff7154d1d58239d14bead2a530ea3a6d6a830675
MD5 e1efc2cec867f8d7b297f3c0b3932e4a
BLAKE2b-256 956e1a2aecb3a95ab99c44031277188da89d74f2c01719d648cad9a2e189f016

See more details on using hashes here.

File details

Details for the file tldrai-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: tldrai-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 18.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.4.0 CPython/3.11.7 Linux/6.9.3-76060903-generic

File hashes

Hashes for tldrai-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 c76c1d48363455cbde0f67ddfb1192bed5e399db587aa09e95ebef13e809c72f
MD5 ce6098f5b9fee7500510c3c49e1126fb
BLAKE2b-256 71268ed4708e22d6a091f780c78df7aeb5bc252a7d0d9f0370e559aead03893f

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