Skip to main content

Charla: Chat with Language Models in a Terminal

PyPI - Version PyPI - Python Version

Charla is a terminal based application for chatting with language models. Charla integrates with Ollama and GitHub Models for exchanging messages with model services.

preview

Features

  • Terminal-based chat system that supports context aware conversations with language models.
  • Support for local and cloud models via Ollama and GitHub Models.
  • Chat messages are automatically saved during and at the end of chat sessions.
  • Saved chat sessions can be continued.
  • Prompt history is saved and previously entered prompts are auto-suggested.
  • Switch between single-line and multi-line input modes without interrupting the chat session.
  • Store user preferences in user config or current directory settings files.
  • Provide a system prompt for a chat session.
  • Load content from local files and web pages to append to prompts.
  • Markdown in assistant responses and system prompts is rendered in the terminal.

Installation

To use Charla with models on your computer, you need a running installation of the Ollama server and at least one supported language model must be installed. For GitHub Models you need access to the service and a GitHub token. Please refer to the documentation of the service provider you want to use for installation and setup instructions.

Install Charla using pipx:

pipx install charla

For GitHub models, set the environment variable GITHUB_TOKEN to your token. In Bash enter:

export GITHUB_TOKEN=YOUR_GITHUB_TOKEN

Usage

After successful installation and setup you can launch the chat console with the charla command in your terminal.

If you use Charla with Ollama, the default provider, you only need to specify the model to use, e.g.:

charla -m gpt-oss

To use Ollama cloud models, you need to run them once with the ollama command and then you can use them, e.g.:

ollama run gpt-oss:cloud
charla -m gpt-oss:cloud

If you want to use GitHub Models, you have to set the provider:

charla -m gpt-4o --provider github

You can set a default model and change the default provider in your user settings file.

Settings

Settings can be specified as command line arguments and in the settings files. Command line arguments have the highest priority. The location of your user config settings file depends on your operating system. Use the following command to show the location:

charla settings --location

You can also store settings in the current working directory in a file named .charla.json. The settings in this local override the user config settings.

To save the current settings to a .charla.json file in the current directory, use the --save argument:

charla settings --save

Example settings for using OpenAI's GPT-4o model and the GitHub Models service by default.

{
    "model": "gpt-4o",
    "chats_path": "./chats",
    "prompt_history": "./prompt-history.txt",
    "provider": "github",
    "message_limit": 20,
    "multiline": false
}

CLI Help

Output of charla -h with information on all available command line options.

usage: charla [-h] [--model MODEL] [--chats-path CHATS_PATH] [--prompt-history PROMPT_HISTORY]
                             [--provider PROVIDER] [--message-limit MESSAGE_LIMIT] [--multiline] [--system-prompt SYSTEM_PROMPT]
                             [--think {true,false,low,medium,high}] [--version]
                             {settings} ...

Chat with language models.

positional arguments:
  {settings}            Sub Commands
    settings            Show current settings.

options:
  -h, --help            show this help message and exit
  --model MODEL, -m MODEL
                        Name of language model to chat with.
  --chats-path CHATS_PATH
                        Directory to store chats.
  --prompt-history PROMPT_HISTORY
                        File to store prompt history.
  --provider PROVIDER   Name of the provider to use.
  --message-limit MESSAGE_LIMIT
                        Maximum number of messages to use for context.
  --multiline           Use multiline mode.
  --system-prompt SYSTEM_PROMPT, -sp SYSTEM_PROMPT
                        File that contains system prompt to use.
  --think {true,false,low,medium,high}
                        Enable thinking for Ollama models that support it.
  --version             show program's version number and exit

Development

Run the command-line interface directly from the project source without installing the package:

python -m charla.cli

License

Charla is distributed under the terms of the MIT license.

Release files for charla 3.0.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for charla 3.0.0
File Size Uploaded
charla-3.0.0.tar.gz 16.9 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for charla 3.0.0
File Interpreter ABI Platform
charla-3.0.0-py3-none-any.whl Python 3 none any Details

Total release size: 29.6 kB

Release files / charla-3.0.0.tar.gz

Download URL charla-3.0.0.tar.gz
Size 16.9 kB
Tags Source
SHA-256 checksum
How to use checksums
8b0bcb3d089e674320a63dfcb975a8a3e1d2f0d7c3c1e56fa8b12a9282a800b6
BLAKE2b-256 checksum
How to use checksums
0c68e3bf1006902638455cdd17be6c38c00e2ad2056a3a96c56bb473c97b7766
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via Hatch/1.16.1 cpython/3.12.3 HTTPX/0.27.2

Release files / charla-3.0.0-py3-none-any.whl

Download URL charla-3.0.0-py3-none-any.whl
Size 12.8 kB
Tags Python 3
SHA-256 checksum
How to use checksums
868329dfdbbc5b146576b60c9ea4e1043adf15b6b9ea0a89eedbe4485807717d
BLAKE2b-256 checksum
How to use checksums
affad3cdb7df112e52d3e2d56a2322f830cf5a3e158a5d7fcb31df315b60a019
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via Hatch/1.16.1 cpython/3.12.3 HTTPX/0.27.2

Release history Release notifications | RSS feed

This release

3.0.0 This release

2 release files

2.3.0

2 release files

2.2.1

2 release files

2.2.0

2 release files

2.1.0

2 release files

2.0.0

2 release files

1.2.0

2 release files

1.1.0

2 release files

1.0.0

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page