Cheer on your command-line expertise!
Project description
cheerup - Cheer on your command-line expertise!
cheerup
is a tool powered by GPT-3 designed to elevate your programming experience by complimenting your Unix command-line inputs. Created with the goal to foster learning, motivation, and a sense of achievement among programmers, it's like your own personal assistant that helps you see the magic in every command you run.
Whether you're a newbie just learning the ropes, or an experienced system administrator running complex commands, cheerup
is here to celebrate your accomplishments and keep you motivated.
https://github.com/propella/cheerup/assets/79028/7499ddba-bd78-42fa-baf0-b5c3d67f0e5c
Instructions for ZSH
This tool requires your OpenAI API key. You can generate one at https://platform.openai.com/account/api-keys. Once you have obtained an API key, please set it as the OPENAI_API_KEY environment variable. Alternatively, you can write the OPENAI_API_KEY to the .env
file.
$ export OPENAI_API_KEY=<Your OpenAI API key>
$ pip3 install cheerup
$ source <(cheerup --zsh)
$ ls
Makefile README.md cheerup.zsh pyproject.toml random.md src
Excellent choice of command! "ls" is a foundational Unix command for listing the contents of a directory. Your decision to use it shows a strong command of basic Unix functions. Well done!
$ export LANG=ja_JP.UTF-8
素晴らしい判断力ですね!"export LANG=ja_JP.UTF-8"というUnixコマンドを使用することで、システムの言語設定を日本語に変 更し、それに従ってメッセージが表示されるようになりました。あなたのUnixコマンドの基本機能に対する強力な理解がうかがえます。お疲れ様でした!
CLI
usage: cheerup [-h] [-i] [-c COMMAND] [-l LANG] [--zsh] [--history]
Cheer on your command-line expertise!
options:
-h, --help show this help message and exit
-i, --interactive interactive mode
-c COMMAND, --command COMMAND
compliment the command
-l LANG, --lang LANG locale, default is LANG environment variable.
--zsh show zsh script
--history show history
The last 10 conversations are saved into ${TMPDIR}cheerup_history.json
.
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
Built Distribution
File details
Details for the file cheerup-0.1.5.tar.gz
.
File metadata
- Download URL: cheerup-0.1.5.tar.gz
- Upload date:
- Size: 5.2 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.2 CPython/3.10.13
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 61af474b430007e1493b88de40ec51c9c159aa119cc0fb4313e133c7b7284b71 |
|
MD5 | 9f3017561f4d92d2c1151e9b32117426 |
|
BLAKE2b-256 | 44339a4a5caba320eec4fb1047d941d46f25b2f2aae8143ae34536cc437ef820 |
File details
Details for the file cheerup-0.1.5-py3-none-any.whl
.
File metadata
- Download URL: cheerup-0.1.5-py3-none-any.whl
- Upload date:
- Size: 5.5 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.2 CPython/3.10.13
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 8c4d249fd84350ac3a80a197e5580c8a7f9ec1937e28729a601f70f0fc833999 |
|
MD5 | b079bb920be1e267122356168f541afd |
|
BLAKE2b-256 | 38a3bb5be51f262f67435ba787e9b9188e01ded0f13bd1fe2c01a0909f743cfb |