DOCSEARCHbyAlgolia
Submit Docs

Z-Shell Wiki

website·Indexed 32 days ago

https://wiki.zshell.dev

Documentation for the Z-Shell ecosystem, featuring guides on the zi plugin manager, Zsh native scripting, and the Zsh Plugin Standard. Includes detailed references for zsh-lint, a standalone semantic analyzer for Zsh, and comprehensive completion configuration guides.

Tokens
68.3K
Snippets
439
Records
546
Agent score
63%

What's inside Z-Shell

  1. Overview of Zi Annexes

    Annexes in Zi allow developers to extend the plugin manager's functionality. They can be used to:

    1. Add new Zi subcommands (commands placed after the zi function call).
    2. Add new ice-modifiers.
    3. Register hooks for specific lifecycle events:
      • atclone: Runs after cloning a plugin or downloading a snippet.
      • atpull: Runs after pulling new commits (updating).
      • atinit: Runs before loading a plugin/snippet, after setup/download.
      • atload: Runs after loading a plugin/snippet.
    4. Register hooks to generate help text for the zi icemods subcommand.

  2. Overview of ZUnit testing framework

    ZUnit is a unit testing framework for Zsh projects maintained by the Z-Shell organization. It provides a concise @test syntax (inspired by Bats), a rich assertion library, per-test @setup and @teardown hooks, TAP output, and HTML reports.

  3. Overview of Zi Zsh Plugin Manager

    Zi is a comprehensive plugin manager for Zsh designed for speed and control. It allows users to manage plugins, packages, completions, and prompts from a single tool without requiring root access or cluttering the $FPATH. A key feature is 'Turbo mode', which can reduce Zsh startup time by 50–80%.

  4. Overview of Zsh Command Architect

    The Command Architect plugin for Zsh provides advanced command-line editing capabilities, allowing users to copy segments of commands from history, rearrange segments of the current command, and delete specific segments of the current command.

  5. Overview of Zi Console

    Zi Console is a console for the Zi plugin manager based on the zsh/zcurses Zshell module. It allows users to view currently loaded plugins in a colorful list (with three display modes), load or unload plugins, and delete plugins or snippets from the disk.

  6. Overview of the ZUI Library

    ZUI is a textual user interface library for Zsh that follows a CGI+DHTML-like pattern. It consists of generators (Zsh code that produces text), an event loop that converts text into active elements (buttons, anchors, toggle buttons, text fields, list boxes), and a mechanism to regenerate specific document parts on the fly without a full reload.

  7. Overview of ZZComplete for Zsh

    ZZComplete is a Zsh plugin that enables users to complete command options by searching manual pages. Instead of remembering the exact option name or scrolling through a full list of options via TAB, users can press <kbd>Ctrl-F</kbd> to search the manual for arbitrary text related to an option and select the option located near the found text. It also allows users to read about and select possible values for options.

  8. Overview of zpmod binary module

    zpmod is a binary Zsh module (requiring Zsh v5.8.1+) that automatically compiles sourced scripts into .zwc files and measures the time taken to source each script. It also provides native builtins for batch path metadata, directory listing, file reading, and record-oriented array input to reduce shell-level filesystem overhead.

  9. Overview of Zsh Navigation Tools (ZNT)

    Zsh Navigation Tools (ZNT) is a set of curses-based selectable list tools for Zsh. It provides features like incremental multi-word searching, approximate matching, ANSI coloring, themes, and unique mode. The tools are based on n-list and integrate directly with the Zsh session.

  10. Overview of ZConvey session integration

    ZConvey allows multiple Zsh sessions to be integrated by assigning each a unique ID and optional NAME. This enables sessions to send commands to each other, such as synchronizing the current working directory across all active shells using zc-all cd $PWD. It also includes a zc-bg-notify script that displays notifications under the prompt of every active Zsh session, which can be called from Zsh, Bash, or GUI applications.

  11. Overview of Zsh Command Architect (ZCA)

    The Zsh Command Architect allows users to copy segments of commands from history, rearrange segments of the current command, and delete segments of the current command. It features advanced history search (multi-word, without duplicate lines) to help users glue commands together from various parts efficiently.

  12. Overview of zsh-select

    zsh-select is a shell command that displays a selection list using the curses library. Unlike fzf, it uses approximate matching instead of fuzzy matching. Key features include multi-term searching via patterns and approximate matching activated by Ctrl-F. While running, pressing 'o' makes elements unique, and pressing '/' allows for searching again after pressing enter.