Skip to content

Commit

Permalink
docs: fix
Browse files Browse the repository at this point in the history
  • Loading branch information
henomis committed Apr 7, 2023
1 parent 9fc974d commit 2fe1e03
Showing 1 changed file with 27 additions and 1 deletion.
28 changes: 27 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,28 @@
# ai-shell-go
Ai shell helper written in go
This is a simple AI shell helper written in GO. It use OpenAI API to generate a plausible 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.

## Installation
Be sure to have a working Go environment, then clone the repository and run the following command:

```
$ make
```

## Usage

```
$ ./bin/ai-shell-go 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? >
```

0 comments on commit 2fe1e03

Please sign in to comment.