Skip to main content

Chatbot CLI

Project description

dotchatbot

PyPI - Version PyPI - Python Version

A practitioners approach of working with chat-based LLMs

Demo of dotchatbot


Table of Contents

Features

  • File-based sessions
  • Markdown output rendering via rich
  • Session history and session resuming by just passing -
  • Automatic filenames via prompting

Installation

pipx install dotchatbot

Usage

Usage: dcb [OPTIONS] [FILENAME]

  Starts a session with the chatbot, resume by providing FILENAME. Provide - for
  FILENAME to use the previous session (stored in SESSION_HISTORY_FILE).

Options:
  -p, --system-prompt TEXT      The default system prompt to use  [default: You
                                are a helpful assistant.]
  --no-pager                    Do not output using pager
  --no-rich                     Do not output using rich
  -r, --reverse                 Reverse the conversation in the editor
  -y, --assume-yes              Automatic yes to prompts; assume "yes" as answer
                                to all prompts and run non-interactively.
  -n, --assume-no               Automatic no to prompts; assume "no" as answer
                                to all prompts and run non-interactively.
  -c, --current-directory       Use the current directory as the session file
                                location
  --session-history-file TEXT   The file where the session history is stored
                                [default:
                                /home/bpayne/.config/dotchatbot/.dotchatbot-
                                history]
  --session-file-location TEXT  The location where session files are stored
                                [default:
                                /home/bpayne/.config/dotchatbot/sessions]
  --session-file-ext TEXT       The extension to use for session files
                                [default: .dcb]
  --summary-prompt TEXT         The prompt to use for the summary (for building
                                the filename for the session)  [default: Given
                                the conversation so far, summarize it in just 4
                                words. Only respond with these 4 words]
  -s, --service-name TEXT       The chatbot provider service name  [default:
                                OpenAI]
OpenAI options:
  --openai-model     [default: gpt-4o]

Markdown options:
  --markdown-justify [default|left|center|right|full]
                              [default: default]
  --markdown-code-theme TEXT  [default: monokai]
  --markdown-hyperlinks
  --markdown-inline-code-lexer TEXT
  --markdown-inline-code-theme TEXT

Other options:
  --time / --no-time        Measure and print elapsed execution time.  [default:
                            no-time]
  --color, --ansi / --no-color, --no-ansi
                            Strip out all colors and all ANSI codes from output.
                            [default: color]
  -C, --config CONFIG_PATH  Location of the configuration file. Supports glob
                            pattern of local path and remote URL.  [default:
                            ~/.config/dcb/*.{toml,yaml,yml,json,ini,xml}]
  --show-params             Show all CLI parameters, their provenance, defaults
                            and value, then exit.
  --verbosity LEVEL         Either CRITICAL, ERROR, WARNING, INFO, DEBUG.
                            [default: WARNING]
  -v, --verbose             Increase the default WARNING verbosity by one level
                            for each additional repetition of the option.
                            [default: 0]
  --version                 Show the version and exit.
  -h, --help                Show this message and exit.

License

dotchatbot is distributed under the terms of 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

dotchatbot-0.1.3.tar.gz (10.8 kB view details)

Uploaded Source

Built Distribution

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

dotchatbot-0.1.3-py3-none-any.whl (10.6 kB view details)

Uploaded Python 3

File details

Details for the file dotchatbot-0.1.3.tar.gz.

File metadata

  • Download URL: dotchatbot-0.1.3.tar.gz
  • Upload date:
  • Size: 10.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.2

File hashes

Hashes for dotchatbot-0.1.3.tar.gz
Algorithm Hash digest
SHA256 b7b886435a4b7ed89650ebe9202f89b7083992131770a8754643a2dce706bf9c
MD5 1adcd431f9e397e83bd2b6ba876e3d8b
BLAKE2b-256 ab1a0c56152b39b94d9bcf077fa939f0012f45c423fd5777a24db29c9c263557

See more details on using hashes here.

File details

Details for the file dotchatbot-0.1.3-py3-none-any.whl.

File metadata

  • Download URL: dotchatbot-0.1.3-py3-none-any.whl
  • Upload date:
  • Size: 10.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.2

File hashes

Hashes for dotchatbot-0.1.3-py3-none-any.whl
Algorithm Hash digest
SHA256 e8e1e19955e056981c1ee01e32891a08a6ce48555c566aff0a356d2af09d0625
MD5 cdd8884408f9268bd5e63da7807cb42b
BLAKE2b-256 9ed3fbb28d500807f895e9a3dff3f9a9c7bb80a96d9824e12a85b482d6e6e3e6

See more details on using hashes here.

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