https://github.com/astrocvijo/indexer_2
A CLI tool that indexes a given folder and allows efficient searching for string occurrences.
https://github.com/astrocvijo/indexer_2
automation cli indexing kotlin string-search
Last synced: 5 months ago
JSON representation
A CLI tool that indexes a given folder and allows efficient searching for string occurrences.
- Host: GitHub
- URL: https://github.com/astrocvijo/indexer_2
- Owner: AStroCvijo
- Created: 2024-05-04T10:51:46.000Z (about 2 years ago)
- Default Branch: master
- Last Pushed: 2024-08-30T13:35:39.000Z (almost 2 years ago)
- Last Synced: 2025-10-11T15:31:59.678Z (9 months ago)
- Topics: automation, cli, indexing, kotlin, string-search
- Language: Kotlin
- Homepage:
- Size: 367 KB
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# File Indexer - CLI tool
A CLI tool that indexes a given folder and allows efficient searching for string occurrences.
Date of creation: May, 2024
## Instructions
1. Clone the repository `git clone https://github.com/AStroCvijo/Indexer_2`
2. Set up `allowedExtensions.txt` file in the root directory e.g.
```txt
txt
kt
py
```
3. Open the project in IntelliJ IDEA
4. Run the project in IntelliJ IDEA (this will run the app without command line arguments)
5. Copy the command that IntelliJ IDEA used to run the app (you can find it in the bottom window), should look like this `C:........MainKT`
6. Open the terminal and navigate to the repository
7. Paste the command you coppied (`C:........MainKT`)
8. Add command line arguments and run the app
## Arguments guide
`-path or -p` followed by path to the folder you want to index e.g. `.\\Data`
This will index the `.\\Data` folder and save it to `.\\indexedFolders` (the starting location of .\\\ is inside the app folder, so either move to folder you want to index there or navigate to it)
`-force or -f`
This will force the app to index the folder again and save it to `.\\indexedFolders` (if you don't force a re-index, and the folder has already been indexed, the app will just load it)
`-query or -q`
This will indicate that you want to query the folder after indexing
`-case or -c`
This will indicate that you want the search to be case-sensitive
`-highlight or -h`
This will print the line in which the string is located and highlight it
## Examples
| Command | Description |
|-----------------------------------------------|----------------------------------------------------------------------|
| `C:........MainKT -p .\\Data` | Index a Folder Without Re-indexing or Querying |
| `C:........MainKT -p .\\Data -f` | Index a Folder and Force Re-indexing |
| `C:........MainKT -p .\\Data -q` | Index a Folder and Query Without Case Sensitivity |
| `C:........MainKT -p .\\Data -q -h` | Index a Folder, Query Without Case Sensitivity and Highlight |
| `C:........MainKT -p .\\Data -f -q` | Index a Folder, Force Re-indexing, and Query Without Case Sensitivity|
| `C:........MainKT -p .\\Data -q -c` | Index a Folder, Query with Case Sensitivity |
| `C:........MainKT -p .\\Data -f -q -c` | Index a Folder, Force Re-indexing, and Query with Case Sensitivity |
| `C:........MainKT -p .\\Documents -q` | Index a Different Folder and Query Without Case Sensitivity |
| `C:........MainKT -p .\\AnotherFolder -f -q -c`| Index a Folder, Force Re-indexing, and Perform Case-sensitive Search |