Skip to content

Latest commit

 

History

534 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
Z-Shell logo

Z-Shell source delivery

Installer, loader, setup planner, and CDN assets for Zi.

Linux CI macOS CI License

Install Zi

sh -c "$(curl -fsSL https://get.zshell.dev)" --

The default profile installs Zi and adds one short managed entry to the user's Zsh startup file:

# >>> zi setup >>>
source '/absolute/config/zi/setup.zsh'
# <<< zi setup <<<

Important

The generated setup.zsh owns startup sequencing, settings, and diagnostics. Read the installation guide before selecting another profile, branch, or install location.

Published assets

Endpoint Content
get.zshell.dev Standalone installer entrypoint
init.zshell.dev Zi loader
src.zshell.dev Published source assets
checksum.txt SHA-256 checksums for published installer assets

install.sh remains the user-facing entrypoint. It downloads its companion setup assets from the same source revision, verifies their checksums, creates a reviewable plan, and applies the checkout and configuration as separate phases. The loader, annex, and zunit profiles all use that planner. The -i skip profile installs Zi without changing .zshrc.

The source-adjacent Zi Setup TUI contract defines the machine interface and acceptance boundary for a future guided terminal client. The client offers loader and annex; zunit remains compatibility-only for existing installer output. Callers can optionally pass setup.sh apply --events DIR to stream observational zi-setup-event-v1 atomic numbered directories (000001, 000002, ...). Process completion remains authoritative; do not parse stdout or stderr, and clients must account for the cancellation-publication limit where a signal interrupting event publication itself may omit the terminal event while cleanup and exit status 6 remain.

Repository layout

Path Purpose
public/sh/ POSIX shell installers, planner, checksum, and synchronization utilities
public/setup/ Versioned profile data consumed by the planner
public/zsh/ Zsh loader and reusable snippets
public/index.html Landing page deployed with the public assets
tests/installers.sh Cross-platform installer and loader behavior tests

Verify locally

sh tests/installers.sh
sh -n public/sh/*.sh
shellcheck public/sh/*.sh

Regenerate checksums after changing a published asset:

sh public/sh/generate-checksums.sh
git diff --exit-code -- public/checksum.txt

GitHub Actions exercises the installer and loader on Linux and macOS. Merges to main publish public/ through GitHub Pages, and the loader-drift workflow verifies that the deployed loader matches its source and checksum.

Documentation and support

About

✨ Z-Shell source library — snippets, installer scripts and shared utilities

Topics

Resources

Code of conduct

Contributing

Security policy

Stars

10 stars

Watchers

1 watching

Forks

Releases

Used by

Contributors

Languages