Skip to main content

Cgpt

Project description

PyPI python commit activity Build Status Code style: black

🤖 MAKE AI POWERED SEARCH INSIDE YOUR CLI 💻


⭐ FEATURES


cgpt1 1 28 (1)


DESCRIPTIONS

  • cgpt is a Python package 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.

:question: REQUIREMENTS

  • python >=3.7
  • openai API KEY : You need to register on openai to receive your own api key , here : api_key.

INSTALL FROM PYPI

You can install the latest version from pypi.

pip install cgpt

🖥️ SETUP FOR DEVELOPPERS

pip install -r requirements.txt

🔨 BUILD

  • For this part , it is better to use Linux.

If you are on Linux , launch:

sudo chmod +x build.sh

Then , :

./build.sh

⏯️ VERIFY INSTALLATION

cgpt-version

🚀 RUN

cgpt

:link: CGPT INSIDE A LOCAL NETWORK

You can 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 Chat GPT as client.

NOTES :

  • For now , a server must be launched inside a Linux computer . If the server is inside Windows : the address is sometimes wrong (to be fixed in the next version).

  • Also , make sure that your /etc/hosts is configured correctly like :

127.0.0.1	localhost
127.0.1.1	your-hostanme
  • A client can also use his own api_key in the next version.

:whale2: BUILD AND RUN WITH DOCKER

  • To make it easier , use the docker-compose.yml file :
docker-compose run --rm app

💚 Feedback

Please feel free to leave feedback in issues/PRs.

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

cgpt-1.2.3.tar.gz (10.1 kB view hashes)

Uploaded Source

Built Distribution

cgpt-1.2.3-py3-none-any.whl (11.4 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page