https://github.com/avicennajr/shellmate
Your very own terminal AI assisstant 🤖
https://github.com/avicennajr/shellmate
ai artificial-intelligence artificialintelligence chatgpt go golang openai-api openapi terminal virtual-assistant
Last synced: 10 months ago
JSON representation
Your very own terminal AI assisstant 🤖
- Host: GitHub
- URL: https://github.com/avicennajr/shellmate
- Owner: AvicennaJr
- License: gpl-2.0
- Created: 2023-03-08T17:15:18.000Z (almost 3 years ago)
- Default Branch: master
- Last Pushed: 2023-03-08T18:28:41.000Z (almost 3 years ago)
- Last Synced: 2025-03-28T23:43:31.363Z (10 months ago)
- Topics: ai, artificial-intelligence, artificialintelligence, chatgpt, go, golang, openai-api, openapi, terminal, virtual-assistant
- Language: Go
- Homepage:
- Size: 763 KB
- Stars: 29
- Watchers: 2
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Shell Mate 🤖
Your Very Own Terminal AI Assistant
## Demo
## Getting Started
- First create an account on [OpenAI](https://platform.openai.com/overview) and create a new [token key](https://platform.openai.com/account/api-keys).
- 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:
```bash
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](https://github.com/AvicennaJr/ShellMate/releases/download/v1.0.0/shellmate_windows_amd64_v1.0.0.tar.gz)
- Extract the binary file and run the program with:
```powershell
shellmate.exe
```
- You could optionally add the executable to path. See detailed instructions [here](https://medium.com/@kevinmarkvi/how-to-add-executables-to-your-path-in-windows-5ffa4ce61a53)
### 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](https://go.dev/doc/install)
- Clone the repository with:
```bash
git clone github.com/AvicennaJr/ShellMate
```
- Enter the directory:
```bash
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](https://github.com/AvicennaJr/ShellMate)