Skip to main content

A text-based terminal client for Ollama.

Project description

oterm

the text-based terminal client for Ollama.

Features

  • intuitive and simple terminal UI, no need to run servers, frontends, just type oterm in your terminal.
  • multiple persistent chat sessions, stored together with the context embeddings and template/system prompt customizations in sqlite.
  • can use any of the models you have pulled in Ollama, or your own custom models.
  • allows for easy customization of the model's template, system prompt and parameters.

Installation

Using brew for MacOS:

brew tap ggozad/formulas
brew install ggozad/formulas/oterm

Using pip:

pip install oterm

Using

In order to use oterm you will need to have the Ollama server running. By default it expects to find the Ollama API running on http://0.0.0.0:11434/api. If you are running Ollama inside docker or on a different host/port, use the OLLAMA_HOST environment variable to customize the host/port. Alternatively you can use OLLAMA_URL to specify the full http(s) url. Setting OTERM_VERIFY_SSL to False will disable SSL verification.

OLLAMA_URL=http://host:port/api

The following keyboard shortcuts are available:

  • ctrl+n - create a new chat session

  • ctrl+r - rename the current chat session

  • ctrl+x - delete the current chat session

  • ctrl+t - toggle between dark/light theme

  • ctrl+q - quit

  • ctrl+l - switch to multiline input mode

  • ctrl+p - select an image to include with the next message

Customizing models

When creating a new chat, you may not only select the model, but also customize the template as well as the system instruction to pass to the model. Checking the JSON output checkbox will cause the model reply in JSON format. Please note that oterm will not (yet) pull models for you, use ollama to do that. All the models you have pulled or created will be available to oterm.

Chat session storage

All your chat sessions are stored locally in a sqlite database. You can find the location of the database by running oterm --db.

Screenshots

Chat Model selection Image selection

License

This project is licensed under the MIT License.

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

oterm-0.1.21.tar.gz (17.5 kB view details)

Uploaded Source

Built Distribution

oterm-0.1.21-py3-none-any.whl (23.3 kB view details)

Uploaded Python 3

File details

Details for the file oterm-0.1.21.tar.gz.

File metadata

  • Download URL: oterm-0.1.21.tar.gz
  • Upload date:
  • Size: 17.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.7.1 CPython/3.10.13 Linux/6.2.0-1018-azure

File hashes

Hashes for oterm-0.1.21.tar.gz
Algorithm Hash digest
SHA256 529fbe8b276db53c17fb41698482628d357c3b111b3d783b3f287dbb1bda3b4c
MD5 88a98534d718e02ce2179c4b8479b5ed
BLAKE2b-256 628a5b29162e4b8d1fd4f8c7eb3388b86e1ddaf5c6550ce66cb88078fb677f43

See more details on using hashes here.

File details

Details for the file oterm-0.1.21-py3-none-any.whl.

File metadata

  • Download URL: oterm-0.1.21-py3-none-any.whl
  • Upload date:
  • Size: 23.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.7.1 CPython/3.10.13 Linux/6.2.0-1018-azure

File hashes

Hashes for oterm-0.1.21-py3-none-any.whl
Algorithm Hash digest
SHA256 d000db9332f1c33c4a6b22a7587a5b262c5c6cb4b9402d410894b97066dfcb3f
MD5 9ee7da5c11725829dd8ed39284e3b21e
BLAKE2b-256 3b2e18df585a2f64fc5bc388f427d053c347051462cdf722fdcc3406768b0a9c

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