|
4 | 4 |
|
5 | 5 | # fishez |
6 | 6 |
|
7 | | -**A lightning-fast terminal file manager built for developers** |
| 7 | +**A terminal file manager that feels like a command-line superpower.** |
8 | 8 |
|
9 | 9 | [](https://github.com/ioma8/fishez/actions) |
10 | 10 | [](LICENSE) |
11 | 11 | [](https://www.rust-lang.org/) |
12 | 12 |
|
13 | | -Navigate files at the speed of thought. Preview code, search with fd/ripgrep, and open in your editor with one keystroke. |
| 13 | +Jump through projects, preview files, search with `fd`/`ripgrep`, open in your editor, and leave your shell in exactly the directory you found. |
| 14 | + |
| 15 | +**Think `cd` + file manager + quick preview + developer search. Zero config.** |
14 | 16 |
|
15 | 17 | <img src="demo.gif" alt="fishez demo" width="900" /> |
16 | 18 |
|
17 | 19 | </div> |
18 | 20 |
|
19 | | -## 🚀 Quick Start |
| 21 | +## 🚀 Install |
| 22 | + |
| 23 | +### Homebrew, recommended |
20 | 24 |
|
21 | 25 | ```bash |
22 | 26 | brew install ioma8/tap/fishez |
23 | | -curl -sfL https://raw.githubusercontent.com/ioma8/fishez/main/install.sh | sh |
24 | | -cargo install fishez |
25 | 27 | eval "$(fishez --init)" |
26 | 28 | fz ~/projects |
27 | 29 | ``` |
28 | 30 |
|
29 | | -`fz` launches fishez and, when you quit, drops your shell into the directory you were browsing. Use `fishez ~/projects` directly when you want to launch without changing the parent shell directory. |
| 31 | +That is it. `fz` opens fishez, and when you quit, your shell lands in the directory you were browsing. |
30 | 32 |
|
31 | | -The curl installer adds the `fz` wrapper to `.zshrc` / `.bashrc` when possible. Homebrew and Cargo only install the binary; add the `eval "$(fishez --init)"` line yourself for those paths. |
| 33 | +### One-line binary installer |
32 | 34 |
|
33 | | -Press `Ctrl+T` to split into two panes. Press `Esc` to back out of overlays, and from a clean normal state it quits. |
| 35 | +```bash |
| 36 | +curl -sfL https://raw.githubusercontent.com/ioma8/fishez/main/install.sh | sh |
| 37 | +``` |
34 | 38 |
|
35 | | -Add this line to your `~/.zshrc` / `~/.bashrc` if you want `fz` available permanently: |
| 39 | +The installer downloads the latest GitHub release and adds the `fz` wrapper to `.zshrc` / `.bashrc` when it can. |
| 40 | + |
| 41 | +### Build with Cargo |
| 42 | + |
| 43 | +Requires Rust and CMake. |
36 | 44 |
|
37 | 45 | ```bash |
| 46 | +cargo install --git https://github.com/ioma8/fishez |
38 | 47 | eval "$(fishez --init)" |
| 48 | +fz |
39 | 49 | ``` |
40 | 50 |
|
41 | | -## ✨ What is fishez? |
| 51 | +Use `fishez` directly if you want to browse without changing the parent shell directory. |
| 52 | + |
| 53 | +## ✨ Why Developers Share It |
| 54 | + |
| 55 | +- **It replaces slow `cd` guessing.** Open `fz`, move visually, quit in the right directory. |
| 56 | +- **It previews before you open.** Code, text, directories, images, and RAW thumbnails from the terminal. |
| 57 | +- **It ships with developer defaults.** `fd`, `ripgrep`, `$EDITOR`, split panes, batch file ops, no plugin setup. |
| 58 | +- **It is safe by default.** Delete moves to trash, copy/move show progress, conflicts ask before overwrite. |
42 | 59 |
|
43 | 60 | fishez is a keyboard-driven terminal file manager for developers who live in the terminal. No config file, no plugin hunt, no startup ceremony. |
44 | 61 |
|
| 62 | +Press `Ctrl+T` for two panes, `F3` / `Ctrl+P` for quick view, `F4` / `Ctrl+O` for editor, and `F1` for help. |
| 63 | + |
45 | 64 | ## 🎯 Core Features |
46 | 65 |
|
47 | 66 | | Feature | Shortcut | Description | |
|
0 commit comments