flerp 0.1.2

CLI tool that does XYZ
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131

# 🌟 flerp 🌟

**Flerp Text Analysis** - Uncover content & insights from your text files! 🕵️‍♂️

Flerp is a command-line tool written in Rust that provides structural analysis, keyword extraction, and text search functionalities for your documents.

## ✨ Features

- **Structural Analysis**: Get counts of lines, words, and stanzas.
- **Keyword Extraction**: Identify the most frequent keywords in your text.
- **Text Search**: Search for specific queries within your files, with case-sensitive and case-insensitive options.
- **Cool ASCII Art Welcome**: Because why not?

## 🚀 Installation

### easy method
```
cargo install flerp
```

### if you contribute

1.  **Clone the repository (if you haven't already):**
    ```bash
    git clone https://github.com/Huseynteymurzade28/flerp.git
    cd flerp
    ```
2.  **Build and install using Cargo:**
    Ensure you have Rust and Cargo installed. If not, visit [rustup.rs](https://rustup.rs/).
    ```bash
    cargo install --path .
    ```
    This will compile `flerp` and place the executable in your Cargo binary directory (usually `~/.cargo/bin/`). Make sure this directory is in your system's `PATH`.

## 🛠️ Usage

Once installed, you can run `flerp` from your terminal:

```bash
flerp <query> <filename>
```

**Arguments:**

- `<query>`: The text string you want to search for in the file.
- `<filename>`: The path to the text file you want to analyze.

**Options:**

- **Case-sensitive search (default):**
  ```bash
  flerp "Hello" myfile.txt
  ```
- **Case-insensitive search:**
  Set the `CASE_INSENSITIVE` environment variable to any value (e.g., `true` or `1`).
  ```bash
  CASE_INSENSITIVE=true flerp "hello" myfile.txt
  ```
  Alternatively, on Windows:
  ```powershell
  $env:CASE_INSENSITIVE="true"
  flerp "hello" myfile.txt
  ```
  Or for a single command across platforms:
  ```bash
  CASE_INSENSITIVE=1 flerp "hello" myfile.txt
  ```

**Example Output:**

When you run `flerp`, you'll first see a friendly welcome message:

```
  .--.
 /  _ \
|  o o |
 \  ^ /
  `--'
   ||

    _________________________
   /                        //
  /   Flerp Text Analysis  //
 /    Content & Insights  //
/________________________//
(________________________(/
   \                      \
    \   Keywords, Stats,    \
     \   Search Results...  \
      \______________________\

```

Followed by the analysis:

```
Structural Analysis:
  Lines: 150
  Words: 2500
  Stanzas: 30

Keywords (Top 5):
  rust: 25
  code: 18
  analysis: 15
  text: 12
  flerp: 10

This is a line that contains your search query.
Another line matching the query.
...
```

## 🤝 Contributing

Contributions are welcome! If you have ideas for new features, improvements, or bug fixes, please feel free to:

1.  Fork the repository.
2.  Create a new branch (`git checkout -b feature/your-feature-name`).
3.  Make your changes.
4.  Commit your changes (`git commit -am 'Add some feature'`).
5.  Push to the branch (`git push origin feature/your-feature-name`).
6.  Create a new Pull Request.

## 📜 License

This project is licensed under the MIT License - see the `LICENSE` file for details (if you choose to add one).

---

Happy Flerping! 🎉