<div align="center">

# gaidme <img src="./docs/public/icon.png" alt="gaidme Logo" width="40" height="40" style="vertical-align: middle; margin-left: 10px;">

## CLI Tool Powered by AI

gaidme is an AI-powered CLI tool that helps you use the terminal more easily. It suggests commands and remembers what you've done before, while keeping your information private 🚀

## Quick Links

[Website](https://gaidme.app) | [Documentation](https://docs.gaidme.app) | [Pricing](https://gaidme.app/#pricing)

## Demo
<p align="center">
  <img src="./docs/public/gaidme_demo_1.gif" alt="gaidme Demo" width="100%">
</p>
</div>


## Features

- **Generate Commands** 💡
  
  Describe what you want to achieve, and gaidme will suggest the appropriate terminal commands. Execute commands with a single click or copy them to your clipboard for future use.

- **History Support** 🔍

  gaidme remembers your previously used commands and their results, allowing for context-aware suggestions based on your command history.

- **Regular Commands** 💻

  Continue using your terminal as usual. gaidme enhances your experience by providing suggestions only when you request them, without interfering with your standard workflow.

- **Privacy First** 🔒

  Your data is secure. gaidme does not store your commands, results, or any other data unless you explicitly opt in.

## Installation

### Prerequisites

- **Python 3.8 or higher** 🐍
  Ensure you have Python 3.8+ installed on your machine.

### Installation Steps

1. **Install with pip** 📦
   
   ```bash
   pip install gaidme
   ```

### Set up your API key 🔑
Follow the documentation [here](https://docs.gaidme.app/installation) to set up your API key.

## Usage

After installation, you can start generating commands:

1. **Run gaidme**
   ```bash
   gaidme
   ```

2. **/ask about command**
   ```bash
   /ask show me running containers
   ```
   *gaidme will suggest:*
   ```bash
   docker ps
   ```

## Support

If you have any questions or need assistance, please contact us at [hi@gaidme.app](mailto:hi@gaidme.app).

## License
All rights reserved