Skip to content

Expand CLI documentation with comprehensive command reference#6

Open
INDI260 wants to merge 1 commit intoRfidResearchGroup:mainfrom
INDI260:improve-cli-documentation
Open

Expand CLI documentation with comprehensive command reference#6
INDI260 wants to merge 1 commit intoRfidResearchGroup:mainfrom
INDI260:improve-cli-documentation

Conversation

@INDI260
Copy link

@INDI260 INDI260 commented Feb 2, 2026

Summary

This PR significantly expands the CLI documentation with explanations for all commands.

Changes

  • Added command hierarchy overview showing all ~65 CLI commands in a tree structure
  • Documented every command with detailed explanations, parameters, and usage examples
  • Added reference tables for:
    • Tag types and memory sizes
    • Button functions
    • SAK byte interpretation
    • MIFARE memory structure
    • MIFARE Ultralight page layouts
    • LF card formats (EM410x, HID Prox, Viking)
  • Expanded workflow sections with step-by-step guides for:
    • Complete MIFARE Classic attack and dump
    • Reader sniffing (MFKEY32)
    • Card cloning (to emulator and magic cards)
    • Dual-frequency badge cloning
  • Enhanced troubleshooting with platform-specific solutions

Motivation

The existing documentation was brief and didn't cover many commands. This expansion provides comprehensive guidance for both beginners and advanced users. Would have been useful for me when learning so I think it could be useful for anyone in my situation.

Testing

  • All commands documented are verified against the actual CLI
  • Workflows tested with MIFARE Classic 1K cards
  • Examples include actual output snippets

Additional Notes

  • Maintained consistent formatting and style throughout
  • All code blocks use proper syntax highlighting
  • Tables are properly formatted for GitHub markdown

- Added comprehensive overview with command hierarchy tree
- Documented all ~65 CLI commands with detailed explanations
- Added parameter tables, usage examples, and tips for each command
- Expanded HF/LF commands with protocol-specific details
- Added complete workflows for MIFARE Classic attacks, reader sniffing, cloning
- Enhanced troubleshooting section with platform-specific solutions
- Added tables for tag types, button functions, SAK values, memory structures
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant