You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
🚀 **TraceView** is a fast and feature-rich TUI (Text-based User Interface) application written in Rust. It enables users to navigate the local filesystem, monitor system resources, search for files and directories, retrieve metadata, and export search results to JSON. The app is configurable via a `config.toml` file and provides a smooth user experience with different themes.
@@ -21,6 +27,8 @@
21
27
22
28
---
23
29
30
+
<br>
31
+
24
32
## 🚀 Getting Started
25
33
### 📦 Installation
26
34
There are three ways to get started with TraceView:
@@ -78,6 +86,8 @@ TraceView is available on [crates.io](https://crates.io/crates/traceview), allow
78
86
```
79
87
---
80
88
89
+
<br>
90
+
81
91
## 🎨 Configuration
82
92
TraceView is configurable via the `config.toml` file located in the Config-Directory. Below is the structure of the default configuration file:
- 🖤 **Dark** – High contrast for low-light environments (default)
@@ -137,6 +149,7 @@ To change the theme you can press `Tab` within the app or if you want to set a d
137
149
138
150
---
139
151
152
+
<br>
140
153
141
154
## App Contexts
142
155
TraceView operates in three primary contexts, each with context-specific controls and keybindings:
@@ -148,14 +161,14 @@ TraceView operates in three primary contexts, each with context-specific control
148
161
* Please use the provided help page by pressing “F1” to view all keyboard shortcuts and their context.
149
162
150
163
## 🧮 Status Bar Features
151
-
---
152
164
The status bar, located at the bottom of the interface, provides:
153
165
- 🗂️ **Current Context**: Shows whether you are in Explorer, Search, or Result context.
154
166
- 🎨 **Active Theme**: Displays the currently applied theme.
155
167
- ⌨️ **Last Keystroke**: Shows the last pressed key.
156
168
- ❗ **Error Messages**: Displays any application errors or warnings.
157
169
---
158
170
171
+
<br>
159
172
160
173
## 🔎 Searching by File or Directory Name
161
174
TraceView provides a powerful search feature that allows users to search specifically for **file and directory names**. The search functionality focuses only on names, making it possible to:
@@ -168,6 +181,11 @@ TraceView offers two search modes:
168
181
-**Flat Search:** 🔎 Searches only within the currently selected directory (non-recursive). Ideal for quick local searches.
169
182
-**Deep Search:** 🌐 Recursively searches through all subdirectories within the selected path. Useful for locating files or directories in nested structures.
170
183
184
+
### 📝 **Search Input History:**
185
+
- The input field for typing search queries maintains a **history of previous searches** during the current session.
186
+
- Navigate through past queries using the **Up (↑)** and **Down (↓)** arrow keys to quickly reuse or modify previous searches.
187
+
- This feature enhances efficiency, especially when refining searches or repeating common queries.
188
+
171
189
✅ **Usage Notes:**
172
190
- Initiate a search by pressing `Ctrl + F` in the Explorer Context.
173
191
- Enter your search query and choose between Flat or Deep mode.
@@ -178,6 +196,7 @@ TraceView offers two search modes:
178
196
-**Flat Search** provides faster results for localized searches.
179
197
---
180
198
199
+
<br>
181
200
182
201
## 🗂️ Capturing File and Directory Metadata
183
202
TraceView allows users to capture metadata for both files and directories with the following considerations:
@@ -196,6 +215,7 @@ TraceView allows users to capture metadata for both files and directories with t
196
215
- If `follow_sym_links` is enabled in the configuration, symbolic links within directories are also traversed, potentially increasing processing time.
197
216
---
198
217
218
+
<br>
199
219
200
220
## ⏳ If Things Take a Long Time
201
221
Some operations in TraceView, such as searching for files/directories or exporting search results, may take longer to complete depending on the size and complexity of the filesystem.
@@ -205,6 +225,7 @@ Some operations in TraceView, such as searching for files/directories or exporti
205
225
- This is especially useful during deep searches or large directory exports that require extensive processing time.
206
226
---
207
227
228
+
<br>
208
229
209
230
## 🚫 Limitations & Future Plans
210
231
While TraceView offers a variety of features for browsing, searching, and viewing metadata, it is important to note that **it is not a full-fledged file explorer**. As such:
@@ -213,12 +234,14 @@ While TraceView offers a variety of features for browsing, searching, and viewin
213
234
- 📄 TraceView is currently designed to provide safe, read-only access to filesystem information without risking unintended file modifications.
214
235
---
215
236
237
+
<br>
216
238
217
239
## 🛡️ License
218
240
This project is licensed under the MIT License.
219
241
220
242
---
221
243
244
+
<br>
222
245
223
246
## 🧰 Built With ❤️ in Rust and these awesome crates
224
247
Thanks to the developers of these crates, without whom `TraceView` would not exist<br>
@@ -227,6 +250,7 @@ Thanks to the developers of these crates, without whom `TraceView` would not exi
TraceView has been tested on the following operating systems and environments with **x86_64** CPU architecture:
@@ -243,6 +267,8 @@ When testing under MacOs, I noticed that the standard terminal does not fully su
243
267
244
268
---
245
269
270
+
<br>
271
+
246
272
## 🛠️ Troubleshooting
247
273
### 🪟 **Windows Terminal Freeze Issue**
248
274
If you experience the app freezing when clicking inside the terminal window with the **left mouse button** on Windows, this is due to the terminal's default behavior of entering "selection mode." In this mode, terminal input is paused while text is being selected. To avoid this issue:
@@ -259,5 +285,25 @@ If an error appears in the status bar:
259
285
260
286
---
261
287
288
+
<br>
289
+
290
+
## 🤝 **Collaboration, Feedback & Bug Reports**
291
+
I welcome feedback, suggestions, and bug reports! Your input helps make TraceView better.
292
+
293
+
### 💬 **How to Contribute:**
294
+
- Report issues or suggestions via [GitHub Issues](https://github.com/javaLux/traceview/issues).
295
+
- Submit pull requests to improve the code or documentation.
296
+
- Share your thoughts to help shape future features.
297
+
298
+
### 🐛 **Found a Bug?**
299
+
- Check if it’s already reported.
300
+
- If new, open an issue with details and reproduction steps.
301
+
- Attach logs (in `data` directory) for faster diagnosis.
302
+
303
+
### 📢 **I Appreciate Your Feedback!**
304
+
Your ideas and input make TraceView more user-friendly. Don’t hesitate to reach out.
0 commit comments