Raqule 🦝

A smart code gatherer for LLMs & AI

---

Raqule is a lightweight CLI tool designed for AI models (ChatGPT, Claude, Gemini, etc.) to bundle your entire project's context and code architecture into a single, clean file.

---

Table of Contents

• Features
• Built With
• Installation
• Building from Source (Developers)
• Available Flags
• Project Structure
• License
• Author

---

🚀 Features

• Visual Project Tree: Generates a structured directory tree so LLMs instantly understand your architecture.

• Smart File Gathering: Appends all relevant source code files sequentially with code block formatting.

• Fast & Lightweight: Built with pure Node.js asynchronous APIs for maximum speed.

• Interactive & CLI Ready: Use interactive prompts or fast flags for quick execution.

---

🛠️ Built With

• Commander - CLI flag parsing

• Inquirer - Interactive command-line prompts

• Node.js Native Modules (fs, path)

---

📦 Installation

Since Raqule is built as a single executable binary, you don't even need Node.js installed to run it! Just download the appropriate binary for your OS, add it to your PATH, and you're good to go.

---

1. Download the Executable

Head over to the Releases page and download the latest release for your platform:

(Optional) You can verify the integrity of your downloaded binary using the provided SHA256SUMS file.

---

2. Setup & Add to PATH

To run Raqule seamlessly from any terminal directory using the shortcut command rql (recommended) or raqule, follow the steps for your Operating System below:

🐧 Linux Setup

1. **Make it executable & rename to `rql`:** ```bash # Make the file executable chmod +x Raqule-*-linux-* # Rename it for easier use mv Raqule-*-linux-* rql ``` 2. **Move to system PATH (Recommended):** ```bash sudo mv rql /usr/local/bin/ ``` Now you can run `rql` anywhere! 🎯

🍎 macOS Setup

1. **Make it executable & rename to `rql`:** ```bash # Make the file executable chmod +x Raqule-*-macos-arm64 # Rename it for easier use mv Raqule-*-macos-arm64 rql ``` 2. **Move to system PATH (Recommended):** ```bash sudo mv rql /usr/local/bin/ ``` 3. **Allow Gatekeeper (If Prompted):** If macOS blocks the binary on first execution, run: ```bash xattr -d com.apple.quarantine /usr/local/bin/rql ``` Now you can run `rql` anywhere! 🎯

🪟 Windows Setup

1. **Rename the File:** Rename `Raqule-vX.Y.Z-win-x64.exe` (or `win-arm64`) to `rql.exe`. 2. **Move to a Safe Folder:** Create a dedicated folder, for example: `C:\Program Files\Raqule\`, and place `rql.exe` inside it. 3. **Add to System PATH:** - Press `Win + R`, type `sysdm.cpl`, and hit Enter. - Go to the **Advanced** tab -> click **Environment Variables**. - Under **User variables** (or System variables), find **Path** and click **Edit**. - Click **New** and add the directory path (e.g., `C:\Program Files\Raqule\`). - Click **OK** on all windows. 4. **Restart Terminal:** Open a new PowerShell or Command Prompt window. Now you can run `rql` anywhere! 🎯

---

3. Verification

Test your setup in any new terminal window:

rql --version

---

🛠️ Building from Source (Developers)

If you prefer installing from source code using Node.js & NPM:

# Clone repository
git clone [https://github.com/OmarPGH/Raqule.git](https://github.com/OmarPGH/Raqule.git)
cd Raqule
# Install dependencies
npm ci
# Link globally to your local environment
npm link

---

🚩 Available Flags

Examples:

# Gather code with a max depth of 2 levels
rql -d 2
# Include all ignored files/folders
rql -a
# Generate project tree structure only
rql -t

---

📂 Project Structure

Generated by Raqule:

Raqule
├── .git/
├── .github/
│   └── workflows/
│       ├── release.yml
│       └── semgrep.yml
├── .gitignore
├── LICENSE
├── README.md
├── bin/
│   └── cli.js
├── node_modules/
├── package-lock.json
├── package.json
├── src/
│   ├── flags.js
│   ├── format.js
│   ├── gather.js
│   ├── ignoreList.js
│   ├── index.js
│   ├── packageInfo.js
│   ├── prompts.js
│   ├── specialFiles.js
│   ├── tree.js
│   └── write.js
└── testProject/
    ├── README.md
    ├── main.mjs
    └── modules/
        ├── moduleOne.js
        └── moduleTwo.js

---

⚖️ License

This project is licensed under the Apache-2.0. See the LICENSE file for details.

---

👨‍💻 Author

Omar Gamal - Creator and Maintainer