Giter Site home page Giter Site logo

code-genie-cli's Introduction

code-genie-cli

Uses OpenAI's GPT API to get a helpful assistant within your terminal. Genie can suggest code executions that will be directly run after confirmation from the user. Forget the command to mount a drive? Simply ask code-genie-cli to do it for you!

ezgif.com-gif-maker.3.online-video-cutter.com.mp4

Installation

This project now only has python related depenencies and should work on both Windows and Unix. However everything is tested on Unix so I may be wrong. Windows users will need to install manually as I haven't yet made a windows installation script.

Do keep in mind that you'll need your OpenAI API key for this software to work (https://platform.openai.com/). You'll need to input the key when run for the first time, the key is stored in your home directory under .code-genie-cli/openai_key.txt.

Quick - Unix only

  • Clone project to local machine: git clone [email protected]:Shardj/code-genie-cli.git
  • Run cd code-genie-cli/ && ./install.sh and follow the steps

Manual

  • Clone the project to your local machine: git clone [email protected]:Shardj/code-genie-cli.git

  • Install Python 3 and pip (Python package installer) if not already installed. On some versions of Linux you'll need pip3 and on others you'll want pipx.

  • Open a terminal (Unix) or command prompt (Windows), cd into the project directory, and run pip install -e ., or of course using pip3 or pipx there instead.

  • This will have installed dependencies and created a script named code-genie-cli in your Python bin/ directory, or scripts/ for Windows.

  • Find the bin/ by running python -m site --user-base. Check to see if the bin/ is in your PATH environment variable. If not add this to your ~/.bashrc or ~/.bash_profile: export PATH="/path/to/your/python/bin:$PATH", and then restart your shell.

Running the software

On Linux or macOS, open a terminal and simply run code-genie-cli.

code-genie-cli's People

Contributors

shardj avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar

code-genie-cli's Issues

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.