jadx/jadx-plugins/jadx-script
nitram84 8a34d973ff
Some checks are pending
Build Artifacts / build (push) Waiting to run
Build Artifacts / build-win-bundle (push) Waiting to run
Build Test / tests (ubuntu-latest) (push) Waiting to run
Build Test / tests (windows-latest) (push) Waiting to run
CodeQL / Analyze (java) (push) Waiting to run
build: use jadx-gui as a library in plugins (PR #2310)
* fix(gui): fix javadoc issues

* feat(gui): export jadx-gui as a library

* fix(gui): fix javadoc issues

* fix(gui): remove invalid characters for javadoc

* add jadx-library also for jadx-cli and jadx-script-ide modules

---------

Co-authored-by: Skylot <118523+skylot@users.noreply.github.com>
2024-10-22 17:24:57 +01:00
..
examples chore: update gradle and dependencies 2024-07-19 00:19:47 +03:00
jadx-script-ide build: use jadx-gui as a library in plugins (PR #2310) 2024-10-22 17:24:57 +01:00
jadx-script-plugin chore: update gradle and dependencies 2024-07-19 00:19:47 +03:00
jadx-script-runtime chore: update dependencies 2024-09-21 22:00:03 +01:00
README.md fix: scripts runtime code and docs clean up 2023-04-20 17:22:13 +01:00

JADX scripting support

Work still in progress! Script API is not stable!

Examples

Check script examples in examples/scripts/(start with hello)

Script usage

In jadx-cli

Just add script file as input

In jadx-gui

  1. Add script file to the project (using Add files or New script by right-click menu on Inputs/Scripts)
  2. Script will appear in Inputs/Scripts section
  3. After script change, you can run it using Run button in script editor toolbar or reload whole project (Reload button in toolbar or F5). Also, you can enable Live reload option in File menu to reload project automatically on scripts change

Script development

Jadx-gui for now don't support autocompletion, errors highlighting, code navigation and docs, so the best approach for script editing is to open jadx project in IntelliJ IDEA and write your script in examples/scripts/ folder. Also, this allows to debug your scripts: for that you need to create run configuration for jadx-cli or jadx-gui add breakpoints and next run it in debug mode (jadx-gui is preferred because of faster script reload).

Script logs and compilation errors will appear in Log viewer (try filter for show only script related logs)