- Reorganize documentation: moved old docs to docs/ directory
- Add comprehensive README.md with build options and usage guide
- Add detailed CONTRIBUTING.md with help content management guide
- Create Makefile for automated building and testing
- Add Dockerfile.scratch for building from Ubuntu 20.04 base
- Enhance all Dockerfiles with PowerShell + PSScriptAnalyzer
- Add modern shells: zsh (with plugins) and fish (with config)
- Add modern CLI tools: fd-find, ripgrep, fzf
- Create comprehensive help system with cheat/TLDR/fish completions
- Add helper scripts for help content management and coverage checking
- Fix Dockerfile.remnux script references
- Support three build variants: upstream (REMnux), scratch (Ubuntu), kali
Build options:
- make build-upstream: Fast, uses REMnux upstream (recommended)
- make build-scratch: Full control, builds from Ubuntu 20.04
- make build-kali: Legacy Kali Linux base
Features:
- PowerShell with PSScriptAnalyzer module
- Modern shells (zsh, fish) with custom configurations
- Enhanced help system (cheat sheets, TLDR pages, fish completions)
- Help coverage checking and bulk import tools
- Comprehensive documentation for users and contributors
🎯 Enhanced Features:
- Integrated navi, cheat, tldr, and fzf for interactive help
- Custom cheat sheets for PDF analysis, malware analysis, and system utilities
- find-tool command for fuzzy searching through all REMnux tools
- Comprehensive help command with workflows and examples
- Complete offline documentation system
📚 Help System Components:
- help - Main help system
- help tools [term] - Search for tools (fuzzy matching)
- help cheat <tool> - Show command examples
- help examples - Browse examples interactively (navi + fzf)
- help pdf/malware/forensics - Analysis workflows
- help --offline - Verify offline capabilities
🛠️ Tools Added:
- navi: Interactive cheat sheet browser
- cheat: Command-line cheat sheets
- tldr: Quick command examples
- fzf: Fuzzy finder (already included)
All documentation works completely offline with local REMnux docs database
and custom cheat sheets for analysis workflows.
tobias