How to install z.lua on Windows?

For Windows cmd with clink, copy z.lua and z.cmd to clink's home directory and add it to PATH. For PowerShell, add the initialization command to profile.ps1, but note conflicts with Starship Prompt require careful ordering.

z.lua vs autojump – which is better?

z.lua is significantly faster (10x per benchmarks) and has broader shell support, including Windows. However, autojump might be simpler for users who prefer Python-based tools or don't need Lua integration. z.lua's enhanced matching offers more intuitive jumps.

How to import data from z.sh or autojump?

For z.sh, cat ~/.z >> ~/.zlua. For autojump, use awk to format the autojump.txt file and append to ~/.zlua. This allows seamless migration without losing history.

Can I use z.lua with fzf for better completion?

Yes, initialize with the 'fzf' option (e.g., eval "$(lua /path/to/z.lua --init bash enhanced once fzf)") to enable fzf-based tab completion in Bash and Zsh. This provides interactive fuzzy selection, but requires fzf installed in PATH.

What is the enhanced matching mode and how do I enable it?

Enhanced matching prioritizes the last path segment for more accurate jumps. Enable it by setting $_ZL_MATCH_MODE=1 or appending 'enhanced' during initialization (e.g., in .bashrc). It falls back to default matching if no match is found.

How to quickly go back to parent directories without typing cd ../../..?

Use the -b option: 'z -b' jumps to the project root, 'z -b foo' goes to the closest parent starting with 'foo'. Alias it to 'zb' for convenience, and it works with interactive modes like -i or -I for selection.

Open-Awesome

z.lua

MITLuav1.8.25

A faster cd command that learns your directory habits using frecency for quick navigation across shells.

GitHub

3.1k stars148 forks0 contributors

What is z.lua?

z.lua is a command-line tool that accelerates filesystem navigation by tracking frequently and recently used directories. It uses a 'frecency' algorithm to predict where you want to go based on your habits, making directory switching much faster than traditional cd commands. It is a faster alternative to z.sh with support for Windows, POSIX shells, and various enhancements.

Target Audience

Command-line users across multiple shells (Bash, Zsh, Fish, PowerShell, Windows cmd) and operating systems who frequently navigate deep directory structures and want to optimize their workflow. It is particularly beneficial for developers, system administrators, and power users who work in terminal environments.

Value Proposition

Developers choose z.lua for its exceptional speed—up to 10x faster than similar tools like fasd and autojump—and its broad cross-shell compatibility. Its unique selling point includes an enhanced matching algorithm for more intuitive jumps, optional native C module for ultimate performance, and self-contained distribution as a single Lua script with no external dependencies.

Overview

:zap: A new cd command that helps you navigate faster by learning your habits.

Use Cases

Best For

Quickly jumping to frequently accessed project directories without typing full paths.
Navigating filesystems on resource-constrained devices like Raspberry Pi where performance is critical.
Users who work across multiple shells (e.g., Bash, Zsh, Fish, PowerShell) and need a consistent navigation tool.
Interactive directory selection with fzf integration for fuzzy matching and visual selection.
Rapidly moving to parent directories without manually typing 'cd ../../..' using backward jumping.
Maintaining a shared directory history across different shell sessions and after re-login.

Not Ideal For

Environments where Lua cannot be installed or is restricted (e.g., locked-down corporate systems)
Users who exclusively use unsupported shells like csh or tcsh, as noted in the 'Help' section
Scenarios with highly ephemeral directory structures where paths are rarely reused, minimizing frecency benefits
Teams seeking a zero-configuration tool that works immediately without shell initialization edits

Pros & Cons

Pros

Blazing Fast Performance

Benchmarks in the README show z.lua is 10x faster than fasd and autojump, with an optional C native module (czmod) reducing update time to 1.6ms for ultimate speed.

Broad Shell Compatibility

It works with Bash, Zsh, Fish, PowerShell, Windows cmd, and POSIX shells, ensuring consistent navigation across diverse environments, as detailed in the installation instructions.

Intelligent Path Matching

The enhanced matching algorithm prioritizes the last path segment for intuitive jumps, and interactive selection with -i or fzf integration allows for fuzzy matching, improving accuracy.

Self-Contained Distribution

Distributed as a single Lua script with no external dependencies, making it portable and easy to deploy, as emphasized in the features list.

Cons

Shell-Specific Configuration

Installation requires editing shell initialization files (e.g., .bashrc, .zshrc) for each shell, which can be complex and error-prone, especially for multi-shell setups.

Lua Dependency Overhead

Requires Lua to be installed; on systems like WSL-1, additional packages like lua-filesystem are needed, adding setup steps and potential compatibility issues.

Incomplete Feature Support

The 'Help' section notes missing features like csh/tcsh support and improved completion for all shells, relying on community contributions for gaps.

Path Management Complexity

Default path validation can slow down operations; users must set $_ZL_NO_CHECK or use --purge to clean invalid paths, introducing manual maintenance.

Open Source Alternative To

z.lua is an open-source alternative to the following products:

autojump

z.sh

z.sh is a shell script that provides directory jumping based on 'frecency' (frequency + recency) for faster navigation.

fasd

A command-line productivity booster that provides quick access to files and directories by tracking frecency (frequency + recency).

Frequently Asked Questions

Related Projects

fzf

:cherry_blossom: A command-line fuzzy finder

Stars81,940

Forks2,820

Last commit18 hours ago

ripgrep

ripgrep recursively searches directories for a regex pattern while respecting your gitignore

Stars66,470

Forks2,658

Last commit12 hours ago

tldr

Collaborative cheatsheets for console commands 📚.

Stars63,195

Forks5,345

Last commit6 hours ago

zoxide

A smarter cd command. Supports all major shells.

Stars38,203

Forks853

Last commit3 days ago

Community-curated · Updated weekly · 100% open source

Found a gem we're missing?

Open-Awesome is built by the community, for the community. Submit a project, suggest an awesome list, or help improve the catalog on GitHub.

Submit a project Star on GitHub