Skip to content

Latest commit

 

History

History
64 lines (53 loc) · 2.48 KB

README.md

File metadata and controls

64 lines (53 loc) · 2.48 KB
Raw

Shell Mate 🤖

Your Very Own Terminal AI Assistant

Shell Mate Shell Mate

Demo

Getting Started

  • First create an account on OpenAI and create a new token key.

  • Place the token key to your environmental variables or you could optionally put it manually when you run the application.

How To Install

You can download the binary for your specific platform on the release page and run the program on your terminal. Specific instructions below:

Linux

  • Download the zipfile:
curl -O -L https://github.com/AvicennaJr/ShellMate/releases/download/v1.0.0/shellmate_linux_amd64_v1.0.0.tar.gz
  • Extract contents of the zip file and place it on the /usr/local/bin directory
sudo tar -C /usr/local/bin -xzvf shellmate_linux_amd64_v1.0.0.tar.gz
  • Start the program with: shellmate

Windows

  • Download the zip file from the releases page
  • Extract the binary file and run the program with:
shellmate.exe
  • You could optionally add the executable to path. See detailed instructions here

Mac OS

Due to Apple's strict policy, you'll have to build the binary file from sources. See instructions on the next section.

Building From Sources

  • Make sure you have go installed
  • Clone the repository with:
git clone github.com/AvicennaJr/ShellMate
  • Enter the directory:
cd ShellMate
  • Build the program with:
go build -o shellmate
  • Run the created binary with: shellmate

Issues and Contributions

For any problems or suggestions open an issue. If you want to contribute, create a pull request.

Author

Another tool brought to you by Avicenna