Expand CLI documentation with comprehensive command reference#6
Open
INDI260 wants to merge 1 commit into
Open
Conversation
- 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
azuwis
suggested changes
Feb 16, 2026
azuwis
left a comment
azuwis
left a comment
There was a problem hiding this comment.
Many of the output examples also do not match the current cli version.
|
|
||
| | Option | Description | | ||
| |--------|-------------| | ||
| | `-e`, `--extend` | Show extended information including UIDs, nicknames, and detailed configuration | |
There was a problem hiding this comment.
[USB] chameleon --> hw slot list -h
--------------------------------------------------------------------------------
hw slot list
Get information about slots
usage:
hw slot list [-h] [--short]
options:
-h, --help show this help message and exit
--short Hide slot nicknames and Mifare Classic emulator settings
hw slot list does not have -e option
Author
There was a problem hiding this comment.
Thanks for the feedback, I'll compile the latest version and check every command against it
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
This PR significantly expands the CLI documentation with explanations for all commands.
Changes
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
Additional Notes