Skip to main content

A command-line interface for Ollama API

Project description

mdllama

Build and Publish mdllama DEB and RPM

Build and Publish mdllama DEB and RPM (testing branch)

Publish to PyPI on mdllama.py Update

PPA development (GH Pages)

A CLI tool that lets you chat with Ollama models right from your terminal, with built-in Markdown rendering.

mdllama makes it easy to interact with Ollama's AI models directly from your command line, meanwhile providing you with real-time Markdown rendering

Features

  • Chat with Ollama models from the terminal
  • Built-in Markdown rendering
  • Simple installation and removal (see below)

Screenshots

Chat Interface

Chat

Help

Help

Live Demo

Go to this mdllama demo to try it out live in your browser. The API key is 9c334d5a0863984b641b1375a850fb5d

[!NOTE] Try asking the model to give you some markdown-formatted text, like:

Give me a markdown-formatted text about the history of AI.

So try it out and see how it works!

Installation

Install using package manager (recommended)

Debian/Ubuntu Installation

  1. Add the PPA to your sources list:

    echo 'deb [trusted=yes] https://packages.qincai.xyz/debian stable main' | sudo tee /etc/apt/sources.list.d/qincai-ppa.list
    sudo apt update
    
  2. Install mdllama:

    sudo apt install python3-mdllama
    

Fedora Installation

  1. Download the latest RPM from: https://packages.qincai.xyz/fedora/

    Or, to install directly:

    sudo dnf install https://packages.qincai.xyz/fedora/mdllama-<version>.noarch.rpm
    

    Replace <version> with the latest version number.

  2. (Optional, highly recommended) To enable as a repository for updates, create /etc/yum.repos.d/qincai-ppa.repo:

    [qincai-ppa]
    name=Raymont's Personal RPMs
    baseurl=https://packages.qincai.xyz/fedora/
    enabled=1
    metadata_expire=0
    gpgcheck=0
    

    Then install with:

    sudo dnf install mdllama
    

3, Install the ollama library from pip:

pip install ollama

You can also install it globally with:

sudo pip install ollama

[!NOTE] The ollama library is not installed by default in the RPM package since there is no system ollama package avaliable (python3-ollama). You need to install it manually using pip in order to use mdllama with Ollama models.


Traditional Bash Script Installation (Linux)

To install mdllama using the traditional bash script, run:

bash <(curl -fsSL https://raw.githubusercontent.com/QinCai-rui/mdllama/refs/heads/main/install.sh)

To uninstall mdllama, run:

bash <(curl -fsSL https://raw.githubusercontent.com/QinCai-rui/mdllama/refs/heads/main/uninstall.sh)

Windows & macOS Installation

Install via pip (recommended for Windows/macOS):

pip install mdllama

License

This project is licensed under the GNU General Public License v3.0. See the LICENSE file for details.


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

mdllama-4.0.0.tar.gz (35.4 kB view details)

Uploaded Source

Built Distribution

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

mdllama-4.0.0-py3-none-any.whl (39.3 kB view details)

Uploaded Python 3

File details

Details for the file mdllama-4.0.0.tar.gz.

File metadata

  • Download URL: mdllama-4.0.0.tar.gz
  • Upload date:
  • Size: 35.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for mdllama-4.0.0.tar.gz
Algorithm Hash digest
SHA256 1afe2d9ceef504ca04ac7c3fcb952d0d667257fa50def690ca9b66a5998d3c86
MD5 298805b81b78c0a9abb79c89ede196f4
BLAKE2b-256 6746b9ccb52fccd50e0b3863410aa9e269e93ada976588c4351f73e106f48f48

See more details on using hashes here.

Provenance

The following attestation bundles were made for mdllama-4.0.0.tar.gz:

Publisher: publish-to-pypi.yml on QinCai-rui/mdllama

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file mdllama-4.0.0-py3-none-any.whl.

File metadata

  • Download URL: mdllama-4.0.0-py3-none-any.whl
  • Upload date:
  • Size: 39.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for mdllama-4.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 8540e56c88733f7280a8e80e4e97839dcb76594b91908c3ebeeaab2445fb2e3e
MD5 2704627352f766dcbc66ff3c8bd98999
BLAKE2b-256 9cdb40ade9213548597ca0540b6add32ea3179f60a669d9a6ec27bc0f9d6c669

See more details on using hashes here.

Provenance

The following attestation bundles were made for mdllama-4.0.0-py3-none-any.whl:

Publisher: publish-to-pypi.yml on QinCai-rui/mdllama

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

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