Skip to main content

🧪 ZUnit

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

ZUnit: write @test blocks, run assertions, see results
Scaffold in seconds

Run zunit init --github-actions to generate a ready-to-use GitHub Actions workflow alongside the project scaffold — CI from day one.

Documentation​

InstallationManual install, build from source, dependencies, and Zi integration.Install →
Test Syntax@test, @setup/@teardown hooks, and helper functions.Learn syntax →
AssertionsAll ~25 assertion functions with examples — equals, contains, match, status.See assertions →
Running TestsCLI usage, flags, TAP output, HTML reports, and filtering.Run tests →
Configuration.zunit.yml key reference — directories, TAP, HTML, time limits.Configure →
CI IntegrationGitHub Actions and Travis CI workflow examples ready to drop in.Set up CI →

Quick start​

# 1. Install
git clone https://github.com/z-shell/zunit.git
cd zunit && ./build.zsh && cp ./zunit /usr/local/bin

# 2. Scaffold a new project
cd my-project
zunit init

# 3. Write a test  (tests/example.zunit)
# #!/usr/bin/env zunit
# @test 'addition works' {
#   assert 2 equals 2
# }

# 4. Run
zunit