Skip to main content

PyPI python commit activity Build Status Code style: black

🤖 MAKE AI POWERED SEARCH INSIDE YOUR CLI 💻


Features


cgpt


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 and gpt-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 as client.

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.

Metadata

Release files for cgpt 1.2.11

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for cgpt 1.2.11
File Size Uploaded
cgpt-1.2.11.tar.gz 9.5 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for cgpt 1.2.11
File Interpreter ABI Platform
cgpt-1.2.11-py3-none-any.whl Python 3 none any Details

Total release size: 21.2 kB

Release files / cgpt-1.2.11.tar.gz

Download URL cgpt-1.2.11.tar.gz
Size 9.5 kB
Tags Source
SHA-256 checksum
How to use checksums
71489b526d44eb39cf6f292a5d8ee0c89e401b632430db4e1d967c7eb7fe2705
BLAKE2b-256 checksum
How to use checksums
2141689f282616a0bb1a1cad11aaf2837a752e9a5afdecc7e5fb7f0cdfc26780
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/5.0.0 CPython/3.9.18

Release files / cgpt-1.2.11-py3-none-any.whl

Download URL cgpt-1.2.11-py3-none-any.whl
Size 11.7 kB
Tags Python 3
SHA-256 checksum
How to use checksums
558435ed79a3ea2cde369732a0f9952c07499d7a3742628ce24017b2900b179d
BLAKE2b-256 checksum
How to use checksums
1b22867e3e5e187d29c4a6f50447a5d246f00a1c6c3a5f5f64aadd674933d97f
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/5.0.0 CPython/3.9.18
Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page