Skip to main content

R CLI - Your Local AI Operating System. 100% private, 100% offline, 100% yours.

Project description

R CLI ๐Ÿš€

Your Local AI Operating System - 100% private, 100% offline, 100% yours.

R CLI is a terminal-based AI agent powered by local open source LLMs (LM Studio, Ollama). Inspired by Paul Klein's viral CEO CLI, but designed to run completely offline.

โ•”โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•—
โ•‘     โ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ•—        โ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ•—โ–ˆโ–ˆโ•—     โ–ˆโ–ˆโ•—                        โ•‘
โ•‘     โ–ˆโ–ˆโ•”โ•โ•โ–ˆโ–ˆโ•—      โ–ˆโ–ˆโ•”โ•โ•โ•โ•โ•โ–ˆโ–ˆโ•‘     โ–ˆโ–ˆโ•‘                        โ•‘
โ•‘     โ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ•”โ•โ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ•—โ–ˆโ–ˆโ•‘     โ–ˆโ–ˆโ•‘     โ–ˆโ–ˆโ•‘                        โ•‘
โ•‘     โ–ˆโ–ˆโ•”โ•โ•โ–ˆโ–ˆโ•—โ•šโ•โ•โ•โ•โ•โ–ˆโ–ˆโ•‘     โ–ˆโ–ˆโ•‘     โ–ˆโ–ˆโ•‘                        โ•‘
โ•‘     โ–ˆโ–ˆโ•‘  โ–ˆโ–ˆโ•‘      โ•šโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ•—โ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ•—โ–ˆโ–ˆโ•‘                        โ•‘
โ•‘     โ•šโ•โ•  โ•šโ•โ•       โ•šโ•โ•โ•โ•โ•โ•โ•šโ•โ•โ•โ•โ•โ•โ•โ•šโ•โ•                        โ•‘
โ•šโ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•

โœจ Features

  • ๐Ÿ”’ 100% Local - Your data never leaves your machine
  • ๐Ÿš€ Modular Skills - PDF, SQL, code generation, summaries and more
  • ๐ŸŽฎ Epic UI - PS2/Matrix-style terminal animations
  • ๐Ÿง  Built-in RAG - Persistent knowledge base
  • ๐Ÿ”Œ Extensible - Create your own skills easily
  • ๐Ÿ’ฐ Free - No paid APIs or subscriptions

๐Ÿ› ๏ธ Requirements

  • Python 3.10+
  • LM Studio or Ollama
  • 16GB+ RAM (24GB VRAM recommended for large models)

Recommended Models

Model VRAM Use Case
Qwen2.5-7B 8GB Fast, simple tasks
Qwen2.5-32B 20GB Balanced
Qwen2.5-72B (Q4) 24GB Maximum quality
DeepSeek-Coder 16GB Code specialized

๐Ÿ“ฆ Installation

From PyPI (Recommended)

# Basic installation
pip install r-cli-ai

# With semantic search (RAG)
pip install r-cli-ai[rag]

# With voice mode (Whisper + TTS)
pip install r-cli-ai[audio]

# With image generation (Stable Diffusion)
pip install r-cli-ai[design]

# Everything
pip install r-cli-ai[all]

From Source

# Clone the repository
git clone https://github.com/raym33/r.git
cd r

# Install with pip
pip install -e .

# Or with uv (faster)
uv pip install -e .

๐Ÿš€ Quick Start

1. Start your LLM server

LM Studio:

  1. Open LM Studio
  2. Load a model (e.g., Qwen2.5-32B-Instruct)
  3. Start the local server (port 1234)

Ollama:

ollama run qwen2.5:32b

2. Launch R CLI

# Interactive mode
python -m r_cli.main

# Direct chat
python -m r_cli.main chat "Explain what machine learning is"

# Direct skills
python -m r_cli.main pdf "My AI report" --title "Q4 Report"
python -m r_cli.main sql sales.csv "SELECT * FROM data WHERE year = 2024"
python -m r_cli.main resume document.pdf --style detailed
python -m r_cli.main code "sorting function" --run

๐Ÿ“š Available Skills

Skill Description Example
pdf Generate PDF documents r pdf "content" --template business
latex Compile LaTeX to professional PDF r latex document.tex
ocr Extract text from images/scanned PDFs r ocr image.png --lang eng
voice Transcribe audio (Whisper) + TTS (Piper) r voice --audio file.mp3
design Generate images with Stable Diffusion r design "cyberpunk city" --style anime
calendar Local calendar & tasks (SQLite) r calendar --action today
multiagent Multi-agent orchestration r multiagent --task "complex task"
plugin Manage community plugins r plugin create my_plugin
rag Semantic search with local embeddings r rag --query "machine learning"
resume Summarize long documents r resume file.pdf
sql SQL queries on CSVs/DBs r sql data.csv "SELECT *"
code Generate and execute code r code "hello world" --run
fs File operations r ls --pattern "*.py"

โš™๏ธ Configuration

Create ~/.r-cli/config.yaml:

llm:
  provider: lm-studio  # or 'ollama'
  base_url: http://localhost:1234/v1
  model: local-model
  temperature: 0.7

ui:
  theme: ps2  # ps2, matrix, minimal, retro, cyberpunk

rag:
  enabled: true
  persist_directory: ~/.r-cli/vectordb

๐ŸŽจ Themes

python -m r_cli.main --theme matrix   # Green Matrix style
python -m r_cli.main --theme ps2      # Blue PlayStation 2
python -m r_cli.main --theme minimal  # Clean and simple
python -m r_cli.main --theme retro    # CRT vintage

๐Ÿ”ง Create Your Own Skill

# ~/.r-cli/skills/my_skill.py

from r_cli.core.agent import Skill
from r_cli.core.llm import Tool

class MySkill(Skill):
    name = "my_skill"
    description = "My custom skill"

    def get_tools(self) -> list[Tool]:
        return [
            Tool(
                name="my_function",
                description="Does something useful",
                parameters={...},
                handler=self.my_function,
            )
        ]

    def my_function(self, arg1: str) -> str:
        return f"Result: {arg1}"

๐Ÿ”Œ Plugin System

Create and share your own skills with the community!

# Create a new plugin
r plugin create my_awesome_plugin --description "Does cool stuff" --author "Your Name"

# Install from GitHub
r plugin install https://github.com/user/r-cli-plugin

# List installed plugins
r plugin list

# Enable/disable plugins
r plugin enable my_plugin
r plugin disable my_plugin

Plugin structure:

~/.r-cli/plugins/my_plugin/
โ”œโ”€โ”€ plugin.yaml       # Metadata
โ”œโ”€โ”€ __init__.py       # Entry point
โ”œโ”€โ”€ skill.py          # Skill implementation
โ””โ”€โ”€ requirements.txt  # Dependencies

๐Ÿ—บ๏ธ Roadmap

  • Agentic core with LM Studio/Ollama
  • Skills: PDF, SQL, Code, Resume, Filesystem
  • UI with PS2/Matrix animations
  • Persistent RAG
  • LaTeX compilation to professional PDFs
  • OCR text extraction (Tesseract)
  • Voice mode (Whisper + Piper TTS)
  • Stable Diffusion integration for design
  • Calendar & tasks with SQLite
  • Multi-agent orchestration
  • Plugin system for community skills
  • Local embeddings with sentence-transformers

๐Ÿค Contributing

Contributions are welcome!

  1. Fork the repository
  2. Create a branch (git checkout -b feature/new-feature)
  3. Commit your changes (git commit -m 'Add new feature')
  4. Push to the branch (git push origin feature/new-feature)
  5. Open a Pull Request

๐Ÿ“„ License

MIT License - Use R CLI however you want.

๐Ÿ‘ค Author

Created by Ramรณn Guillamรณn


R CLI - Because your AI should be yours. ๐Ÿ”’

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

r_cli_ai-0.3.0.tar.gz (120.2 kB view details)

Uploaded Source

Built Distribution

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

r_cli_ai-0.3.0-py3-none-any.whl (150.1 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: r_cli_ai-0.3.0.tar.gz
  • Upload date:
  • Size: 120.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for r_cli_ai-0.3.0.tar.gz
Algorithm Hash digest
SHA256 fefed7d9d0884fe2769be9df043dceb97288772aa958a192be9a3f902a68c985
MD5 475d9157986e278180bed333048d0cd8
BLAKE2b-256 a288937e2603c88a65ab02c3d7e2326e9bee2d507f0ee6328375265c9baa8797

See more details on using hashes here.

Provenance

The following attestation bundles were made for r_cli_ai-0.3.0.tar.gz:

Publisher: release.yml on raym33/r

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

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

File metadata

  • Download URL: r_cli_ai-0.3.0-py3-none-any.whl
  • Upload date:
  • Size: 150.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for r_cli_ai-0.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 9f8a7a1ca9bc0e79dfcb50a3b37c5546ff06e3203ae24e1ff4e36cf252041b32
MD5 342e63d3dc68999b02bbfef2282030d6
BLAKE2b-256 cade267cf354396ce6e88d34aa811ccba8627bad996b872f0cabd668fab2e70f

See more details on using hashes here.

Provenance

The following attestation bundles were made for r_cli_ai-0.3.0-py3-none-any.whl:

Publisher: release.yml on raym33/r

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

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