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

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


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.36.tar.gz (25.3 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.36-py3-none-any.whl (28.5 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for ollama_chat-0.9.36.tar.gz
Algorithm Hash digest
SHA256 cbf20bd730c2208104f47a8309058c9feebf025f6fcea45d2eeb63d8b0896635
MD5 1e5317ab236ce2b3a40ffa7cf673f9cb
BLAKE2b-256 e49bfbb8b305737fb82efb6cd30b594719a8e25d34d9113e34f416aff962ec50

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for ollama_chat-0.9.36-py3-none-any.whl
Algorithm Hash digest
SHA256 6e8d5b7a3fa67317d64e8e0279bc7d41f901569ae4e1c006df9e707c71db3bb6
MD5 4364542a0233c4487df8cc6ec723af9f
BLAKE2b-256 3a3fbcfad7a619fb0db185747ea5743e82c7b7cc8814b4b631f75590d4ee43f3

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