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.4.tar.gz (11.0 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.4-py3-none-any.whl (10.7 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for dotchatbot-0.1.4.tar.gz
Algorithm Hash digest
SHA256 8cbb1011967ef469c2a1f853ddee55dd3e50348b68cd8ffd41d133fb2885c1d0
MD5 728dfdc51309fa0a8a865363c59a46d5
BLAKE2b-256 0b21113fbb126ba1427416c20c1cd7aabf430a172652f7a11247d6a84c51ae76

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for dotchatbot-0.1.4-py3-none-any.whl
Algorithm Hash digest
SHA256 5e28238e75b913364fd0f06c74633143f521bbe8c0b20a32eb4445d92ec61657
MD5 3173299834f4d9a859f9a22d2769cee8
BLAKE2b-256 58c0da7c68198cd03d14b914e19ecb5e6a3c1b66eb6633f22e23711ff0bd7f9d

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