From e24db9f622c2c9b3445e203861293e394b15fcb5 Mon Sep 17 00:00:00 2001
From: Arcane Engine <bot@arcane.engineer>
Date: Sun, 13 Oct 2024 19:48:01 +0000
Subject: [PATCH] Update .pilot-hints.md to align with README.md content

---
 .pilot-hints.md | 53 +++++++++++++++++++++++++++++++++++++++++--------
 1 file changed, 45 insertions(+), 8 deletions(-)

diff --git a/.pilot-hints.md b/.pilot-hints.md
index 2839da6..1834273 100644
--- a/.pilot-hints.md
+++ b/.pilot-hints.md
@@ -1,8 +1,45 @@
-PR Pilot is a tool that lets developers delegate small tasks to AI in natural language to save time and avoid context switching.
-Every interaction between the user and PR Pilot is a task. Tasks are created using prompts.
-This project:
-- Uses `click` to implement CLI in Python
-- Main entry point is the `pilot` command in `cli/cli.py`
-- Sub-commands implemented in `cli/commands/` directory
-- Uses `poetry` for dependency management
-- Uses `rich` for printing to the console
\ No newline at end of file
+# PR Pilot CLI Overview
+
+PR Pilot is a command-line interface (CLI) tool designed to help developers delegate routine tasks to AI using natural language. It integrates seamlessly with popular development tools and platforms, allowing users to automate and streamline their workflow.
+
+## Key Features
+
+- **Natural Language Processing**: Interact with the CLI using simple, intuitive commands.
+- **Integration with Dev Tools**: Works with tools you already use and trust.
+- **Prompt Templates**: Create and execute prompt-based commands using Jinja templates.
+- **Reusable Commands**: Save and reuse commands for efficiency.
+- **Task Automation**: Automate complex workflows by breaking them into smaller, manageable steps.
+
+## Project Structure
+
+- **CLI Implementation**: Uses `click` to implement the CLI in Python.
+- **Main Entry Point**: The `pilot` command is the main entry point, located in `cli/cli.py`.
+- **Sub-Commands**: Implemented in the `cli/commands/` directory.
+- **Dependency Management**: Utilizes `poetry` for managing dependencies.
+- **Console Output**: Uses `rich` for enhanced console output.
+
+## Installation
+
+To install PR Pilot, ensure it is installed in your repository and then use either `pip` or `Homebrew`:
+
+- **pip**: `pip install --upgrade pr-pilot-cli`
+- **Homebrew**: `brew tap pr-pilot-ai/homebrew-tap` and `brew install pr-pilot-cli`
+
+## Usage
+
+- **Basic Command**: `pilot task "Describe the project!"`
+- **Edit Files**: `pilot edit cli/cli.py "Add docstrings to all functions."`
+- **Generate Code**: `pilot task -o test_utils.py --code "Write unit tests for utils.py."`
+- **Organize Issues**: `pilot task "Categorize open Github issues labeled 'bug'."`
+
+## Configuration
+
+Configuration is managed via `~/.pr-pilot.yaml`, where you can set your API key, default repository, and other preferences.
+
+## Contribution
+
+Contributions are welcome! Feel free to submit pull requests or report issues on the GitHub repository.
+
+## License
+
+PR Pilot CLI is open-source software licensed under the GPL-3 license.
\ No newline at end of file