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
-v, --version Print the application version and exit.
211
216
```
212
217
213
-
## ⚙️ How It Works
214
-
215
-
It identifies all available partitions for Windows, or volumes in the case of
216
-
macOS and Linux. It'll immediately show the capacity info for all drives,
217
-
including file system type, total capacity, free space, and usage data. All
218
-
drives will be sorted (by default) by the free space left.
219
-
220
-
Press `Enter` to explore a particular drive and check what files or directories
221
-
occupy the most space. Wait while the scan is finished, and the status will
222
-
update in the status bar.
223
-
Now you have the full view of the files and directories, including the space
224
-
usage info by each entry. Use `ctrl+q`
225
-
to immediately see the biggest files on the drive, or `ctrl+e` to
226
-
see the biggest directories. Use `ctrl+f` to filter entries by their names or
227
-
`,` and `.` to show only files or directories.
228
-
229
-
## 🔍 Viewing Changes (Delta Mode)
230
-
231
-
NoxDir can display file system changes since your last session. It highlights added or deleted files and directories, as
232
-
well as changes in disk space usage.
233
-
234
-
To view changes in the current directory, press the `+` key (toggle diff). NoxDir will compare the current state of the
235
-
directory with its cached version and display the difference:
236
-
237
-

238
-
239
-
The diff is calculated by comparing the current directory state against its cached version. If no cache exists from the
240
-
previous session, no differences will be shown.
241
-
242
218
## 🔧 Configuration File
243
219
244
220
On first launch, the application automatically generates a simple configuration file. This file allows you to define
@@ -320,16 +296,16 @@ Cache file locations:
320
296
321
297
To clear all cached data, use the `--clear-cache` flag.
322
298
323
-
## 📟 Commands
324
-
NoxDir provides a set of commands you can run on one or multiple selected entries.
299
+
## 🔍 Viewing Changes (Delta Mode)
325
300
326
-
1. Open the command bar. Press the `:` key inside NoxDir to bring up the command bar.
327
-
2. Explore available commands. Type: `help` to list all currently available commands. For details on a specific command,
328
-
use the `-h` flag. Example: `pack -h`.
329
-
3. Run a command. Select the entries you want, then type a command in the command bar. In the example below, four
330
-
selected items are packed into an archive named `archive` with no compression: `pack -o archive`
331
-
4. Press `esc` to close the command bar.
332
-

301
+
NoxDir can display file system changes since your last session. It highlights added or deleted files and directories, as
302
+
well as changes in disk space usage. The diff is calculated by comparing the current directory state against its cached version. If no cache exists from the
303
+
previous session, no differences will be shown.
304
+
305
+
To view changes in the current directory, press the `+` key (toggle diff). NoxDir will compare the current state of the
306
+
directory with its cached version and display the difference:
307
+
308
+

333
309
334
310
## ⌨️ Key Bindings
335
311
@@ -410,16 +386,6 @@ Example:
410
386
In this example, the status bar border is disabled, and the usage progress bar is rendered using ANSI characters (█, ░)
411
387
instead of emojis (🟥, 🟩).
412
388
413
-
## ⚠️ Known Issues
414
-
415
-
- The scan process on macOS might be slow sometimes. If it is an issue, consider
416
-
using `--exclude` argument.
417
-
418
-
## 🧩 Planned Features
419
-
420
-
-[ ] Real-time filesystem event monitoring and interface updates
421
-
-[ ] Exportable reports in various formats (JSON, CSV, HTML)
422
-
423
389
## 🙋 FAQ
424
390
-**Q:** Can I use this in scripts or headless environments?
425
391
-**A:** Not yet — it's designed for interactive use.
@@ -432,15 +398,12 @@ instead of emojis (🟥, 🟩).
432
398
formatting, and there are no multiple panes like in the screenshots.
433
399
-**A:** Visual presentation depends on terminal capabilities and font
434
400
configuration. For optimal experience, a terminal with Unicode and glyph
435
-
support is recommended. The screenshots were made in `WezTerm` using `MesloLGM Nerd Font` font.
436
-
437
-
## 🧪 Contributing
438
-
439
-
Pull requests are welcome! If you’d like to add features or report bugs, please
440
-
open an issue first to discuss.
441
-
442
-
## 📝 License
401
+
support is recommended. The screenshots were made in `WezTerm` using `MesloLGM Nerd Font` font. If your font does not support glyphs consider using `--siimple-color` flag.
402
+
<br><br>
403
+
-**Q:** The scanning process is too slow.
404
+
-**A:** Consider using caching, exclusion, or running the application only for specific directories. The caching can be enabled with the flag `-c, --use-cache` or in the configuration file. With caching enabled, you choose which directories must be re-scanned with the `r` key. Exclusion flag `-x, --exclude` allows providing a list of directories that must be skipped during scanning, e.g., `.node_modules`. Also, predefined root `-r, --root` will start the application from the specified directory instead of scanning the entire file system.
0 commit comments