Skip to main content

An Ollama chat web application

Project description

ollama-chat

PyPI - Status PyPI GitHub PyPI - Python Version

Ollama Chat is a conversational AI chat client that uses Ollama to interact with local large language models (LLMs).

Features

  • Platform independent - tested on macOS, Windows, and Linux
  • Chat with any local Ollama model
  • Save conversations for later viewing and interaction
  • Single and multiline prompts
  • Regenerate the most recent conversation response
  • Delete the most recent conversation exchange
  • View responses as Markdown or text
  • Save conversations as Markdown text
  • Multiple concurrent chats
  • Prompt commands for including file and URL content
  • Conversation templates for repeating prompts with variable substitutions

Installation

To get up and running with Ollama Chat follows these steps:

  1. Install and start Ollama

  2. Install Ollama Chat

    pip install ollama-chat
    

Updating

To update Ollama Chat:

pip install -U ollama-chat

Start Ollama Chat

To start Ollama Chat, open a terminal prompt and run the Ollama Chat application:

ollama-chat

A web browser is launched and opens the Ollama Chat web application.

By default, a configuration file, "ollama-chat.json", is created in the user's home directory.

To start a conversation from the command line, use the -m argument:

ollama-chat -m "Why is the sky blue?"

Conversation Templates

Conversation Templates allow you to repeat the same prompts with different models. Templates can define variables for use in the template title and prompt text (e.g., {{var}}).

There are two ways to create a template. Click "Add Template" from the index page, and a new template is created and opened in the template editor. The other way is to click "Template" from a conversation view's menu.

Prompt Commands

Ollama Chat supports special prompt commands that allow you to include file and URL content in your prompt, among other things. The following prompt commands are available:

  • /file - include a file

    /file README.md
    
    Please summarize the README file.
    
  • /dir - include files from a directory

    /dir src/ollama_chat py
    
    Please provide a summary for each Ollama Chat source file.
    
  • /url - include a URL resource

    /url https://craigahobbs.github.io/ollama-chat/README.md
    
    Please summarize the README file.
    
  • /do - execute a conversation template by name or title

    /do city-report -v CityState "Seattle, WA"
    

To get prompt command help use the -h option:

/file -h

File Format and API Documentation

Ollama Chat File Format

Ollama Chat API

Development

This package is developed using python-build. It was started using python-template as follows:

template-specialize python-template/template/ ollama-chat/ -k package ollama-chat -k name 'Craig A. Hobbs' -k email 'craigahobbs@gmail.com' -k github 'craigahobbs' -k noapi 1

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

ollama_chat-0.9.34.tar.gz (21.7 kB view details)

Uploaded Source

Built Distribution

ollama_chat-0.9.34-py3-none-any.whl (24.2 kB view details)

Uploaded Python 3

File details

Details for the file ollama_chat-0.9.34.tar.gz.

File metadata

  • Download URL: ollama_chat-0.9.34.tar.gz
  • Upload date:
  • Size: 21.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.13.0

File hashes

Hashes for ollama_chat-0.9.34.tar.gz
Algorithm Hash digest
SHA256 3097bca5687bc9306647a27c80f7e529c8ac92dc6f152db6ca14948f3c5d0a41
MD5 4d44c38988c12cc1a27db0a05820c23b
BLAKE2b-256 80938621321c9fd2620cccab297701f78112684d5a073437682926d57956aada

See more details on using hashes here.

File details

Details for the file ollama_chat-0.9.34-py3-none-any.whl.

File metadata

File hashes

Hashes for ollama_chat-0.9.34-py3-none-any.whl
Algorithm Hash digest
SHA256 b7b68ca7ff68a81b67a6f7217ac82a9cd53e78bfec7fcdac42bfea9426eb6a5e
MD5 0e549fd6533112b8165a60a3484c497d
BLAKE2b-256 a94068293262a23bb496a7207bab8cce80cf13c3935e3ecd99e74bdf9fa2d7c8

See more details on using hashes here.

Supported by

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