• Stars
    star
    101
  • Rank 338,166 (Top 7 %)
  • Language
    Python
  • License
    MIT License
  • Created over 1 year ago
  • Updated over 1 year ago

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

This CLI tool allows you to easily use chatGPT in the command line. You can chat with it, ask it questions, and get text translations. It also supports rendering Markdown in the terminal.

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.

PyPI

English | 中文 | 日本語

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.

  • 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

JetBrains Logo (Main) logo

This project is developed using JetBrains products.