helpsheet-cli
v1.2.1
Published
Modular offline terminal help system with Git, NPM, Docker commands and extensible architecture for more developer tools
Maintainers
Readme
Helpsheet CLI
🚀 Your comprehensive modular offline terminal help system - Git, NPM, Docker commands and more!
Vision
Helpsheet is your go-to offline terminal companion with a modular architecture that supports multiple developer tools:
- Git (Available) ✅ - 18 categories, 200+ commands
- NPM (Available) ✅ - 4 categories, 32+ commands
- Docker (Available) ✅ - 6 categories, 48+ commands
- GitHub CLI (Planned) 🚧
- Kubernetes (Planned) 🚧
- And many more developer tools...
Features
- 🎯 Interactive browsing - Navigate through categorized commands
- 📋 Auto-copy to clipboard - Commands are automatically copied when selected
- 🎨 Beautiful terminal UI - Clean, colorful interface with boxed output
- 🔧 Multi-tool support - Git, NPM, Docker commands in one place
- 🔍 Global search - Search across all tools or within specific tools
- ⚠️ Safety first - Dangerous commands clearly marked in "Danger Zone"
- 🔌 Modular architecture - Easy to add new developer tools
- 🧹 Clean interface - Collapsible sections and clear navigation
Installation
npm i -g helpsheet-cliUsage
After installation, run:
helpsheetYou'll see a clean interface with:
- Tool Selection - Choose from Git, NPM, Docker, or search across all
- Category Browsing - Navigate through organized command categories
- Command Selection - Pick commands to copy to clipboard
- Global Search - Find commands across all tools
Available Developer Tools
🐳 Docker (6 Categories)
- Container Management - Run, stop, start containers
- Image Management - Build, pull, tag images
- Networking - Create and manage networks
- Volumes & Data - Handle persistent storage
- System & Info - Monitor and inspect Docker
- Docker Compose - Multi-container applications
📚 Git (18 Categories)
- Init & Clone - Repository initialization and cloning
- Status & Information - Checking repository status and history
- Staging & Commit - Adding files and making commits
- Push & Pull - Synchronizing with remote repositories
- Branching & Merging - Branch operations and merging
- Remote & Config - Remote management and Git configuration
- Stashing - Temporary storage of changes
- Tags - Version tagging operations
- Undoing Changes - Reverting and resetting operations
- Search & Find - Finding commits, files, and content
- Sync & Prune - Repository maintenance and cleanup
- Delete & Cleanup - Removing branches and files
- Submodules - Git submodule management
- GitHub CLI (gh) - GitHub CLI commands
- CI/CD & Automation - Continuous integration helpers
- Advanced Operations - Cherry-picking, patches, worktrees
- Hooks & Automation - Git hooks configuration
- Danger Zone ⚠️ - Potentially destructive operations
📦 NPM (4 Categories)
- Package Management - Install, update, uninstall packages
- Scripts & Execution - Run scripts and commands
- Package Publishing - Publish and manage packages
- Configuration & Info - Settings and package information
Screenshots
_ _ _ _ _
| | | | ___| |_ __ ___| |__ ___ ___| |_
| |_| |/ _ \ | '_ \/ __| '_ \ / _ \/ _ \ __|
| _ | __/ | |_) \__ \ | | | __/ __/ |_
|_| |_|\___|_| .__/|___/_| |_|\___|\___|\__|
|_|
🚀 Your comprehensive offline terminal help system
Navigate through developer tools and find the commands you need
📚 3 Development Knowledge Bases Available:
(Use arrow keys and Enter to navigate)
? What would you like to do?
❯ 🔽 Expand knowledge bases details
🚀 Start exploring tools
❌ ExitRequirements
- Node.js 14.0.0 or higher
- npm or yarn
Contributing
Contributions are welcome! Please feel free to submit a Pull Request.
- Fork the repository
- Create your feature branch (
git checkout -b feature/AmazingFeature) - Commit your changes (
git commit -m 'Add some AmazingFeature') - Push to the branch (
git push origin feature/AmazingFeature) - Open a Pull Request
Roadmap
- [x] Git command cheatsheet (18 categories, 200+ commands)
- [x] NPM command reference (4 categories, 32+ commands)
- [x] Docker commands (6 categories, 48+ commands)
- [x] Modular architecture with auto-discovery
- [x] Global and tool-specific search
- [x] Collapsible interface design
- [ ] GitHub CLI commands
- [ ] Kubernetes commands
- [ ] Custom command categories
- [ ] Plugin system for community contributions
License
This project is licensed under the MIT License - see the LICENSE file for details.
Author
SamY
- GitHub: @Sammy949
- Email: [email protected]
Support
If you find this tool helpful, please consider:
- ⭐ Starring the repository
- 🐛 Reporting bugs or requesting features via issues
- 💡 Contributing to the codebase
- 🚀 Suggesting new command categories to add
Made with ❤️ for developers by developers
Helpsheet - Because sometimes you need help offline! 📚
