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
  • Prompt commands to include files, images, and URL content
  • 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
  • Conversation templates for repeating prompts with variable substitutions
  • Start a converstation or template from the command line
  • Download and manage models

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?"

To start a named template from the command line, use the -t and -v arguments:

ollama-chat -t AskAristotle -v Subject "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 files, images, 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.
    
  • /image - include an image

    /image image.jpeg
    
    Please summarize the image.
    
  • /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

    /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


Release history Release notifications | RSS feed

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.43.tar.gz (26.6 kB view details)

Uploaded Source

Built Distribution

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

ollama_chat-0.9.43-py3-none-any.whl (29.8 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: ollama_chat-0.9.43.tar.gz
  • Upload date:
  • Size: 26.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.0.1 CPython/3.13.1

File hashes

Hashes for ollama_chat-0.9.43.tar.gz
Algorithm Hash digest
SHA256 b4fe7919db377f555a12505e6dc81462f17e88bc53b5c35d2e07656214746b41
MD5 a8f9f629ca0ff7eec974f92c528c6563
BLAKE2b-256 4a1a541d5363863e2715fe837392a4ecd7db98dd30ef42981e6bc22312c28611

See more details on using hashes here.

File details

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

File metadata

  • Download URL: ollama_chat-0.9.43-py3-none-any.whl
  • Upload date:
  • Size: 29.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.0.1 CPython/3.13.1

File hashes

Hashes for ollama_chat-0.9.43-py3-none-any.whl
Algorithm Hash digest
SHA256 d834b85d8ea04875d8d269c31d8e915c6a7023304125c8f78ca74983448f536c
MD5 afd656f2ca97bdbe752115c8f3217a1b
BLAKE2b-256 830a1456881417576acb5346bdb5d398935bd7d3dd5cf71dc7e3bf67a17a1fb7

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