This CLI tool allows you to easily chat with chatGPT in the command line. You can chat with it, ask questions, and even translate text. It also
Project description
AI Tools for chatGPT
This CLI tool allows you to conveniently use chatGPT or new bing in the command line interface. You can chat with it or ask it questions. It can also help you translate text and supports rendering markdown in the terminal.
Dependencies
- OPENAI_API_BASE (optional)
If you are unable to access https://api.openai.com
due to GFW, you can specify another API address using the OPENAI_API_BASE
environment variable. It is recommended to use this method as it is
more stable than using a proxy. For information on how to use Cloudflare Workers to set up a proxy, see Setting up an OpenAI API Proxy with Cloudflare
Workers.
- OPENAI_API_KEY
You can set the OPENAI_API_KEY
environment variable or specify it using the --api-key
parameter. You can also set it using the ai setting
command.
If you use Azure OpenAI, you can set the AZURE_OPENAI_API_KEY
or AZURE_OPENAI_AD_TOKEN
environment variable. and AZURE_OPENAI_ENDPOINT
for Azure OpenAI endpoint.
- Gemini Pro
If you use the Gemini, you can set the GOOGLE_API_KEY
or --google-api-key
parameter. You can also set it using the ai setting
command. Need to set bot to GeminiBot
by ai setting --edit bot=GeminiBot
.
Now, support gemini-pro
mode only. You can set by ai setting --edit mode=gemini-pro
, or ai --mode gemini-pro
.
- Bard Support [Deprecated]
If you use the Bard Bot, you must be logged into Google Bard on at least one browser, which will automatically be detected.
- Bing Cookie
If you use the Bing Bot, you need to set the Bing Cookie. You can set it using the ai setting
command.
ai setting --edit bing_cookie="BING_COOKIE.JSON"
For information on how to get the cookie, see Checking Access Required for Bing Bot.
Installation
pip install py-ai-cli
Alternatively, install the latest version:
pip install git+https://github.com/yufeikang/ai-cli.git
Configuration
You can now set the API key and API base using the ai setting
command. Environmental variables and CLI parameters are still valid.
# View settings
ai setting
# Set settings
ai setting -e
Usage
Use ai -h
to view all supported commands.
- Automatic Commit Messages
ai commit
- Ask a Question
ai ask "Hello"
# no stream mode
ai --no-stream ask "Hello"
# help
ai ask --help
# use pre prompt
curl -s https://raw.githubusercontent.com/yufeikang/ai-cli/main/README.md | ai ask --prompt "summary this, how to install"
- Translation
ai translate "Hello"
ai translate "Hello" -t japanese
ai translate -t english -f "file.txt"
echo "Hello" | ai translate -t english
cat "file.txt" | ai translate -t english
- Chatting
ai chat
- Code Review
ai review
ai review -t develop
ai review -t HEAD~1
Proxy Support
OPENAI_API_BASE is more stable with a forward proxy. It is recommended.
Support environment variables HTTP_PROXY
and HTTPS_PROXY
, or ALL_PROXY
. You can also specify a proxy using the --proxy
parameter.
For example:
export HTTP_PROXY=http://x.x.x.x:xxxx
# or
export HTTPS_PROXY=https://x.x.x.x:xxxx
SOCKS5 proxy is also supported, for example:
export ALL_PROXY=socks5://x.x.x.x:xxxx
SOCKS5 proxy requires pip install pysocks
.
Additional Information
Please use ai --help
to view more commands.
Thanks
This project is developed using JetBrains products.
Project details
Release history Release notifications | RSS feed
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 py-ai-cli-0.5.3.tar.gz
.
File metadata
- Download URL: py-ai-cli-0.5.3.tar.gz
- Upload date:
- Size: 19.0 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.0.0 CPython/3.12.3
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | afe046d9fba37a3af4ada1ef825e3a4e1833cbc64cb46686de4fe5a425d1ff4d |
|
MD5 | 266a8ff54148a7ebce1438cbdc677cb1 |
|
BLAKE2b-256 | e1e8b3e309f12374ce6d4cd8feaac5a899de2dc58dcd267b6c823198dfd11bc6 |
File details
Details for the file py_ai_cli-0.5.3-py3-none-any.whl
.
File metadata
- Download URL: py_ai_cli-0.5.3-py3-none-any.whl
- Upload date:
- Size: 17.5 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.0.0 CPython/3.12.3
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | bbcfa5f7e2635c9a58aa0d73c18db005328ab0fd4fe52155228c0d0d25baca8d |
|
MD5 | 725744b6af2577af61beba6649a164e2 |
|
BLAKE2b-256 | bc6091aeac3240eebb7e673399f6cd2d7ccc7d96c0b9cc7349f49561795879de |