Skip to content
This repository has been archived by the owner on Feb 6, 2024. It is now read-only.

Hishantik/openAI-shell-cli

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

46 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

DekuAI

Version Version Discord

Supported platforms

os Android os Linux os MacOs os Windows


Generate response from openai GPT-3 model given any text prompt it will try to return a text completion in simple and concise format.

DekuAI saves your time providing you a feature similar to chatGPT in your terminal. It is an interactive AI based CLI tool with the power of TUI that provides you a general purpose "text-in,text-out" interface in your terminal. It uses gpt-3 model text-davinci-003 & completion endpoint which is very powerful interface that attempts to match whatever context or pattern you gave it to extract data using OpenAI api. For example if you give the API the prompt "As Descartes said, I think, therefore", it will return the completion " I am" with high probability.

Native Support

supported platforms completion dalle
Android (Termux) ✔️ ✔️
Linux (Debian) ✔️ ✔️
Linux (Archlinux)
Mac Os (iterm) ✔️ ❌ (comming soon)
Windows (WSL) ✔️
____________________ ________________ _______________

Showcase

DekuAI.webm
snapshots
  1. Auth Section

Screenshot from 2023-02-08 18-51-18

  1. Prompt Section

Screenshot from 2023-02-08 18-53-22

  1. Output Section

Screenshot from 2023-02-08 19-02-46


Table of contents

Getting Started

Prerequisites

DekuAI uses packages such as curl for request to api , jq to parse the json data, gum for interface, awk to interpret the pattern of string & grep to search for text within the file.

  • To use DeuAI Openai API key token is required. Create an OpenAI account and obatain api key token from Openai.

Installation

Note : If it throw any common error while installing such as (permission denied),then try to run install script using sudo command. After sucessful installation, enter your api key when prompted.

Android

Install termux (guide)

Termux package

pkg install curl -y

then

sh -c "$(curl -fsSL https://raw.githubusercontent.com/hishantik/OpenAI-shell-cli/main/install.sh)"

Linux

Debian

from source

sudo apt install curl -y    

then

sudo sh -c "$(curl -fsSL https://raw.githubusercontent.com/hishantik/OpenAI-shell-cli/main/install.sh)"

Using package manager

sudo apt update && apt install wget -y 

then

wget -qO- https://hishantik.github.io/dekuai-cli-ppa/KEY.gpg | sudo tee /etc/apt/trusted.gpg.d/dekuai-cli.asc
wget -qO- https://hishantik.github.io/dekuai-cli-ppa/dekuai-cli-debian.list | sudo tee /etc/apt/sources.list.d/dekuai-cli-debian.list
sudo apt update
sudo apt install dekuai-cli

macOS

Install the dependencies required (see below).

Install Homebrew if not installed.

To install dependencies required on macOS using homebrew run :

brew install curl

then from source

sh -c "$(curl -fsSL https://raw.githubusercontent.com/hishantik/OpenAI-shell-cli/main/install.sh)"

Windows

To make it work with Windows you must install and configure WSL with debian based linux (ubuntu) in windows after complete installation of wsl run below command on shell

 sudo apt-get upgrade && apt-get update
 sudo apt-get install curl 

then from source

sudo sh -c "$(curl -fsSL https://raw.githubusercontent.com/hishantik/OpenAI-shell-cli/main/install.sh)"

Usage

Simply run dekuai anywhere in the shell prompt

 dekuai

or to see more options type

dekuai --menu
Keybinds
binds description
-m or --mmenu to see more features and options
-v or --version shows current version
-h or --help shows help text
-U or --update update to newest version available
-u or --uninstall To uninstall the cli

Uninstall

To uninstall (DekuAI) run below command in the shell prompt

 dekuai -u

or type

dekuai --menu 

it will show to uninstall button.


Dependencies


Contributing

Pull request are welcome. To add some feature or changes please open an issue first to discuss what changes you would like to add.

If you have any issues regarding the DekuAI , join our discord server

Discord Server


License

   copyright © 2022 DekuAI open source project

   THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
   IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
   FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
   AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
   LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
   OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
   SOFTWARE.

Credits

People who have contributed on DekuAI.