Add cd-on-exit: --cwd-file flag, fishez --init, fz shell wrapper in installers

Quit now returns from the event loop instead of process::exit so main can
write the active panel dir. install.sh and make install append
eval "$(fishez --init)" to the shell rc.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>

Author: ioma8

Makefile

@@ -83,9 +83,14 @@ doc-html:
 doc-check:
 	cargo doc --no-deps --document-private-items --quiet
 
-# Install fishez binary
+# Install fishez binary + fz shell function
 install:
 	cargo install --path .
+	@RC="$$HOME/.zshrc"; case "$$SHELL" in */bash) RC="$$HOME/.bashrc";; esac; \
+	if ! grep -q "fishez --init" "$$RC" 2>/dev/null; then \
+		printf '\neval "$$(fishez --init)"  # fz: fishez wrapper that cds to the last viewed dir\n' >> "$$RC"; \
+		echo "Added fz shell function to $$RC (open a new shell to use it)."; \
+	fi
 
 # Uninstall fishez binary
 uninstall:

README.md

@@ -25,6 +25,16 @@ fishez ~/projects
 
 Press `Ctrl+T` to split into two panes. Press `Esc` to back out of overlays, and from a clean normal state it quits.
 
+### cd on exit
+
+Add this line to your `~/.zshrc` / `~/.bashrc` (the [install script](install.sh) and `make install` do it for you):
+
+```bash
+eval "$(fishez --init)"
+```
+
+It defines `fz`, a wrapper that launches fishez and — when you quit — drops your shell in the directory you were browsing. Use `fz` instead of `fishez` and stop typing `cd`.
+
 ## ✨ What is fishez?
 
 fishez is a keyboard-driven terminal file manager for developers who live in the terminal. No config file, no plugin hunt, no startup ceremony.

install.sh

@@ -54,4 +54,22 @@ else
   sudo mv /tmp/fishez /usr/local/bin/$BIN
 fi
 
-echo "✓ fishez installed. Run 'fishez' to start."
+# Install the fz() shell wrapper (cd to last viewed dir on exit)
+case "${SHELL:-}" in
+  */zsh)  RC="$HOME/.zshrc" ;;
+  */bash) RC="$HOME/.bashrc" ;;
+  *)      RC="" ;;
+esac
+
+FZ_LINE='eval "$(fishez --init)"  # fz: fishez wrapper that cds to the last viewed dir'
+if [ -n "$RC" ]; then
+  if ! grep -q "fishez --init" "$RC" 2>/dev/null; then
+    printf '\n%s\n' "$FZ_LINE" >> "$RC"
+    echo "✓ Added fz shell function to $RC (open a new shell to use it)."
+  fi
+else
+  echo "To get the fz function (cd on exit), add this to your shell rc:"
+  echo "  $FZ_LINE"
+fi
+
+echo "✓ fishez installed. Run 'fishez' to start, or 'fz' to cd on exit."

src/main.rs

@@ -22,10 +22,26 @@ use std::path::PathBuf;
 use std::sync::mpsc;
 use tui_input::Input;
 
+/// Shell function installed via `eval "$(fishez --init)"` (bash/zsh).
+const FZ_INIT: &str = r#"fz() {
+  local tmp
+  tmp="$(mktemp)"
+  command fishez --cwd-file "$tmp" "$@"
+  if [ -s "$tmp" ]; then
+    cd "$(cat "$tmp")" || true
+  fi
+  rm -f "$tmp"
+}"#;
+
 fn main() {
     setup_panic_handler();
 
-    let (two_pane, start_path) = parse_args(env::args_os().skip(1));
+    let args = parse_args(env::args_os().skip(1));
+    if args.print_init {
+        println!("{FZ_INIT}");
+        return;
+    }
+    let (two_pane, start_path) = (args.two_pane, args.start_path);
 
     // Initialize infrastructure (adapters)
     let fs = StdFileSystem;
@@ -65,6 +81,8 @@ fn main() {
     let mut favorites_items = load_favorites();
     let mut favorites_selected: usize = 0;
 
+    let cwd_file = args.cwd_file;
+
     // Initial draw and run event loop
     overlays::draw(&mut renderer, &state);
     run(
@@ -92,21 +110,45 @@ fn main() {
         &mut favorites_items,
         &mut favorites_selected,
     );
+
+    if let Some(path) = cwd_file {
+        write_cwd_file(&path, &state.active_panel().current_path);
+    }
+}
+
+struct CliArgs {
+    two_pane: bool,
+    start_path: Option<PathBuf>,
+    cwd_file: Option<PathBuf>,
+    print_init: bool,
 }
 
-fn parse_args(args: impl IntoIterator<Item = OsString>) -> (bool, Option<PathBuf>) {
-    let mut two_pane = false;
-    let mut start_path = None;
+fn parse_args(args: impl IntoIterator<Item = OsString>) -> CliArgs {
+    let mut parsed = CliArgs {
+        two_pane: false,
+        start_path: None,
+        cwd_file: None,
+        print_init: false,
+    };
 
-    for arg in args {
+    let mut args = args.into_iter();
+    while let Some(arg) = args.next() {
         if arg == "--two-pane" || arg == "-2" {
-            two_pane = true;
-        } else if start_path.is_none() {
-            start_path = Some(PathBuf::from(arg));
+            parsed.two_pane = true;
+        } else if arg == "--init" {
+            parsed.print_init = true;
+        } else if arg == "--cwd-file" {
+            parsed.cwd_file = args.next().map(PathBuf::from);
+        } else if parsed.start_path.is_none() {
+            parsed.start_path = Some(PathBuf::from(arg));
         }
     }
 
-    (two_pane, start_path)
+    parsed
+}
+
+fn write_cwd_file(file: &std::path::Path, dir: &std::path::Path) {
+    let _ = std::fs::write(file, dir.display().to_string());
 }
 
 fn setup_panic_handler() {
@@ -131,10 +173,33 @@ mod tests {
 
     #[test]
     fn parses_two_pane_flag_and_start_path() {
-        let (two_pane, path) =
-            parse_args([OsString::from("--two-pane"), OsString::from("/tmp/project")]);
+        let args = parse_args([OsString::from("--two-pane"), OsString::from("/tmp/project")]);
+
+        assert!(args.two_pane);
+        assert_eq!(args.start_path, Some(PathBuf::from("/tmp/project")));
+        assert_eq!(args.cwd_file, None);
+        assert!(!args.print_init);
+    }
+
+    #[test]
+    fn parses_cwd_file_and_init() {
+        let args = parse_args([
+            OsString::from("--cwd-file"),
+            OsString::from("/tmp/out"),
+            OsString::from("--init"),
+        ]);
+
+        assert_eq!(args.cwd_file, Some(PathBuf::from("/tmp/out")));
+        assert!(args.print_init);
+        assert_eq!(args.start_path, None);
+    }
+
+    #[test]
+    fn write_cwd_file_writes_panel_dir() {
+        let file = std::env::temp_dir().join("fishez-cwd-test");
+        super::write_cwd_file(&file, &PathBuf::from("/some/dir"));
 
-        assert!(two_pane);
-        assert_eq!(path, Some(PathBuf::from("/tmp/project")));
+        assert_eq!(std::fs::read_to_string(&file).unwrap(), "/some/dir");
+        let _ = std::fs::remove_file(&file);
     }
 }

src/presentation/event_loop.rs

@@ -18,7 +18,6 @@ use crate::presentation::shortcuts;
 use crate::presentation::terminal::overlays;
 use crossterm::event::{self, Event, KeyCode, KeyEvent};
 use std::path::PathBuf;
-use std::process::exit;
 use std::sync::mpsc::{Receiver, Sender};
 use std::time::{Duration, Instant};
 use tui_input::Input;
@@ -113,7 +112,7 @@ pub fn run(
                         )
                     {
                         renderer.reset_terminal();
-                        exit(0);
+                        return;
                     }
                     route_input(
                         ev,

src/presentation/terminal/renderer.rs

@@ -646,42 +646,40 @@ impl TerminalRenderer {
         );
 
         let max_row = self.rows.saturating_sub(1);
-        let mut draw_column = |s: &mut Self,
-                               sections: &[(&str, &[(&str, &str)])],
-                               x: u16,
-                               key_w: usize| {
-            let mut y = content_start + 2;
-            for (title, entries) in sections {
-                if y >= max_row {
-                    return;
-                }
-                let _ = queue!(
-                    s.stdout,
-                    cursor::MoveTo(x, y),
-                    Print(
-                        (*title)
-                            .with(Color::Cyan)
-                            .attribute(crossterm::style::Attribute::Bold)
-                    )
-                );
-                y += 1;
-                for (key, desc) in entries.iter() {
+        let draw_column =
+            |s: &mut Self, sections: &[(&str, &[(&str, &str)])], x: u16, key_w: usize| {
+                let mut y = content_start + 2;
+                for (title, entries) in sections {
                     if y >= max_row {
                         return;
                     }
-                    let pad = key_w.saturating_sub(key.chars().count());
                     let _ = queue!(
                         s.stdout,
                         cursor::MoveTo(x, y),
-                        Print((*key).with(Color::Yellow)),
-                        Print(" ".repeat(pad + 3)),
-                        Print((*desc).with(Color::Green))
+                        Print(
+                            (*title)
+                                .with(Color::Cyan)
+                                .attribute(crossterm::style::Attribute::Bold)
+                        )
                     );
                     y += 1;
+                    for (key, desc) in entries.iter() {
+                        if y >= max_row {
+                            return;
+                        }
+                        let pad = key_w.saturating_sub(key.chars().count());
+                        let _ = queue!(
+                            s.stdout,
+                            cursor::MoveTo(x, y),
+                            Print((*key).with(Color::Yellow)),
+                            Print(" ".repeat(pad + 3)),
+                            Print((*desc).with(Color::Green))
+                        );
+                        y += 1;
+                    }
+                    y += 1; // blank line between sections
                 }
-                y += 1; // blank line between sections
-            }
-        };
+            };
         if two_col {
             draw_column(self, left, sc as u16, lk);
             draw_column(self, right, (sc + lw + gap) as u16, rk);
@@ -848,7 +846,7 @@ impl TerminalRenderer {
                 columns,
                 rows,
                 stdout: StdoutKind::Test(writer),
-                    logo_png: None,
+                logo_png: None,
                 image_protocol: ImageProtocol::ITerm2,
                 kitty_image_hash: None,
                 loading_frame: 0,
@@ -924,7 +922,9 @@ mod tests {
         let mut state = AppState::new(true);
         state.right_panel.current_path =
             std::path::PathBuf::from("/some/really/long/right/pane/path/beyond/half");
-        state.left_panel.set_notification("Copied 2 files".to_string());
+        state
+            .left_panel
+            .set_notification("Copied 2 files".to_string());
         renderer.draw_two_panes(&state);
         let s = String::from_utf8_lossy(&buffer.borrow()).to_string();
         assert!(