explaingit

zdharma-continuum/zsh-sweep

Analysis updated 2026-08-04 · repo last pushed 2023-07-02

2Audience · developerComplexity · 2/5DormantSetup · easy

TLDR

zsh-sweep is a linter for Zshell scripts that scans your Zsh code for bugs and issues, similar to how a spell-checker catches typos. You run it on your files to catch problems before they cause unexpected behavior.

Mindmap

mindmap
  root((repo))
    What it does
      Lints Zsh scripts
      Checks for bugs
      Flags code issues
    How it works
      Run zsweep command
      Auto file type detection
      Scan specific directories
    Use cases
      Lint Zsh plugins
      Check automation scripts
      Verify shell functions
    Audience
      Zsh plugin developers
      CLI tool maintainers
      Shell script writers
    Setup
      Manual install
      Zinit plugin manager

Code map

Detail Auto

An interactive map of this repo's files and how they connect — its source is parsed live in your browser. Click Visualize to build it.

filefunction / class

What do people build with it?

USE CASE 1

Lint a Zsh plugin with multiple function files to catch issues before shipping.

USE CASE 2

Check a command-line tool written in Zsh to find problems early.

USE CASE 3

Scan Zsh automation scripts for bugs and unexpected behavior.

What is it built with?

Zsh

How does it compare?

zdharma-continuum/zsh-sweep0-bingwu-0/live-interpreter010zx00x1/faresnipe
Stars222
LanguagePythonPython
Last pushed2023-07-02
MaintenanceDormant
Setup difficultyeasymoderateeasy
Complexity2/52/52/5
Audiencedevelopergeneralgeneral

Figures from each repo's GitHub metadata at analysis time.

How do you get it running?

Difficulty · easy Time to first run · 5min

No significant setup gotchas, install manually or via Zinit plugin manager.

No license information is provided in the README, so usage rights are unclear.

In plain English

zsh-sweep is a linter for Zshell scripts, a tool that checks your Zsh code for problems, similar to how a spell-checker flags typos. If you write shell scripts, plugins, or functions for Zsh (the terminal shell common on macOS and Linux), this tool scans your files and points out issues that might cause bugs or unexpected behavior. Using it is straightforward: you run the zsweep command on the files you want to verify. Zsh files come in different flavors, command scripts, sourced scripts, and autoload functions, and the tool can check them differently depending on their type. In practice, you can pass the --auto flag and it will figure out the file type on its own. You can also point it at a specific directory with -C if you want to scan files somewhere other than your current location. This would appeal to anyone who writes or maintains Zsh plugins, custom shell functions, or automation scripts. For example, if you're building a Zsh plugin with multiple function files, you could run the tool across all of them to catch issues before shipping. Or if you maintain a command-line tool written in Zsh, you could lint your main script to catch problems early. The README is quite sparse, it covers basic usage and installation but doesn't detail what specific rules or checks the linter enforces, what kind of issues it catches, or how it reports them. There's a screenshot linked but no further explanation of what the output looks like or how to interpret it. Installation supports both manual setup and the Zinit plugin manager, which is a popular way to manage Zsh plugins.

Copy-paste prompts

Prompt 1
I have a Zsh plugin with multiple function files. How do I run zsh-sweep across all of them to find issues before I ship it?
Prompt 2
Help me set up zsh-sweep using Zinit to lint my Zsh scripts automatically.
Prompt 3
I want to lint a Zsh script in a specific directory using zsweep with the --auto flag. Walk me through the command.
Prompt 4
Show me how to install zsh-sweep manually and run it on my Zsh automation scripts to catch bugs.

Frequently asked questions

What is zsh-sweep?

zsh-sweep is a linter for Zshell scripts that scans your Zsh code for bugs and issues, similar to how a spell-checker catches typos. You run it on your files to catch problems before they cause unexpected behavior.

Is zsh-sweep actively maintained?

Dormant — no commits in 2+ years (last push 2023-07-02).

What license does zsh-sweep use?

No license information is provided in the README, so usage rights are unclear.

How hard is zsh-sweep to set up?

Setup difficulty is rated easy, with roughly 5min to a first successful run.

Who is zsh-sweep for?

Mainly developer.

Open on GitHub → Explain another repo

This repo across BitVibe Labs

Verify against the repo before relying on details.