Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

https://github.com/skylot/jadx

Dex to Java decompiler
https://github.com/skylot/jadx

android decompiler dex java

Last synced: 3 months ago
JSON representation

Dex to Java decompiler

Lists

README 

        



## JADX



[![Build status](https://github.com/skylot/jadx/workflows/Build/badge.svg)](https://github.com/skylot/jadx/actions?query=workflow%3ABuild)

![GitHub contributors](https://img.shields.io/github/contributors/skylot/jadx)

![GitHub all releases](https://img.shields.io/github/downloads/skylot/jadx/total)

![GitHub release (latest by SemVer)](https://img.shields.io/github/downloads/skylot/jadx/latest/total)

![Latest release](https://img.shields.io/github/release/skylot/jadx.svg)

[![Maven Central](https://img.shields.io/maven-central/v/io.github.skylot/jadx-core)](https://search.maven.org/search?q=g:io.github.skylot%20AND%20jadx)

[![License](http://img.shields.io/:license-apache-blue.svg)](http://www.apache.org/licenses/LICENSE-2.0.html)



**jadx** - Dex to Java decompiler



Command line and GUI tools for producing Java source code from Android Dex and Apk files



:exclamation::exclamation::exclamation: Please note that in most cases **jadx** can't decompile all 100% of the code, so errors will occur. Check [Troubleshooting guide](https://github.com/skylot/jadx/wiki/Troubleshooting-Q&A#decompilation-issues) for workarounds



**Main features:**

- decompile Dalvik bytecode to java classes from APK, dex, aar, aab and zip files

- decode `AndroidManifest.xml` and other resources from `resources.arsc`

- deobfuscator included



**jadx-gui features:**

- view decompiled code with highlighted syntax

- jump to declaration

- find usage

- full text search

- smali debugger, check [wiki page](https://github.com/skylot/jadx/wiki/Smali-debugger) for setup and usage



Jadx-gui key bindings can be found [here](https://github.com/skylot/jadx/wiki/JADX-GUI-Key-bindings)



See these features in action here: [jadx-gui features overview](https://github.com/skylot/jadx/wiki/jadx-gui-features-overview)






### Download

- release

  from [github: ![Latest release](https://img.shields.io/github/release/skylot/jadx.svg)](https://github.com/skylot/jadx/releases/latest)

- latest [unstable build ![GitHub commits since tagged version (branch)](https://img.shields.io/github/commits-since/skylot/jadx/latest/master)](https://nightly.link/skylot/jadx/workflows/build-artifacts/master)



After download unpack zip file go to `bin` directory and run:

- `jadx` - command line version

- `jadx-gui` - UI version



On Windows run `.bat` files with double-click\

**Note:** ensure you have installed Java 11 or later 64-bit version.

For Windows, you can download it from [oracle.com](https://www.oracle.com/java/technologies/downloads/#jdk17-windows) (select x64 Installer).



### Install

1. Arch linux ![Arch Linux package](https://img.shields.io/archlinux/v/extra/any/jadx?label=)

    ```bash

    sudo pacman -S jadx

    ```

2. macOS ![homebrew version](https://img.shields.io/homebrew/v/jadx?label=)

    ```bash

    brew install jadx

    ```

3. [Flathub ![Flathub](https://img.shields.io/flathub/v/com.github.skylot.jadx?label=)](https://flathub.org/apps/details/com.github.skylot.jadx)

   ```bash

   flatpak install flathub com.github.skylot.jadx

   ```



### Use jadx as a library

You can use jadx in your java projects, check details on [wiki page](https://github.com/skylot/jadx/wiki/Use-jadx-as-a-library)



### Build from source

JDK 11 or higher must be installed:

```

git clone https://github.com/skylot/jadx.git

cd jadx

./gradlew dist

```



(on Windows, use `gradlew.bat` instead of `./gradlew`)



Scripts for run jadx will be placed in `build/jadx/bin`

and also packed to `build/jadx-.zip`



### Usage

```

jadx[-gui] [command] [options]  (.apk, .dex, .jar, .class, .smali, .zip, .aar, .arsc, .aab, .xapk)

commands (use ' --help' for command options):

  plugins	  - manage jadx plugins



options:

  -d, --output-dir                    - output directory

  -ds, --output-dir-src               - output directory for sources

  -dr, --output-dir-res               - output directory for resources

  -r, --no-res                        - do not decode resources

  -s, --no-src                        - do not decompile source code

  --single-class                      - decompile a single class, full name, raw or alias

  --single-class-output               - file or dir for write if decompile a single class

  --output-format                     - can be 'java' or 'json', default: java

  -e, --export-gradle                 - save as android gradle project

  -j, --threads-count                 - processing threads count, default: 4

  -m, --decompilation-mode            - code output mode:

                                         'auto' - trying best options (default)

                                         'restructure' - restore code structure (normal java code)

                                         'simple' - simplified instructions (linear, with goto's)

                                         'fallback' - raw instructions without modifications

  --show-bad-code                     - show inconsistent code (incorrectly decompiled)

  --no-imports                        - disable use of imports, always write entire package name

  --no-debug-info                     - disable debug info parsing and processing

  --add-debug-lines                   - add comments with debug line numbers if available

  --no-inline-anonymous               - disable anonymous classes inline

  --no-inline-methods                 - disable methods inline

  --no-move-inner-classes             - disable move inner classes into parent

  --no-inline-kotlin-lambda           - disable inline for Kotlin lambdas

  --no-finally                        - don't extract finally block

  --no-replace-consts                 - don't replace constant value with matching constant field

  --escape-unicode                    - escape non latin characters in strings (with \u)

  --respect-bytecode-access-modifiers - don't change original access modifiers

  --mappings-path                     - deobfuscation mappings file or directory. Allowed formats: Tiny and Tiny v2 (both '.tiny'), Enigma (.mapping) or Enigma directory

  --mappings-mode                     - set mode for handling the deobfuscation mapping file:

                                         'read' - just read, user can always save manually (default)

                                         'read-and-autosave-every-change' - read and autosave after every change

                                         'read-and-autosave-before-closing' - read and autosave before exiting the app or closing the project

                                         'ignore' - don't read or save (can be used to skip loading mapping files referenced in the project file)

  --deobf                             - activate deobfuscation

  --deobf-min                         - min length of name, renamed if shorter, default: 3

  --deobf-max                         - max length of name, renamed if longer, default: 64

  --deobf-whitelist                   - space separated list of classes (full name) and packages (ends with '.*') to exclude from deobfuscation, default: android.support.v4.* android.support.v7.* android.support.v4.os.* android.support.annotation.Px androidx.core.os.* androidx.annotation.Px

  --deobf-cfg-file                    - deobfuscation mappings file used for JADX auto-generated names (in the JOBF file format), default: same dir and name as input file with '.jobf' extension

  --deobf-cfg-file-mode               - set mode for handling the JADX auto-generated names' deobfuscation map file:

                                         'read' - read if found, don't save (default)

                                         'read-or-save' - read if found, save otherwise (don't overwrite)

                                         'overwrite' - don't read, always save

                                         'ignore' - don't read and don't save

  --deobf-use-sourcename              - use source file name as class name alias

  --deobf-res-name-source             - better name source for resources:

                                         'auto' - automatically select best name (default)

                                         'resources' - use resources names

                                         'code' - use R class fields names

  --use-kotlin-methods-for-var-names  - use kotlin intrinsic methods to rename variables, values: disable, apply, apply-and-hide, default: apply

  --rename-flags                      - fix options (comma-separated list of):

                                         'case' - fix case sensitivity issues (according to --fs-case-sensitive option),

                                         'valid' - rename java identifiers to make them valid,

                                         'printable' - remove non-printable chars from identifiers,

                                        or single 'none' - to disable all renames

                                        or single 'all' - to enable all (default)

  --integer-format                    - how integers are displayed:

                                         'auto' - automatically select (default)

                                         'decimal' - use decimal

                                         'hexadecimal' - use hexadecimal

  --fs-case-sensitive                 - treat filesystem as case sensitive, false by default

  --cfg                               - save methods control flow graph to dot file

  --raw-cfg                           - save methods control flow graph (use raw instructions)

  -f, --fallback                      - set '--decompilation-mode' to 'fallback' (deprecated)

  --use-dx                            - use dx/d8 to convert java bytecode

  --comments-level                    - set code comments level, values: error, warn, info, debug, user-only, none, default: info

  --log-level                         - set log level, values: quiet, progress, error, warn, info, debug, default: progress

  -v, --verbose                       - verbose output (set --log-level to DEBUG)

  -q, --quiet                         - turn off output (set --log-level to QUIET)

  --version                           - print jadx version

  -h, --help                          - print this help



Plugin options (-P=):

 1) dex-input: Load .dex and .apk files

    - dex-input.verify-checksum       - verify dex file checksum before load, values: [yes, no], default: yes

 2) java-convert: Convert .class, .jar and .aar files to dex

    - java-convert.mode               - convert mode, values: [dx, d8, both], default: both

    - java-convert.d8-desugar         - use desugar in d8, values: [yes, no], default: no

 3) kotlin-metadata: Use kotlin.Metadata annotation for code generation

    - kotlin-metadata.class-alias     - rename class alias, values: [yes, no], default: yes

    - kotlin-metadata.method-args     - rename function arguments, values: [yes, no], default: yes

    - kotlin-metadata.fields          - rename fields, values: [yes, no], default: yes

    - kotlin-metadata.companion       - rename companion object, values: [yes, no], default: yes

    - kotlin-metadata.data-class      - add data class modifier, values: [yes, no], default: yes

    - kotlin-metadata.to-string       - rename fields using toString, values: [yes, no], default: yes

    - kotlin-metadata.getters         - rename simple getters to field names, values: [yes, no], default: yes

 4) rename-mappings: various mappings support

    - rename-mappings.format          - mapping format, values: [auto, TINY, TINY_2, ENIGMA, ENIGMA_DIR, MCP, SRG, TSRG, TSRG2, PROGUARD], default: auto

    - rename-mappings.invert          - invert mapping, values: [yes, no], default: no



Environment variables:

  JADX_DISABLE_ZIP_SECURITY - set to 'true' to disable all security checks for zip files

  JADX_ZIP_MAX_ENTRIES_COUNT - maximum allowed number of entries in zip files (default: 100 000)

  JADX_TMP_DIR - custom temp directory, using system by default



Examples:

  jadx -d out classes.dex

  jadx --rename-flags "none" classes.dex

  jadx --rename-flags "valid, printable" classes.dex

  jadx --log-level ERROR app.apk

  jadx -Pdex-input.verify-checksum=no app.apk

```

These options also worked on jadx-gui running from command line and override options from preferences dialog



### Troubleshooting

Please check wiki page [Troubleshooting Q&A](https://github.com/skylot/jadx/wiki/Troubleshooting-Q&A)



### Contributing

To support this project you can:

  - Post thoughts about new features/optimizations that important to you

  - Submit decompilation issues, please read before proceed: [Open issue](CONTRIBUTING.md#Open-Issue)

  - Open pull request, please follow these rules: [Pull Request Process](CONTRIBUTING.md#Pull-Request-Process)



---------------------------------------

*Licensed under the Apache 2.0 License*