-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
218a6e1
commit bbd1f06
Showing
1 changed file
with
38 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,2 +1,39 @@ | ||
# snipgpt | ||
A cli to generate short snippets using openai LLM | ||
|
||
A CLI to generate short snippets using Openai LLM | ||
|
||
### Demo | ||
|
||
![snipgpt demo](https://raw.githubusercontent.com/cristianoliveira/snipgpt/main/snipgpt-demo.png) | ||
|
||
## Getting started | ||
|
||
Clone this repo and install the dependencies. | ||
|
||
```bash | ||
git clone git@github.com:cristianoliveira/snipgpt.git | ||
cd snipgpt | ||
npm i | ||
``` | ||
|
||
Obtain your OpenAI key following these [instructions](https://help.openai.com/en/articles/4936850-where-do-i-find-my-secret-api-key). | ||
|
||
```bash | ||
cp .env.example .env | ||
# edit the file with your key | ||
echo "OPENAI_API_KEY=your-key" > .env | ||
``` | ||
|
||
All good. Now run start it: | ||
|
||
```bash | ||
npm start | ||
``` | ||
|
||
It will open a prompt where you can request for short snippets. It also works | ||
for other stuff, for instance, to ask for examples of how to use a given | ||
command from the coreutils. | ||
|
||
## LICENSE | ||
|
||
I don't care. AKA: MIT. |