| Name | charla JSON |
| Version |
1.0.0
JSON |
| download |
| home_page | None |
| Summary | A terminal based chat application that works with local language models. |
| upload_time | 2024-06-27 22:33:43 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.10 |
| license | None |
| keywords |
chat-client
chatbot
cli
llm
ollama
terminal
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# Charla: Terminal-Based Chat Application with Ollama Backend Integration
[](https://pypi.org/project/charla)
[](https://pypi.org/project/charla)
**Charla** is a terminal based chat application that integrates with [Ollama](https://ollama.com/), a backend designed to serve language models. To use Charla, ensure that the `ollama` server is running and at least one language model is installed.
## Installation
Install Charla using `pipx`:
```console
pipx install charla
```
## Usage
Launch the chat console by typing `charla` in your terminal, or view all available command line options with `charla -h`.
## Features
* Terminal-based chat system that supports context aware conversations using local language models.
* Chat sessions are saved as markdown files in the user's documents directory when ending a chat.
* Prompt history is saved and previously entered prompts are auto-suggested.
* Mode switching between single-line and multi-line input without interruption to your chat session.
## Development
Run the command-line interface directly from the project source without installing the package:
```console
python -m charla.cli
```
### ollama API
Installed models:
```console
curl http://localhost:11434/api/tags
```
Model info:
```console
curl http://localhost:11434/api/show -d '{"name": "phi3"}'
```
## License
Charla is distributed under the terms of the [MIT](https://spdx.org/licenses/MIT.html) license.
Raw data
{
"_id": null,
"home_page": null,
"name": "charla",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": null,
"keywords": "chat-client, chatbot, cli, llm, ollama, terminal",
"author": null,
"author_email": "Ramiro G\u00f3mez <code@ramiro.org>",
"download_url": "https://files.pythonhosted.org/packages/67/25/017b2cc758ba3bb9dead3e63e3b3a602cc301ffd8c06b1ae62150167be2b/charla-1.0.0.tar.gz",
"platform": null,
"description": "# Charla: Terminal-Based Chat Application with Ollama Backend Integration\n\n[](https://pypi.org/project/charla)\n[](https://pypi.org/project/charla)\n\n**Charla** is a terminal based chat application that integrates with [Ollama](https://ollama.com/), a backend designed to serve language models. To use Charla, ensure that the `ollama` server is running and at least one language model is installed.\n\n## Installation\n\nInstall Charla using `pipx`:\n\n```console\npipx install charla\n```\n\n## Usage\n\nLaunch the chat console by typing `charla` in your terminal, or view all available command line options with `charla -h`.\n\n## Features\n\n* Terminal-based chat system that supports context aware conversations using local language models.\n* Chat sessions are saved as markdown files in the user's documents directory when ending a chat.\n* Prompt history is saved and previously entered prompts are auto-suggested.\n* Mode switching between single-line and multi-line input without interruption to your chat session.\n\n## Development\n\nRun the command-line interface directly from the project source without installing the package:\n\n```console\npython -m charla.cli\n```\n\n### ollama API\n\nInstalled models:\n\n```console\ncurl http://localhost:11434/api/tags\n```\n\nModel info:\n\n```console\ncurl http://localhost:11434/api/show -d '{\"name\": \"phi3\"}'\n```\n\n## License\n\nCharla is distributed under the terms of the [MIT](https://spdx.org/licenses/MIT.html) license.\n",
"bugtrack_url": null,
"license": null,
"summary": "A terminal based chat application that works with local language models.",
"version": "1.0.0",
"project_urls": {
"Documentation": "https://github.com/yaph/charla#readme",
"Issues": "https://github.com/yaph/charla/issues",
"Source": "https://github.com/yaph/charla"
},
"split_keywords": [
"chat-client",
" chatbot",
" cli",
" llm",
" ollama",
" terminal"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "0f27b2c8e2a9b3c69575383262bc8352c1e675441e2cae1597af2c42927e9833",
"md5": "21b19c85255a4b9ef264f428ec7bc224",
"sha256": "ed4066ede449ba038c57406aaa600d982e1017c64665894ec9a20fee0ce03c81"
},
"downloads": -1,
"filename": "charla-1.0.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "21b19c85255a4b9ef264f428ec7bc224",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 5882,
"upload_time": "2024-06-27T22:33:45",
"upload_time_iso_8601": "2024-06-27T22:33:45.404913Z",
"url": "https://files.pythonhosted.org/packages/0f/27/b2c8e2a9b3c69575383262bc8352c1e675441e2cae1597af2c42927e9833/charla-1.0.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "6725017b2cc758ba3bb9dead3e63e3b3a602cc301ffd8c06b1ae62150167be2b",
"md5": "7bae05755117365563d08151db156d27",
"sha256": "5d63ebb8dc97b6ae1bce5fd57d1e2404731c5148f3ddb561b26db6f2be8e46ba"
},
"downloads": -1,
"filename": "charla-1.0.0.tar.gz",
"has_sig": false,
"md5_digest": "7bae05755117365563d08151db156d27",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 6659,
"upload_time": "2024-06-27T22:33:43",
"upload_time_iso_8601": "2024-06-27T22:33:43.769919Z",
"url": "https://files.pythonhosted.org/packages/67/25/017b2cc758ba3bb9dead3e63e3b3a602cc301ffd8c06b1ae62150167be2b/charla-1.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-06-27 22:33:43",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "yaph",
"github_project": "charla#readme",
"github_not_found": true,
"lcname": "charla"
}
