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
This commit is contained in:
Tobias Kessels
2025-10-01 11:45:56 +02:00
parent 6bfcfd7935
commit b98aaee3e0
27 changed files with 5000 additions and 62 deletions

View File

@@ -68,7 +68,7 @@ search_tools() {
echo -e "${CYAN}🔍 Searching for: ${YELLOW}$search_term${NC}"
echo ""
# Search in tool names, descriptions, categories, and usage hints
# Search in tool names, descriptions, categories, and usage hints (5 fields now)
local matches=$(awk -F'|' -v term="$search_term" '
/^[^#]/ && (tolower($1) ~ tolower(term) || tolower($2) ~ tolower(term) || tolower($3) ~ tolower(term) || tolower($4) ~ tolower(term)) {
print $0
@@ -82,17 +82,17 @@ search_tools() {
fi
local count=0
echo "$matches" | while IFS='|' read -r name description category usage; do
echo "$matches" | while IFS='|' read -r name description category usage available; do
count=$((count + 1))
echo -e "${GREEN}🔧 $name${NC}"
echo -e " ${BLUE}Description:${NC} $description"
echo -e " ${BLUE}Category:${NC} $category"
echo -e " Description: $description"
echo -e " Category: $category"
if [[ -n "$usage" && "$usage" != " " ]]; then
echo -e " ${BLUE}Usage:${NC} $usage"
echo -e " Usage: $usage"
fi
# Check if tool exists on system
if command -v "$name" >/dev/null 2>&1; then
# Use availability status from database instead of checking command
if [[ "$available" == "✓" ]]; then
echo -e " ${GREEN}✓ Available${NC}"
else
echo -e " ${YELLOW}⚠ Check path or alternative name${NC}"