Skip to content

📟 ZSHAND CLI Tools (bin/)

Standalone scripts in bin/ are on your PATH automatically. They handle build (zr, zfull, zrecompile), profiling (zprofile), editing (ze, zd), and utilities (AI context, transfers, audits). Each has a generated doc under Source → api (e.g. source/bin/zr.md).

Build Build System · Performance · Auto-Full
Config Config (your bin/ in config is on PATH too)
Reference Functions · Widgets · Source API
Index Documentation Index

In this doc: Build & compilation · Maintenance · Editing · Profiling · Plugins & theme · Transfer · Utilities


Build & Compilation

These commands manage the compiled bytecode cache that makes startup fast.

Command Purpose When to Use
zr Standard rebuild via zprime After editing any config file
zrebuild Force rebuild with syntax validation When zr produces unexpected results
zrecompile Selective recompile (user/framework/both) When you only changed user config
zfull Build full bundle (framework + user) For maximum startup performance
zmono Build monolithic bundle (framework only) When user config should load separately
zfresh Clean rebuild + shell restart After major config changes or cache corruption
zr-dir Rebuild a single directory Quick recompile of one component
zr-deps Update .zshand-deps manifests After adding cross-directory function calls

Maintenance

Command Purpose When to Use
zupdate Full maintenance (git sync + rebuild + health check) Weekly, or after pulling changes
auditenv Comprehensive environment audit After system updates
docgen Auto-generate PROFILE.md To refresh environment documentation

Editing

Command Purpose When to Use
ze Quick-edit a config by partial name Rapid iteration on configs
zd Edit with diff review before applying Careful edits to complex configs

Profiling

Command Purpose When to Use
zprofile Profile startup timing Diagnosing slow startup
testinit Test initialization in isolation Debugging init sequence

Plugin & Theme Import

Command Purpose
import-ohmyzsh-plugins Import Oh-My-Zsh plugins into ZSHAND
import-p10k-theme Install Powerlevel10k theme presets
import-prezto-themes Import Prezto prompt themes

Cloud Sync

Command Purpose
cloudsync Cloud file sync engine (scan, status, pause/resume, migrate)

See Cloud Sync for full documentation including pin functions, configuration, and troubleshooting.

File Transfer

Command Purpose
pcopy Local file transfer with progress (rsync or tar mode)
persync Persistent resilient sync with auto-retry
txmon Real-time dashboard for active transfers

Utilities

Command Purpose
aicontext Copy project context to clipboard for AI assistants
scaffold Reconstruct project structure from aicontext output
archshots Archive screenshots when threshold reached
cspellfix Spell check tool
diffenv Compare environment variables between sessions
envconsolidate Consolidate environment variable definitions
rclink Manage ~/.zshrc → framework symlink
sshot Cross-environment screenshot capture
syssnap Generate system state snapshots
Document Purpose
🏗️ Build System How compilation and bundles work
Performance Profiling and zprofile
📂 Config Your config bin/ and PATH
🛠️ Functions Shell functions (in-session, not bin scripts)
⌨️ Widgets ZLE widgets (keyboard-driven)
📚 Documentation Index Full doc nav