Skip to main content

CLI Companion

CLI Companion is a command line tool that you can use to ask questions and get responses back from a virtual companion. You can also review previous questions and responses.

Installation

First you need get an api key for chat-gpt. Then you create an environment variable named $CHATKEY

bash

export CHATKEY=<your-key>

fish

set CHATKEY=<your-key>

Using pip

pip install chat-companion

Using Poetry

poetry add chat-companion

Usage

run companion --help

To see the list of commands.

custom commands
===============
generate_response  proof_read   review     talk     
help               resummarize  summarize  translate

Talk

To ask a question, use the talk subcommand. For example:

companion talk "What is your name?"

Review

To review previous questions and responses, use the review subcommand. This will bring up a list of previous questions. You can then select a question to view the response.

Release files for chat-companion 0.2.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 chat-companion 0.2.0
File Size Uploaded
chat_companion-0.2.0.tar.gz 23.4 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for chat-companion 0.2.0
File Interpreter ABI Platform
chat_companion-0.2.0-py3-none-any.whl Python 3 none any Details

Total release size: 48.5 kB

Release files / chat_companion-0.2.0.tar.gz

Download URL chat_companion-0.2.0.tar.gz
Size 23.4 kB
Tags Source
SHA-256 checksum
How to use checksums
fd55444efdd42b7d8efce15e869a635cb4aa342f08eb077113039c44c49791ab
BLAKE2b-256 checksum
How to use checksums
9f685c120c1da5d122f1675ef4f9f31e7b0ab2aee1d71d8685f22cecae06fb1d
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via poetry/1.4.0 CPython/3.10.9 Linux/5.15.90.1-microsoft-standard-WSL2

Release files / chat_companion-0.2.0-py3-none-any.whl

Download URL chat_companion-0.2.0-py3-none-any.whl
Size 25.1 kB
Tags Python 3
SHA-256 checksum
How to use checksums
ce17868a965cad2900da56b65d37df0a5fcbb7b25a4838025a31f86e5bf361d3
BLAKE2b-256 checksum
How to use checksums
3b17dfa45b3ff0ab28d3bc14ba25aed55d3b159ce00c7a4f4a5f1a57e575a431
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via poetry/1.4.0 CPython/3.10.9 Linux/5.15.90.1-microsoft-standard-WSL2

Release history Release notifications | RSS feed

This release

0.2.0 This release

2 release files

0.1.7

2 release files

0.1.6

2 release files

0.1.5

2 release files

0.1.4

2 release files

0.1.3

2 release files

0.1.1

2 release files

0.1.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