Note: The Magisk zip you download only contains `magiskboot` and `magiskinit`. The binary `magisk` is compressed and embedded into `magiskinit`. Push `magiskinit` to your device and run `./magiskinit -x magisk <path>` to extract `magisk` out of the binary.
Note: The Magisk zip you download only contains `magiskboot`, `magiskinit`, and `magiskinit64`. The binary `magisk` is compressed and embedded into `magiskinit(64)`. Push `magiskinit(64)` to your device and run `./magiskinit(64) -x magisk <path>` to extract `magisk` out of the binary.
### magiskboot
### magiskboot
A tool to unpack / repack boot images, parse / patch / extract cpio, patch dtb, hex patch binaries, and compress / decompress files with multiple algorithms.
A tool to unpack / repack boot images, parse / patch / extract cpio, patch dtb, hex patch binaries, and compress / decompress files with multiple algorithms.
`magiskboot` natively supports (which means it does not rely on external tools) common compression formats including `gzip`, `lz4`, `lz4_legacy` ([only used on LG](https://events.static.linuxfound.org/sites/events/files/lcjpcojp13_klee.pdf)), `lzma`, `xz`, and `bzip2`.
`magiskboot` natively supports (which means it does not rely on external tools) common compression formats including `gzip`, `lz4`, `lz4_legacy` ([only used on LG](https://events.static.linuxfound.org/sites/events/files/lcjpcojp13_klee.pdf)), `lzma`, `xz`, and `bzip2`.
The concept of `magiskboot` is to make boot image modification much simpler. For unpacking, it parses the header and all sections in the image (kernel, ramdisk, second, dtb, extra), detect compression format used in each section, and decompress while extraction. Each extracted sections are raw data, ready for direct modification. For repacking, the original boot image is required so the original headers can be used, changing only the necessary entries such as section sizes and checksum, and finally compress each sections back with the original format.
The concept of `magiskboot` is to make boot image modification simpler. For unpacking, it parses the header and extracts all sections in the image, decompressing on-the-fly if compression is detected in any sections. For repacking, the original boot image is required so the original headers can be used, changing only the necessary entries such as section sizes and checksum. All sections will be compressed back to the original format if required. The tool also supports many CPIO and DTB operations.
The tool also supports a variaty of CPIO operations that can modify CPIO archives without any extracting and repacking involved.
```
```
Usage: ./magiskboot <action> [args...]
Usage: magiskboot <action> [args...]
Supported actions:
Supported actions:
--unpack <bootimg>
unpack [-h] <bootimg>
Unpack <bootimg> to kernel, ramdisk.cpio, and if available, second, dtb,
Unpack <bootimg> to, if available, kernel, kernel_dtb, ramdisk.cpio,
and extra into the current directory. Return values:
second, dtb, extra, and recovery_dtbo into current directory.
0:valid 1:error 2:chromeos 3:ELF32 4:ELF64
If '-h' is provided, it will dump header info to 'header',
which will be parsed when repacking.
--repack <origbootimg> [outbootimg]
Return values:
Repack kernel, ramdisk.cpio[.ext], second, dtb... from current directory
0:valid 1:error 2:chromeos
repack <origbootimg> [outbootimg]
Repack boot image components from current directory
to [outbootimg], or new-boot.img if not specified.
to [outbootimg], or new-boot.img if not specified.
It will compress ramdisk.cpio with the same method used in <origbootimg>,
It will compress ramdisk.cpio and kernel with the same method in
or attempt to find ramdisk.cpio.[ext], and repack directly with the
<origbootimg> if the file provided is not already compressed.
compressed ramdisk file
--hexpatch <file> <hexpattern1> <hexpattern2>
hexpatch <file> <hexpattern1> <hexpattern2>
Search <hexpattern1> in <file>, and replace with <hexpattern2>
Search <hexpattern1> in <file>, and replace with <hexpattern2>
--cpio <incpio> [commands...]
cpio <incpio> [commands...]
Do cpio commands to <incpio> (modifications are done directly)
Do cpio commands to <incpio> (modifications are done directly)
Each command is a single argument, use quotes if necessary
Each command is a single argument, use quotes if necessary
This binary will replace `init` in the ramdisk of a Magisk patched boot image. It is required for supporting devices using system as root (most A/B devices, plus some odd-balls like Huawei EMUI 9), but the tool is extended to support all traditional devices so the same installation setup could be used on all devices. More details can be found in the **Pre-Init** section in [Magisk Booting Process](details.md#magisk-booting-process).
This binary will replace `init` in the ramdisk of a Magisk patched boot image. It is originally created for supporting devices using system-as-root, but the tool is extended to support all devices and became a crucial part of Magisk. More details can be found in the **Pre-Init** section in [Magisk Booting Process](details.md#magisk-booting-process).
### magiskpolicy
### magiskpolicy
(This tool is aliased to `supolicy` for compatibility with SuperSU's sepolicy tool)
(This tool is aliased to `supolicy` for compatibility with SuperSU's sepolicy tool)
...
@@ -121,13 +116,15 @@ All processes spawned from the Magisk daemon, including root shells and all its
...
@@ -121,13 +116,15 @@ All processes spawned from the Magisk daemon, including root shells and all its
When the magisk binary is called with the name `magisk`, it works as an utility tool with many helper functions and the entry points for `init` to start Magisk services.
When the magisk binary is called with the name `magisk`, it works as an utility tool with many helper functions and the entry points for several Magisk services.
```
```
Usage: magisk [applet [arguments]...]
Usage: magisk [applet [arguments]...]
...
@@ -187,18 +191,21 @@ Options:
...
@@ -187,18 +191,21 @@ Options:
-v print running daemon version
-v print running daemon version
-V print running daemon version code
-V print running daemon version code
--list list all available applets
--list list all available applets
--install [SOURCE] DIR symlink all applets to DIR. SOURCE is optional
--daemon manually start magisk daemon
--daemon manually start magisk daemon
--[init trigger] start service for init trigger
--[init trigger] start service for init trigger
Advanced Options (Internal APIs):
--unlock-blocks set BLKROSET flag to OFF for all block devices
--unlock-blocks set BLKROSET flag to OFF for all block devices
--restorecon fix selinux context on Magisk files and folders
--restorecon restore selinux context on Magisk files
--clone-attr SRC DEST clone permission, owner, and selinux context
--clone-attr SRC DEST clone permission, owner, and selinux context
--clone SRC DEST clone SRC to DEST
--sqlite SQL exec SQL to Magisk database
Supported init triggers:
Supported init triggers:
startup, post-fs-data, service
post-fs-data, service, boot-complete
Supported applets:
Supported applets:
magisk, su, resetprop, magiskhide, imgtool
magisk, su, resetprop, magiskhide
```
```
### su
### su
...
@@ -248,27 +255,13 @@ Flags:
...
@@ -248,27 +255,13 @@ Flags:
An applet of `magisk`, the CLI to control MagiskHide. Use this tool to communicate with the daemon to change MagiskHide settings.
An applet of `magisk`, the CLI to control MagiskHide. Use this tool to communicate with the daemon to change MagiskHide settings.
```
```
Usage: magiskhide [--options [arguments...] ]
Usage: magiskhide [--option [arguments...] ]
Options:
Options:
--status Return the status of magiskhide
--enable Start magiskhide
--enable Start magiskhide
--disable Stop magiskhide
--disable Stop magiskhide
--add PROCESS Add PROCESS to the hide list
--add PKG [PROC] Add a new target to the hide list
--rm PROCESS Remove PROCESS from the hide list
--rm PKG [PROC] Remove from the hide list
--ls Print out the current hide list
--ls List the current hide list
```
### imgtool
An applet of `magisk`, a collection of common commands used to create and manage `ext4` images.
```
Usage: imgtool <action> [args...]
Actions:
create IMG SIZE create ext4 image. SIZE is interpreted in MB
resize IMG SIZE resize ext4 image. SIZE is interpreted in MB
mount IMG PATH mount IMG to PATH and prints the loop device
umount PATH LOOP unmount PATH and delete LOOP device