-
-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
fix: Rename GenCLI to gencli in code files
- Loading branch information
1 parent
ec705ce
commit a0e4c66
Showing
6 changed files
with
49 additions
and
8 deletions.
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 |
---|---|---|
|
@@ -41,7 +41,7 @@ bin | |
|
||
# Build files | ||
|
||
GenCLI | ||
gencli | ||
|
||
# Env files | ||
|
||
|
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 |
---|---|---|
|
@@ -4,7 +4,7 @@ tasks: | |
go mod download | ||
command: | | ||
go build . | ||
./GenCLI | ||
./gencli | ||
github: | ||
|
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,9 +1,50 @@ | ||
# GenCLI | ||
|
||
TDB | ||
<div align="center"> | ||
|
||
## Build With | ||
[![Releases](https://github.com/Pradumnasaraf/gencli/actions/workflows/releases.yml/badge.svg)](https://github.com/Pradumnasaraf/gencli/actions/workflows/releases.yml) [![Go Reference](https://pkg.go.dev/badge/github.com/Pradumnasaraf/gencli.svg)](https://pkg.go.dev/github.com/Pradumnasaraf/gencli) | ||
|
||
- Google Gemini API | ||
</div> | ||
|
||
**GenCLI** is a AI-powered CLI tool that knows answers to all your questions. It is built with [Go](https://github.com/golang/go), [Cobra](https://github.com/spf13/cobra), [Viper](https://github.com/spf13/viper), [Gemini](https://gemini.google.com), etc. | ||
|
||
|
||
## 🚀 Getting Started | ||
|
||
To get started with GenCLI, you can install it using the following methods: | ||
|
||
To install the CLI, use the command below: | ||
|
||
```bash | ||
go install github.com/Pradumnasaraf/gencli@latest | ||
``` | ||
|
||
Go will automatically install it in your `$GOPATH/bin` directory, which should be in your `$PATH`. | ||
|
||
Once installed, you can use the `gencli` CLI command. To confirm installation, type `gencli` at the command line. | ||
|
||
As it uses the Google Gemini API to we need to set the API key. To get the API key (It's FREE), you need to visit [here](https://aistudio.google.com/app/apikey?_gl=1*1n5ijhw*_ga*MTQxNDQ2MjcyNi4xNzE5MDU4OTE0*_ga_P1DBVKWT6V*MTcxOTkzNTQzOC4zLjEuMTcxOTkzNTQ3My4yNS4wLjEzODczMjU2OA) and set it in the environment variable `GENCLI_API_KEY`. | ||
|
||
```bash | ||
export GENCLI_API_KEY=<API_KEY> | ||
``` | ||
|
||
Above method will set the API key for the current session only. To set it permanently, you can add the above line to your `.bashrc` or `.zshrc` file. | ||
|
||
> **Note** If you are getting an error like `command not found: gencli`, then you need to add `$GOPATH/bin` to your `$PATH` environment variable. For that you can refer to [this](https://gist.github.com/Pradumnasaraf/ca6f9a0507089a4c44881446cdda4aa3). | ||
``` | ||
Usage: | ||
gencli [command] | ||
Available Commands: | ||
gencli Type your question here | ||
``` | ||
|
||
## 📜 License | ||
|
||
This project is licensed under the Apache-2.0 license - see the [LICENSE](LICENSE) file for details. | ||
|
||
## 🛡 Security | ||
|
||
If you discover a security vulnerability within this project, please check the [SECURITY](SECURITY.md) for more information. |
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
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,4 +1,4 @@ | ||
module github.com/Pradumnasaraf/GenCLI | ||
module github.com/Pradumnasaraf/gencli | ||
|
||
go 1.22.4 | ||
|
||
|
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