Refactor Makefile, update README, and modify main.go for improved functionality

Author: NevroHelios

Makefile

@@ -4,4 +4,4 @@ run:
 	go run *.go
 
 build:
-	go build -o gocommit
+	go build -o gocli

README.md

@@ -1,79 +1,142 @@
-📚 README
-================
+# 📚 README
 
-👋 Introduction
----------------
+## 👋 Introduction
 
 This project is a Go-based command-line interface (CLI) that utilizes the Groq API to provide a simple and efficient way to generate descriptive commit messages and chat responses. 🤖
 
-🚀 Project Setup
------------------
+## 🚀 Project Setup
+
+### Prerequisites
+
+1. **Install Go**: Download and install Go from the official website: https://go.dev/dl/ 📦
+
+2. **Install Make**:
+   - **Windows**:
+     ```bash
+     # Using Chocolatey
+     choco install make
+     # or using Scoop
+     scoop install make
+     ```
+   - **macOS**:
+     ```bash
+     # Using Homebrew
+     brew install make
+     ```
+   - **Linux**:
+     ```bash
+     # Debian/Ubuntu
+     sudo apt-get install make
+     # Fedora
+     sudo dnf install make
+     # CentOS/RHEL
+     sudo yum install make
+     ```
+
+3. **Get the Repository**: Clone the repository:
+   ```bash
+   git clone https://github.com/NevroHelios/cliagent.git
+   ```
+
+4. **Install Dependencies**:
+   ```bash
+   go get -u github.com/joho/godotenv
+   go get -u github.com/kelvins/go-uber-zap
+   go get -u github.com/urfave/cli/v2
+   ```
+
+### Building the Project
+
+#### Development Build (using .env)
+1. Create a `.env` file in the project root:
+   ```makefile
+   GROQ_API_KEY=your_api_key_here
+   ```
+2. Build the project:
+   ```bash
+   go build -o gocli
+   ```
+
+#### Production Build (embedded API key)
+Build the project with your API key embedded:
 
-To set up the project, follow these steps:
-
-1. **Install Go**: Make sure you have Go installed on your system. You can download it from the official Go website: https://go.dev/dl/ 📦
-2. **Get the Repository**: Clone the repository using the following command:
 ```bash
-git clone https://github.com/NevroHelios/cliagent.git
+# Linux/macOS
+go build -ldflags "-X main.GROQ_API_KEY=your-api-key-here" -o gocli
+
+# Windows (PowerShell)
+go build -ldflags "-X main.GROQ_API_KEY=your-api-key-here" -o gocli.exe
 ```
-3. **Install Dependencies**: Install the required dependencies using the following command:
+
+Alternatively, use environment variable:
 ```bash
-go get -u github.com/joho/godotenv
-go get -u github.com/kelvins/go-uber-zap
-go get -u github.com/urfave/cli/v2
-```
-4. **Create a `.env` File**: Create a new file named `.env` in the root of the project and add your Groq API key:
-```makefile
-GROQ_API_KEY=your_api_key_here
+# Linux/macOS
+export GROQ_API_KEY=your-api-key-here
+go build -ldflags "-X main.GROQ_API_KEY=$GROQ_API_KEY" -o gocli
+
+# Windows (PowerShell)
+$env:GROQ_API_KEY="your-api-key-here"
+go build -ldflags "-X main.GROQ_API_KEY=$env:GROQ_API_KEY" -o gocli.exe
 ```
-🏃‍♂️ Running the Project
--------------------------
 
-To run the project, follow these steps:
+### Creating a Symlink (Optional)
 
-1. **Navigate to the Project Directory**: Navigate to the project directory using the following command:
-```bash
-cd cliagent
-```
-2. **Build the Project**: Build the project using the following command:
-```bash
-go build -o gocli
-```
-3. **Run the Project**: Run the project using the following command:
-```bash
-./gocli
-```
-4. **Follow the Prompts**: Follow the prompts to select a model, enter a query, and generate a response. 🤔
+To run the CLI from any directory:
+
+- **Windows** (Run PowerShell as Administrator):
+  ```powershell
+  New-Item -ItemType SymbolicLink -Path "C:\Windows\System32\gocli.exe" -Target "$pwd\gocli.exe"
+  ```
+
+- **Linux/macOS**:
+  ```bash
+  sudo ln -s "$(pwd)/gocli" /usr/local/bin/gocli
+  ```
+
+## 🏃‍♂️ Running the Project
+
+1. **Navigate to the Project Directory**:
+   ```bash
+   cd cliagent
+   ```
 
-📝 Generating Commit Messages
------------------------------
+2. **Run the Project**:
+   ```bash
+   ./gocli
+   # If symlinked, simply run from anywhere:
+   gocli
+   ```
 
-To generate a descriptive commit message, follow these steps:
+3. **Follow the Prompts**: Follow the prompts to select a model, enter a query, and generate a response. 🤔
+
+## 📝 Generating Commit Messages
 
 1. **Select the "Commit" Option**: Select the "Commit" option from the main menu.
 2. **Select a Model**: Enter a query to generate a commit message.
 3. **Generate the Commit Message**: The project will generate a descriptive commit message with your selected Model. 📝
 
-🤖 Generating Chat Responses
------------------------------
-
-To generate a chat response, follow these steps:
+## 🤖 Generating Chat Responses
 
 1. **Select the "Chat" Option**: Select the "Chat" option from the main menu.
 2. **Enter a Query**: Enter a query to generate a chat response.
 3. **Generate the Chat Response**: The project will generate a chat response based on your query. 💬
 
-👍 Contributing
------------------
+## 👍 Contributing
 
 If you'd like to contribute to the project, please follow these steps:
 
 1. **Fork the Repository**: Fork the repository using the GitHub fork button.
 2. **Make Changes**: Make changes to the code and commit them using a descriptive commit message.
 3. **Create a Pull Request**: Create a pull request to merge your changes into the main repository. 🚀
 
-🙏 Acknowledgments
-------------------
+## ⚠️ Security Note
+
+When building with an embedded API key:
+- Never commit the build command containing your API key
+- Consider using environment variables for the build process
+- Keep your compiled binary secure as it contains your API key
+
+## 🙏 Acknowledgments
 
 This project utilizes the following libraries and frameworks:
 

gocli.exe

@@ -21,6 +21,7 @@ var (
 	AvailableModels []string
 	ModelsMapped    map[string]interface{}
 	modelOptions    []huh.Option[string]
+	GROQ_API_KEY	string
 )
 
 func loadHuhModelOption(API_KEY string) {
@@ -34,12 +35,16 @@ func loadHuhModelOption(API_KEY string) {
 
 func main() {
 
-	// load the env
-	err := godotenv.Load("/home/shrek/Desktop/projects/gocli/.env")
-	if err != nil {
-		fmt.Println("Error loading .env file", err)
+	// if api not provided during build time
+	if GROQ_API_KEY == "" {
+		// load the env
+		err := godotenv.Load("~/$HOME/Desktop/projects/gocli/.env")
+		if err != nil {
+			fmt.Println("Error loading .env file", err)
+			return
+		}
+		GROQ_API_KEY = os.Getenv("GROQ_API_KEY")
 	}
-	GROQ_API_KEY := os.Getenv("GROQ_API_KEY")
 
 	// check if the user wats to chat or commit
 	var purpose string = "commit"
@@ -51,7 +56,7 @@ func main() {
 		).
 		Value(&purpose)
 
-	err = purForm.Run()
+	err := purForm.Run()
 	if err != nil {
 		fmt.Println(err)
 		return
@@ -133,13 +138,13 @@ func main() {
 		fmt.Println(res)
 
 		// copy to clipboard
-		if purpose == "commit" {
-			clipErr := clipboard.WriteAll(res)
-			if clipErr != nil {
-				fmt.Println("failed to copy ", clipErr)
-				return
-			}
+		// if purpose == "commit" {
+		clipErr := clipboard.WriteAll(res)
+		if clipErr != nil {
+			fmt.Println("failed to copy ", clipErr)
+			return
 		}
+		// }
 	} else {
 		fmt.Println("yare yare! Prompt is empty!!!")
 	}