Major repository cleanup and enhancement

- 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
2025-10-01 11:45:56 +02:00
parent 6bfcfd7935
commit b98aaee3e0
27 changed files with 5000 additions and 62 deletions
--- a/.cleanup-summary.md
+++ b/.cleanup-summary.md
@@ -0,0 +1,226 @@
+# Repository Cleanup Summary
+
+## Changes Made
+
+### 📁 Repository Organization
+
+1. **Created `docs/` directory** - Moved old documentation files:
+   - `HELP_SYSTEM.md`
+   - `HELP_SYSTEM_ENHANCED.md`
+   - `STREAMLINED_HELP_SYSTEM.md`
+   - `tool-comparison.md`
+   - `remnux-dockerfile-focal.txt`
+
+2. **Updated root directory** - Now contains only active files:
+   - `README.md` - Comprehensive project documentation
+   - `CONTRIBUTING.md` - Detailed contribution guide
+   - `Makefile` - Build automation
+   - Three Dockerfile variants
+   - `WARP.md` - AI assistant context
+
+### 📚 New Documentation
+
+#### README.md
+- Quick start guide
+- Three build options (upstream, scratch, Kali)
+- Comprehensive usage examples
+- Help system documentation
+- Tool coverage overview
+- Repository structure diagram
+- Testing instructions
+- Docker Hub information
+
+#### CONTRIBUTING.md
+- Getting started guide
+- Adding cheat sheets (with examples)
+- Adding TLDR pages (with format guide)
+- Adding Fish shell completions
+- Importing bulk cheatsheets
+- Checking help coverage
+- Adding new tools
+- Testing procedures
+- Quick reference tables
+
+### 🐳 Build System
+
+#### Makefile Targets
+```bash
+make help           # Show available commands
+make build-upstream # Build from REMnux upstream (recommended)
+make build-scratch  # Build from Ubuntu 20.04 base
+make build-kali     # Build from Kali Linux base
+make build-all      # Build all variants
+make test           # Test all builds
+make test-upstream  # Test upstream build
+make test-scratch   # Test scratch build
+make test-kali      # Test Kali build
+make push           # Push to Docker Hub
+make clean          # Remove built images
+make shell-upstream # Interactive shell (upstream)
+make shell-scratch  # Interactive shell (scratch)
+make shell-kali     # Interactive shell (Kali)
+make coverage       # Check help coverage
+```
+
+### 🏗️ Three Build Options
+
+#### 1. Dockerfile.remnux (Upstream - Recommended)
+- Uses `remnux/remnux-distro:latest`
+- Fast build time
+- All REMnux tools included
+- Production-ready
+- **Fixed:** Added missing `add-tool-cheats.sh` script reference
+
+#### 2. Dockerfile.scratch (New - Full Control)
+- Built from `ubuntu:20.04`
+- Complete package control
+- Mimics REMnux installation
+- Customizable base system
+- Includes:
+  - PowerShell + PSScriptAnalyzer
+  - Modern shells (zsh, fish)
+  - Modern tools (fd-find, ripgrep)
+  - PDF analysis suite
+  - Malware analysis tools
+  - Help system integration
+
+#### 3. Dockerfile (Kali - Legacy)
+- Uses `kalilinux/kali-rolling`
+- Original implementation
+- Kali security tools
+- Alternative ecosystem
+
+### 🔧 Enhanced Features
+
+All build variants now include:
+
+1. **PowerShell Integration**
+   - Cross-platform PowerShell (`pwsh`)
+   - PSScriptAnalyzer module pre-installed
+
+2. **Modern Shells**
+   - zsh with plugins (autosuggestions, syntax-highlighting)
+   - fish with custom configuration
+   - Configured prompts and aliases
+
+3. **Modern CLI Tools**
+   - fd-find (fast file finder)
+   - ripgrep (ultra-fast grep)
+   - fzf (fuzzy finder)
+
+4. **Help System**
+   - Cheat sheets for all major tools
+   - TLDR pages for quick reference
+   - Fish completions for smart autocomplete
+   - Coverage checking tool
+
+### 📋 Help Content Management
+
+Users can now:
+
+1. **Add cheat sheets** - Simple text files with examples
+2. **Add TLDR pages** - Standardized help format
+3. **Add fish completions** - Smart command completion
+4. **Import bulk** - Convert markdown to help content
+5. **Check coverage** - Find tools missing documentation
+
+See `CONTRIBUTING.md` for detailed instructions.
+
+## Usage Examples
+
+### Build and Run
+
+```bash
+# Clone and build
+git clone https://github.com/tabledevil/docker_file_analysis.git
+cd docker_file_analysis
+make build-upstream
+
+# Run container
+docker run -it --rm -v "$(pwd):/data" tabledevil/file-analysis:remnux
+
+# Inside container
+fhelp                    # Main help
+fhelp cheat pdfid.py     # Quick examples
+fhelp tools pdf          # Find tools
+zsh                      # Try zsh shell
+fish                     # Try fish shell
+```
+
+### Switching Shells
+
+```bash
+# Default bash
+bash
+
+# Try zsh (advanced features)
+zsh
+
+# Try fish (friendly syntax)
+fish
+```
+
+### Help System
+
+```bash
+fhelp                    # Main menu
+fhelp cheat <tool>       # Quick examples
+fhelp tldr <tool>        # Simplified man pages
+fhelp tools pdf          # Find PDF tools
+fhelp examples           # Browse all examples
+check-help-coverage.sh   # Check documentation coverage
+```
+
+## Next Steps
+
+### For Users
+1. Read `README.md` for overview
+2. Choose a build option
+3. Run `make build-upstream` (recommended)
+4. Try the help system with `fhelp`
+
+### For Contributors
+1. Read `CONTRIBUTING.md`
+2. Add cheat sheets for your favorite tools
+3. Test with `make test`
+4. Submit pull request
+
+## File Structure
+
+```
+docker_file_analysis/
+├── README.md              # Main documentation ✨ NEW
+├── CONTRIBUTING.md        # Contribution guide ✨ NEW
+├── Makefile              # Build automation ✨ NEW
+├── Dockerfile            # Kali variant
+├── Dockerfile.remnux     # REMnux variant (fixed)
+├── Dockerfile.scratch    # Ubuntu variant ✨ NEW
+├── WARP.md              # AI context
+├── files/               # Config files
+│   ├── README
+│   ├── command_help
+│   ├── zshrc
+│   └── fish_config.fish
+├── scripts/             # Helper scripts
+│   ├── fhelp
+│   ├── add-tool-cheats.sh
+│   ├── check-help-coverage.sh
+│   ├── import-remnux-cheatsheets.sh
+│   └── ...
+├── cheatsheets/         # Custom cheat sheets
+├── docs/                # Archived documentation ✨ NEW
+└── tests/               # Test scripts
+```
+
+## Benefits
+
+1. **Cleaner Repository** - Organized structure, clear purpose
+2. **Better Documentation** - Comprehensive guides for users and contributors
+3. **Flexible Building** - Three build options for different needs
+4. **Automated Testing** - Make targets for CI/CD
+5. **Enhanced Features** - Modern shells, PowerShell, better help
+6. **Easy Contributing** - Clear guidelines and examples
+
+---
+
+Repository cleanup completed on 2025-10-01