bin/ Command Reference¶
Detailed documentation for each command in the bin/ directory. Each command has its own documentation file with comprehensive usage examples, configuration options, and troubleshooting.
Quick Reference¶
| Command | Purpose | Documentation |
|---|---|---|
zr | Framework rebuild | zr.md |
zupdate | System maintenance | zupdate.md |
zmono | Build framework-only monolithic .zwc | See bin/README.md |
zfull | Build full bundle (framework + user) in cache | See bin/README.md |
ze | Quick config editor | ze.md |
zd | Diff-based editor | zd.md |
zr-dir | Directory listing | zr-dir.md |
rclink | Zshrc setup | rclink.md |
auditenv | Environment audit | auditenv.md |
syssnap | System snapshot | syssnap.md |
pcopy | Local file transfer | pcopy.md |
persync | Resilient sync | persync.md |
txmon | Transfer monitor | txmon.md |
aicontext | AI context generator | aicontext.md |
scaffold | Project scaffolding | scaffold.md |
cspellfix | Spell checker manager | cspellfix.md |
envconsolidate | Environment consolidator | envconsolidate.md |
sshot | Screenshot capture | sshot.md |
archshots | Screenshot archiver | archshots.md |
docgen | Documentation generator | docgen.md |
diffenv | Environment diff | diffenv.md |
testinit | Test initialization | testinit.md |
Categories¶
Framework Management¶
Commands for maintaining and updating the ZSHAND framework.
- zr - Framework rebuild and compilation
- zupdate - Complete system maintenance
- zmono - Build framework-only monolithic .zwc (see bin/README.md)
- zfull - Build full bundle (framework + user) in cache (see bin/README.md)
- zr-dir - Directory listing and analysis
Configuration & Editing¶
Tools for editing configuration files with validation and safety.
- ze - Quick configuration editor
- zd - Diff-based configuration editor
- rclink - Zshrc symlink management
Environment & Diagnostics¶
Tools for auditing and managing the shell environment.
- auditenv - Environment variable validation
- syssnap - System state snapshots
- diffenv - Environment comparison
- testinit - Shell initialization testing
File Transfer & Sync¶
High-performance file operations with progress monitoring.
AI & Development Tools¶
Tools for AI-assisted development and project management.
- aicontext - AI context generation
- scaffold - Project scaffolding
- cspellfix - Spell checking management
- envconsolidate - Environment consolidation
System Utilities¶
General-purpose system and productivity tools.
Documentation Structure¶
Each command documentation includes:
- Overview - What the command does and when to use it
- Usage - Command syntax and options
- Examples - Practical usage examples
- Configuration - Configuration files and options
- Dependencies - Required and optional tools
- Troubleshooting - Common issues and solutions
- Integration - How it works with other commands
- Technical Details - Implementation details and performance
Related Documentation¶
- Main bin/ README - Overview and quick reference
- Framework Architecture - How bin commands fit into ZSHAND
- Troubleshooting - Common issues and fixes
- External Tools - Documentation for integrated external tools
Contributing¶
To add documentation for a new command:
- Create a new
.mdfile in this directory - Follow the established structure and formatting
- Add the command to the table above
- Update cross-references as needed
See existing files for examples of the documentation format.