chap - A Python interface to chatgpt, including a terminal user interface (tui)

installation

Install with e.g., pipx install .

configuration

Put your OpenAI API key in the platform configuration directory for chap, e.g., on linux/unix systems at ~/.config/chap/openai_api_key

commandline usage

• chap ask "What advice would you give a 20th century human visiting the 21st century for the first time?"

• chap render --last

interactive terminal usage

• chap tui

Sessions & Commandline Parameters

Details of session handling & commandline arguments are in flux. For now, the deprecated chap-ask, chap-render and chap-tui are still supported but they will be removed in the future.

By default, a new session is created. It is saved to the user's state directory (e.g., ~/.local/state/chap on linux/unix systems).

You can specify the session filename for a new session with -n or to re-open an existing session with -s. Or, you can continue the last session with --last.

You can set the "system message" with the -S flag.

You can select the text generating backend with the -b flag:

• openai_chatgpt: the default, paid API, best quality results
• textgen: Works with https://github.com/oobabooga/text-generation-webui and can run locally with various models, basic and low quality. Needs the server URL in $configuration_directory/textgen_url.
• lorem: local non-AI lorem generator for testing