Skip to content

marpit19/charmlama

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

19 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

CharmLlama

CharmLlama is a delightful CLI-based chat application that allows you to interact with Ollama's open-source language models locally. Built with Go and Charm libraries, it offers a rich terminal experience for AI-powered conversations.

CharmLlama Logo

CharmLlama Demo

Features

  • 🚀 Easy installation and setup
  • 🤖 Automatic Ollama installation and management
  • 🎨 Interactive model selection
  • ✨ Stunning CLI interface with animations
  • 💬 Real-time chat with Ollama models
  • 📜 Markdown rendering for AI responses
  • 🔄 Scrollable chat history

Prerequisites

  • Go 1.17 or later
  • Ollama (CharmLlama will guide you through the installation if not present)

Installation

Option 1: Go Install

If you have Go installed, you can install CharmLlama using:

go install github.com/marpit19/charmlama@latest

If the binary exists, add the Go bin directory to your PATH: For Zsh, add this line to your ~/.zshrc file:

export PATH=$PATH:$(go env GOPATH)/bin

Then reload your shell configuration:

source ~/.zshrc

Option 2: Download Binary

  1. Visit the Releases page.
  2. Download the appropriate binary for your operating system:
    • Windows: charmlama-vX.X.X-windows-amd64.exe
    • macOS: charmlama-vX.X.X-darwin-amd64
    • Linux: charmlama-vX.X.X-linux-amd64
  3. Rename the binary to charmlama (or charmlama.exe on Windows).
  4. Move the binary to a directory in your PATH.
  5. On macOS and Linux, make the binary executable:
    chmod +x charmlama

Option 3: Build from Source

  1. Clone the repository:
    git clone https://github.com/marpit19/charmlama.git
    cd charmlama
  2. Build the project:
    go build -o charmlama
  3. Move the binary to a directory in your PATH.

Usage

  1. Open a terminal and run:
    charmlama
  2. If Ollama is not installed, CharmLlama will guide you through the installation process.
  3. Select a model from the available options.
  4. Start chatting with the AI!

Commands

  • /exit: Exit the application

For more information on available commands, use:

charmlama --help

Contributing

We welcome contributions to CharmLlama! Please see our Contributing Guide for more details on how to get started.

License

CharmLlama is released under the MIT License. See the LICENSE file for details.

Acknowledgements

  • Charm for their amazing terminal libraries
  • Ollama for making local AI models accessible

Support

If you encounter any issues or have questions, please open an issue on our GitHub repository.


Built with ❤️ by Arpit Mohapatra