Skip to main content

Your AI-Powered Coding Assistant in the Terminal

Project description

Olla CLI

 ██████╗ ██╗     ██╗      █████╗       ██████╗██╗     ██╗
██╔═══██╗██║     ██║     ██╔══██╗     ██╔════╝██║     ██║
██║   ██║██║     ██║     ███████║     ██║     ██║     ██║
██║   ██║██║     ██║     ██╔══██║     ██║     ██║     ██║
╚██████╔╝███████╗███████╗██║  ██║     ╚██████╗███████╗██║
 ╚═════╝ ╚══════╝╚══════╝╚═╝  ╚═╝      ╚═════╝╚══════╝╚═╝

Your AI-Powered Coding Assistant in the Terminal

Olla CLI is a powerful command-line interface that brings AI coding assistance directly to your terminal. Built on top of Ollama, it provides intelligent code analysis, generation, debugging, and more with beautiful Rich-formatted output.

License: MIT Python 3.8+

✨ Features

  • 🎯 Intelligent Code Analysis: Explain, review, and debug code with AI assistance
  • 🔄 Code Generation: Generate functions, classes, and complete programs from descriptions
  • 🧪 Test Generation: Automatically create comprehensive test suites
  • 📚 Documentation: Generate professional documentation for your code
  • 🎨 Rich Terminal Output: Beautiful syntax highlighting, tables, and formatting
  • 💬 Interactive Mode: Conversational REPL with session management
  • 🌈 Themes: Dark, light, and auto themes for different environments
  • 📄 Export: Save results as Markdown, HTML, or copy to clipboard
  • 🔍 Context-Aware: Intelligent project analysis and dependency tracking
  • Streaming Responses: Real-time AI responses with progress indicators

📋 Requirements

  • Python: 3.8 or higher
  • Ollama: Latest version (installation guide)
  • Operating System: Linux or Windows with WSL

🚀 Quick Start

Installation

# PyPI coming soon...
git clone https://github.com/mahinuzzaman/ollama-cli.git
cd ollama-cli
pip install -e .

Setup

# Install Ollama (if not already installed)
curl -fsSL https://ollama.ai/install.sh | sh

# Pull a model
ollama pull codellama

# Verify installation
ollama -v

Basic Usage

# Explain code
olla-cli explain "def factorial(n): return 1 if n <= 1 else n * factorial(n-1)"

# Review a file
olla-cli review myfile.py

# Generate code
olla-cli generate "binary search algorithm in Python"

# Interactive mode
olla-cli chat

# Get help
olla-cli --help

🛠️ Commands Overview

Command Description
explain Explain code functionality and logic
review Review code for issues and improvements
refactor Get intelligent refactoring suggestions
debug Debug code issues with AI assistance
generate Generate code from descriptions
test Generate comprehensive test suites
document Generate professional documentation
chat Start interactive conversational mode
config Manage configuration settings
models Manage Ollama models

🎯 Example Workflows

Code Review

# Review with specific focus
olla-cli review --focus security auth.py

# Get refactoring suggestions
olla-cli refactor --type optimize slow_function.py

Development

# Generate code structure
olla-cli generate --template class "user authentication manager"

# Create tests
olla-cli test --framework pytest auth_manager.py

# Generate docs
olla-cli document --format google auth_manager.py

🤝 Contributing

We welcome contributions!

Quick Development Setup

git clone https://github.com/mahinuzzaman/ollama-cli.git
cd ollama-cli
python -m venv venv
source venv/bin/activate
pip install -e .

🔗 Links

📄 License

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


⭐ If you find Olla CLI useful, please consider giving it a star!

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

olla_cli-0.3.0.tar.gz (91.0 kB view details)

Uploaded Source

Built Distribution

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

olla_cli-0.3.0-py3-none-any.whl (93.0 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for olla_cli-0.3.0.tar.gz
Algorithm Hash digest
SHA256 9e059c723003c317ab5e7dd8f993653346a482a07a26e8dbaf1c7b52cc3d863c
MD5 4cba997c741fbbb69130459453131f26
BLAKE2b-256 556a4dc28d142be93bdd245eabfa9ab96d62d7e499c6fe4a84ec829de819e404

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for olla_cli-0.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 2bd3deef988fbf1927563a1c1f853557a3ad936ee488c72ee1d6cb4651a5457a
MD5 2c6579615dde2a3a3af95d70336826a6
BLAKE2b-256 f68a4f99cc6bbdacf29664312f0ab3e407f5001bf8c40a277f0d94a1e5610158

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