fge-cli/README.md

A CLI tool to initialize new projects with Gemini and PRD markdown files.

# **fge-cli**

A command-line tool to quickly create project folders, automatically initializing GEMINI.md (for AI collaboration notes) and PRD.md (Product Requirements Document). 🚀 **Go from idea to actionable tasks faster** with AI-driven project setup and task generation.

---

## **⭐ Features**

* **One-Command Project Init**: Rapidly create project folders with a specified name.  
* **Automatic Git Repo Initialization**: Your new project gets git init automatically.  
* **GEMINI.md File Generation**: Includes a starter template for collaboration with Gemini or other AI assistants.  
* **PRD.md File Generation**: Creates an empty PRD document for you to quickly start writing.  
* **AI-Powered TASK.md Generation (NEW\!)**: Automatically generate a structured TASK.md file with uncompleted tasks from your PRD.md using the Gemini API. This is perfect for immediate task breakdown and tracking.

---

## **📦 Global Installation**

First, ensure you have **Node.js** and **npm** installed. Then, you can install fge-cli globally via npm:

Bash

npm install \-g fge-cli

---

## **🚀 Quick Start: Kickstart Your Project with AI**

### **1\. Initialize Your Project (ge command)**

Simply run the ge command in your terminal, providing the name for your desired project folder:

Bash

ge my-new-project

This will:

1. Create a folder named my-new-project in your current directory.  
2. Initialize a Git repository (.git folder) inside it.  
3. Create a GEMINI.md file, complete with a template for AI collaboration.  
4. Create an empty PRD.md file, ready for your product requirements.

### **2\. Generate Tasks from PRD (gt command \- NEW\!)**

After you've defined your project's requirements in PRD.md, you can use the new gt command to instantly generate a detailed TASK.md file.

**Prerequisites for gt:**

* **Set your GEMINI\_API\_KEY**: The gt command requires your Gemini API key to be set as an environment variable. Obtain your key from [Google AI Studio](https://aistudio.google.com/app/apikey).  
  * **For Zsh users (add to \~/.zshrc):**  
    Bash  
    echo 'export GEMINI\_API\_KEY="YOUR\_ACTUAL\_GEMINI\_API\_KEY"' \>\> \~/.zshrc  
    source \~/.zshrc

  * **For Bash users (add to \~/.bashrc):**  
    Bash  
    echo 'export GEMINI\_API\_KEY="YOUR\_ACTUAL\_GEMINI\_API\_KEY"' \>\> \~/.bashrc  
    source \~/.bashrc

  * **Remember to replace "YOUR\_ACTUAL\_GEMINI\_API\_KEY" with your real key\!**

**Usage:**

1. **Navigate into your project folder** (the one containing PRD.md):  
   Bash  
   cd my-new-project

2. **Fill in your PRD.md** with your project's requirements, user stories, and features.  
3. **Run the gt command:**  
   Bash  
   gt

This will analyze your PRD.md and generate a TASK.md file in the same directory, structured with tasks that look like this:

Markdown

\# Project Tasks

\#\# User Stories  
\* \[ \] As a user, I can register for an account.  
\* \[ \] As a user, I can log in with my credentials.

\#\# Features  
\* \[ \] Implement user authentication system.  
\* \[ \] Develop a user profile management page.

\#\# Technical Tasks  
\* \[ \] Set up database schema for users.  
\* \[ \] Configure API endpoints for user operations.

---

## **🤖 Integrating with Gemini / AI Assistants**

fge-cli's core philosophy is to facilitate seamless collaboration with AI assistants.

* The GEMINI.md file is specifically designed for you to set context, prompts, and notes for your AI interactions. Use it to:  
  * Document your AI prompts and responses.  
  * Store key AI-generated insights or code snippets.  
  * Maintain a clear history of your AI collaboration.  
* The new gt command directly leverages the **Gemini API** to transform your high-level product requirements into actionable development tasks, instantly providing a structured starting point for your team or personal workflow.

By starting your projects with fge and integrating tools like Gemini, you can significantly accelerate your journey from idea to execution\!

---

## **🤝 Contributing**

Contributions are welcome\! If you have any suggestions for improvements or bug reports, please feel free to submit a Pull Request or open an Issue.

---

## **📄 License**

This project is licensed under the [ISC License](https://opensource.org/licenses/ISC).

---