https://github.com/henomis/ai-shell-assistant

AI Shell Assistant helps you to executes shell commands
https://github.com/henomis/ai-shell-assistant

ai chatgpt go openai shell

Last synced: about 2 months ago
JSON representation

AI Shell Assistant helps you to executes shell commands

• Host: GitHub
• URL: https://github.com/henomis/ai-shell-assistant
• Owner: henomis
• License: mit
• Created: 2023-04-16T14:16:12.000Z (about 3 years ago)
• Default Branch: main
• Last Pushed: 2023-04-17T14:57:02.000Z (about 3 years ago)
• Last Synced: 2024-12-28T11:15:41.494Z (over 1 year ago)
• Topics: ai, chatgpt, go, openai, shell
• Language: Go
• Homepage: https://simonevellei.com
• Size: 13.7 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# 🤖 ai-shell-assistant

[![Build Status](https://github.com/henomis/ai-shell-assistant/actions/workflows/release.yml/badge.svg)](https://github.com/henomis/ai-shell-assistant/actions/workflows/release.yml) [![GoDoc](https://godoc.org/github.com/henomis/ai-shell-assistant?status.svg)](https://godoc.org/github.com/henomis/ai-shell-assistant) [![Go Report Card](https://goreportcard.com/badge/github.com/henomis/ai-shell-assistant)](https://goreportcard.com/report/github.com/henomis/ai-shell-assistant) [![GitHub release](https://img.shields.io/github/release/henomis/ai-shell-assistant.svg)](https://github.com/henomis/ai-shell-assistant/releases)

This is a simple AI shell helper written in GO. It uses OpenAI API to generate a plausible shell command from a given prompt.

As soon as the command is generated, the user can choose to execute it or revise it adding more context.

![ai-shell-assistant](screen.gif)

## Installation

Be sure to have a working Go environment, then run the following command:

```

$ go install github.com/henomis/ai-shell-assistant@latest

```

### From source code

Clone the repository and build the binary:

```

$ make

```

### Pre-built binaries

Pre-built binaries are available for Linux and macOS on the [releases page](https://github.com/henomis/ai-shell-assistant/releases/latest).

## Usage

⚠️ ai-go-shell requires an OpenAI API key as `OPENAI_API_KEY` environment variable.

```

$ ai-shell-assistant print first 3 lines of each file in a directory

```

### Output

```

    🤖 Here is your command line:

    $ head -n 3 *

    --

    This command uses the `head` utility to print the first 3 lines of each file in the current directory (`*` is a wildcard that matches all files in the directory). The `-n 3` flag specifies that it should print only the first 3 lines.

    [E]xecute, [R]evise, [Q]uit? > 

```