Skip to content

Commit a58baaa

Browse files
committed
Clarify README install flow
1 parent f82c95f commit a58baaa

1 file changed

Lines changed: 29 additions & 10 deletions

File tree

README.md

Lines changed: 29 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -4,44 +4,63 @@
44

55
# fishez
66

7-
**A lightning-fast terminal file manager built for developers**
7+
**A terminal file manager that feels like a command-line superpower.**
88

99
[![CI](https://github.com/ioma8/fishez/actions/workflows/ci.yml/badge.svg)](https://github.com/ioma8/fishez/actions)
1010
[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](LICENSE)
1111
[![Rust](https://img.shields.io/badge/rust-2024-orange.svg)](https://www.rust-lang.org/)
1212

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.**
1416

1517
<img src="demo.gif" alt="fishez demo" width="900" />
1618

1719
</div>
1820

19-
## 🚀 Quick Start
21+
## 🚀 Install
22+
23+
### Homebrew, recommended
2024

2125
```bash
2226
brew install ioma8/tap/fishez
23-
curl -sfL https://raw.githubusercontent.com/ioma8/fishez/main/install.sh | sh
24-
cargo install fishez
2527
eval "$(fishez --init)"
2628
fz ~/projects
2729
```
2830

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.
3032

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
3234

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+
```
3438

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.
3644

3745
```bash
46+
cargo install --git https://github.com/ioma8/fishez
3847
eval "$(fishez --init)"
48+
fz
3949
```
4050

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.
4259

4360
fishez is a keyboard-driven terminal file manager for developers who live in the terminal. No config file, no plugin hunt, no startup ceremony.
4461

62+
Press `Ctrl+T` for two panes, `F3` / `Ctrl+P` for quick view, `F4` / `Ctrl+O` for editor, and `F1` for help.
63+
4564
## 🎯 Core Features
4665

4766
| Feature | Shortcut | Description |

0 commit comments

Comments
 (0)