CLI enhancements, Ghidra improvements, and docs overhaul#104
Open
CLI enhancements, Ghidra improvements, and docs overhaul#104
Conversation
apply_changes treated commit()'s 0-success return as failure, regenerate() did not forward disassembler to generate(), and FileExistsError crashed with unhandled traceback. Add --overwrite flag and tests for all code paths.
Promote quokka-cli to primary export method, document quokka-apply CLI, fix deprecated API usage (data_references -> data_refs_from, code_references -> code_refs_to, calls -> callees, string -> strings), correct CMake option name and build instructions, and fix minor typos.
Replace bloated HTML/SVG checkmark table with a clean markdown table comparing IDA and Ghidra export capabilities. Add colored green/red icons via custom CSS.
- Replace get_block() calls with dict-style func[addr] (method doesn't exist) - Replace block.get_instruction() with block[addr] (method doesn't exist) - Fix commit() overwrite default: False -> True to match source - Fix inst.string -> inst.strings (singular form doesn't exist) - Fix AARCH64 -> ARM64 and remove non-existent RISCV enum value - Add missing ExporterMode import in program.md example - Document TypedefType class, is_typedef property, aliased_type, resolve()
- Fix incorrect API references (Chunk->Function, func.calls->func.callees, read_data->read_type_value, inst.parent->inst.block, edge "type"->"condition") - Add missing INVALID FunctionType, IDA-only warnings for commit/regenerate - Fix tutorial claims (prog.strings, chunks terminology, read_bytes semantics) - Use GitHub-compatible admonition syntax in root README
Update DataType to BaseType, read_data to read_type_value, and correct StructureType/UnionType dict key documentation.
Script args must follow the script name on the -postScript line. Also add CLI as preferred headless method, document extension install requirement, and remove hardcoded paths.
…all task Detect QuokkaExporter in both the Ghidra install dir (Gradle) and user settings dir (GUI install). Add `installExtension` Gradle task. Warn on duplicate installs that can cause class-loading conflicts.
Replace DataType.toString() (Ghidra debug format) with proper C declarations: CTypeRenderer for per-type c_str, DataTypeWriter for the full headers field.
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
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
quokka-cli): Accept multiple files/dirs as input, add-o/--outputtemplate option with path specifiers, add--overwriteflag, and resolve relative output paths against the input binary directoryc_strtypes and headers via newCTypeRenderer, add Gradleinstalltask for GUI-installed extensions, generate version frombuild.gradle, rewrite README with install methods and headless arg syntaxrefresh_quokka_lfs.shscript to re-export all LFS.quokkafiles, update IDA SDK to 9.3, installliblzmain warm-cache CI job