magdalena

interactive shell navigation and history
Log | Files | Refs | README | LICENSE

README.md (1110B)

      1 # magdalena
      2 +[![builds.sr.ht status](https://builds.sr.ht/~mtmn/magdalena.svg)](https://builds.sr.ht/~mtmn/magdalena?)
      3 
      4 A command-line tool for interactive shell navigation and history.
      5 
      6 ## Features
      7 
      8 - Interactive shell navigation
      9 - Fuzzy finding integration
     10 - Memcached integration
     11 - Grep integration
     12 
     13 ## Dependencies
     14 
     15 - Zig 0.15.2
     16 - ripgrep
     17 - fzf
     18 - bat
     19 - fd
     20 - memcached (optional)
     21 
     22 ## Building
     23 
     24 To build the project, run:
     25 
     26 ```sh
     27 zig build -Doptimize=ReleaseSafe
     28 ```
     29 
     30 ## Usage
     31 
     32 ```
     33 magdalena recent-dirs
     34 magdalena recent-files
     35 magdalena favorites
     36 magdalena goto-dir
     37 magdalena goto-file
     38 magdalena log-dir <path>
     39 magdalena log-file <path> [type] [action]
     40 magdalena search <query>
     41 magdalena look-file [--depth <n>]
     42 magdalena look-dir [--depth <n>]
     43 magdalena grep
     44 ```
     45 
     46 ### Options
     47 
     48 - `-c`, `--clean`: Perform cleanup
     49 - `-h`, `--help`: Show this help
     50 
     51 ### Example
     52 
     53 ```sh
     54 # Run magdalena
     55 ./zig-out/bin/magdalena
     56 
     57 # Show recent directories
     58 ./zig-out/bin/magdalena recent-dirs
     59 
     60 # Search history
     61 ./zig-out/bin/magdalena search "myquery"
     62 
     63 # Explore directory with depth 3
     64 ./zig-out/bin/magdalena look-dir --depth 3
     65 ```