Cgpt
Project description
🤖 MAKE AI POWERED SEARCH INSIDE YOUR CLI 💻
Features
Descriptions
cgpt
is a REPL tool that allows you to use AI directly in your favorite Terminal.cgpt
is based on CLICK for creating beautiful command line interfaces in a composable way.
Prerequisities
-
python >=3.10
-
openai API KEY : You need to register on openai to receive your own api key , here : api_key.
This tool is still using
gpt-3.5-turbo
,gpt-4
andgpt-4-turbo
are on the way. 😉
Setup and Run
🚀 Run in local
You can directly install the latest version from pypi.
pip install cgpt
$ cgpt
CGPT inside a Local Area Network
You can also use cgpt inside a LAN.
- You just need one Host (
connected to internet
) to be the server. - Other Hosts (
not connected to internet
) can ALWAYS use the AI asclient
.
For more information , look here.
Run with Docker
Pull the image
$ docker pull ainayves/cgpt:latest
Run the docker image by using your openai api_key :
$ docker run -e OPENAI_API_KEY="yourapikey" -i -t ainayves/cgpt:latest
To run the LAN mode in docker :
$ docker run -e OPENAI_API_KEY="yourapikey" -i -t ainayves/cgpt:latest poetry run cgpt --lan
Devbox support
To make life easier for contributors , you can install and use Devbox.
Then , run this command in the root directory of the project:
$ devbox run start
⚠️ Warning for users only
Development of MacOS compatibility for
cgpt
is still ongoing and undergoing enhancements.
💚 Feedback
Please feel free to leave feedback in issues/PRs.
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.