prepping for next release

Author: bgreenwell

CHANGELOG.md

@@ -9,7 +9,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Added
 
--   Git integration to display file statuses with a new `-G, --git-status` flag.
+-   **Shell integration:** In interactive mode, pressing `Ctrl+s` now quits the application and prints the selected path to standard output, allowing `lstr` to be used as a file picker for other shell commands.
+-   **Git integration:** To display file statuses, use the new `-G, --git-status` flag.
     -   Shows status indicators for modified (`M`), new (`A`), untracked (`?`), and more.
     -   Available in both classic `view` and `interactive` modes.
 -   Added an optional `-s, --size` flag to display file sizes in both classic and interactive modes.

README.md

@@ -1,13 +1,13 @@
 # lstr
 
-[![Build Status](https://github.com/bgreenwell/rjot/actions/workflows/rust.yml/badge.svg)](https://github.com/bgreenwell/rjot/actions)
+[![Build Status](https://github.com/bgreenwell/lstr/actions/workflows/rust.yml/badge.svg)](https://github.com/bgreenwell/lstr/actions)
 [![Latest Version](https://img.shields.io/crates/v/lstr.svg)](https://crates.io/crates/lstr)
 [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
 
 A blazingly fast, minimalist directory tree viewer, written in Rust. Inspired by the command line program [tree](https://github.com/Old-Man-Programmer/tree), with a powerful interactive mode.
 
 ![](assets/lstr-demo.gif)
-*An interactive overview of **lstr**'s project structure... using **lstr**.*
+*An interactive overview of `lstr`'s project structure... using `lstr`.*
 ## Philosophy
 
   - **Fast:** Runs directory scans in parallel by default to maximize speed on modern hardware.
@@ -29,7 +29,7 @@ A blazingly fast, minimalist directory tree viewer, written in Rust. Inspired by
 
 ## Installation
 
-You need the Rust toolchain installed on your system to build **lstr**.
+You need the Rust toolchain installed on your system to build `lstr`.
 
 1.  **Clone the repository:**
     ```bash
@@ -62,7 +62,7 @@ Note that `PATH` defaults to the current directory (`.`) if not specified.
 | `-L`, `--level <LEVEL>`| Maximum depth to descend.                                                   |
 | `-p`, `--permissions`  | Display file permissions (Unix-like systems only).                          |
 | `-s`, `--size`         | Display the size of files.                                                  |
-| `--expand-level <LEVEL>`| **Interactive mode only:** Initial depth to expand the interactive tree.      |
+| `--expand-level <LEVEL>`| **Interactive mode only:** Initial depth to expand the interactive tree.   |
 
 -----
 
@@ -78,6 +78,8 @@ Launch the TUI with `lstr interactive [OPTIONS] [PATH]`.
 | `↓` / `j` | Move selection down.                                                                                                                        |
 | `Enter` | **Context-aware action:**\<br/\>- If on a file: Open it in the default editor (`$EDITOR`).\<br/\>- If on a directory: Toggle expand/collapse. |
 | `q` / `Esc` | Quit the application normally.                                                                                                              |
+| `Ctrl`+`s` | **Shell integration:** Quits and prints the selected path to stdout.                                                                          |
+
 
 ## Examples
 
@@ -111,21 +113,21 @@ lstr -aG
 lstr interactive -gG --icons -s -p
 ```
 
-## Piping and Shell Interaction
+## Piping and shell interaction
 
 The classic `view` mode is designed to work well with other command-line tools via pipes (`|`).
 
-### Interactive Fuzzy Finding with **fzf**
+### Interactive fuzzy finding with `fzf`
 
 This is a powerful way to instantly find any file in a large project.
 
 ```bash
 lstr -a -g --icons | fzf
 ```
 
-**fzf** will take the tree from **lstr** and provide an interactive search prompt to filter it.
+`fzf` will take the tree from `lstr` and provide an interactive search prompt to filter it.
 
-### Paging Large Trees with less or bat
+### Paging large trees with `less` or `bat`
 
 If a directory is too large to fit on one screen, pipe the output to a *pager*.
 
@@ -137,9 +139,37 @@ lstr -L 10 | less -R
 lstr --icons | bat
 ```
 
+### Changing directories with `lstr`
+
+You can use `lstr` as a visual `cd` command. Add the following function to your shell's startup file (e.g., `~/.bashrc`, `~/.zshrc`):
+
+```bash
+# A function to visually change directories with lstr
+lcd() {
+    # Run lstr and capture the selected path into a variable.
+    # The TUI will draw on stderr, and the final path will be on stdout.
+    local selected_dir
+    selected_dir="$(lstr interactive -g --icons)"
+
+    # If the user selected a path (and didn't just quit), `cd` into it.
+    # Check if the selection is a directory.
+    if [[ -n "$selected_dir" && -d "$selected_dir" ]]; then
+        cd "$selected_dir"
+    fi
+}
+```
+
+After adding this and starting a new shell session (or running `source ~/.bashrc`), you can simply run:
+
+```bash
+lcd
+```
+
+This will launch the `lstr` interactive UI. Navigate to the directory you want, press `Ctrl+s`, and your shell's current directory will instantly change.
+
 ## Performance and concurrency
 
-By default, **lstr** uses a parallel directory walker to maximize speed on multi-core systems. This parallelism is managed by the excellent [rayon](https://crates.io/crates/rayon) thread pool, which is used internally by **lstr**'s directory traversal engine.
+By default, `lstr` uses a parallel directory walker to maximize speed on multi-core systems. This parallelism is managed by the excellent [rayon](https://crates.io/crates/rayon) thread pool, which is used internally by `lstr`'s directory traversal engine.
 
 For advanced use cases, such as benchmarking or limiting CPU usage, you can control the number of threads by setting the `RAYON_NUM_THREADS` environment variable before running the command.
 
@@ -151,4 +181,4 @@ RAYON_NUM_THREADS=1 lstr .
 
 ## Inspiration
 
-The philosophy and functionality of **lstr** are heavily inspired by the excellent C-based [tree](https://github.com/Old-Man-Programmer/tree) command line program. This project is an attempt to recreate that classic utility in modern, safe Rust.
+The philosophy and functionality of `lstr` are heavily inspired by the excellent C-based [tree](https://github.com/Old-Man-Programmer/tree) command line program. This project is an attempt to recreate that classic utility in modern, safe Rust.

assets/demo.tape

@@ -2,10 +2,12 @@
 
 # 1. Setup the output and terminal properties
 Output "assets/lstr-demo.gif"
-Set Width 1200
-Set Height 600
-Set FontSize 16
-Set TypingSpeed 75ms
+#Set Width 1200
+#Set Height 600
+Set Width 1000
+Set Height 618
+Set FontSize 18
+Set TypingSpeed 65ms
 Set Theme "Catppuccin Frappe"
 
 # 2. Show the classic view with icons
@@ -16,14 +18,14 @@ Sleep 5s
 Ctrl+L
 
 # 3. Show the classic view with size and permissions
-Type "lstr -gps"
+Type "lstr -Ggps --icons"
 Sleep 1s
 Enter
 Sleep 5s
 Ctrl+L
 
 # 4. Show the interactive mode, pre-expanded
-Type "lstr interactive -gs --icons --expand-level 2"
+Type "lstr i -Ggps --icons --expand-level 2"
 Sleep 1s
 Enter
 Sleep 2s
@@ -35,14 +37,10 @@ Enter
 Sleep 2s
 Enter
 Sleep 1s
-Down 5
+Down 6
 Sleep 2s
 Enter
 Sleep 5s
 Type ":x"
 Enter
 Sleep 2s
-
-# 6. Quit the application
-Type "q"
-Sleep 2s