Skip to content

chore: update AI configs and docs #34

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
seppzer0 wants to merge 4 commits into
base: main
Choose a base branch
from
+270 −358
Open

chore: update AI configs and docs #34

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
1737e64
chore: bump dependency versions
seppzer0 May 11, 2026
23e9c00
docs: update README
seppzer0 May 11, 2026
9971c50
ai: update config
seppzer0 May 11, 2026
68cb4df
docs: re-add missing README chapter
seppzer0 May 11, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
0 .cursor/rules/.gitkeep → .claude/rules/.gitkeep
View file
Open in desktop
File renamed without changes.
4 changes: 4 additions & 0 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,3 +27,7 @@ __pycache__
/bundle
/localversion
/multi-build

# AI
#/.claude
!.gitkeep
139 changes: 15 additions & 124 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,10 +11,7 @@ An advanced Android kernel builder with assets collection and Kali NetHunter sup
- [Kernel Features](#kernel-features)
- [Supported Devices \& ROMs](#supported-devices--roms)
- [Usage](#usage)
- [Prerequisites](#prerequisites)
- [Kernel](#kernel)
- [Assets](#assets)
- [Bundle](#bundle)
- [Prerequisites](#prerequisites)
Copy link
Copy Markdown
Owner Author

@seppzer0 seppzer0 May 11, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

docs: Usage chapter deleted. Need to restore it

- [Examples](#examples)
- [See also](#see-also)
- [Credits](#credits)
Expand Down Expand Up @@ -82,33 +79,16 @@ The custom build wrapper (aka "zkb") consists of 2 core components and 3 primary

Components:

- `kernel_builder`;
- `assets_collector`.
- kernel_builder ;
- assets_collector.

Commands:

- `kernel`;
- `assets`;
- `bundle`.
- kernel ;
- assets ;
- bundle.

```help
$ python3 zkb --help
usage: zkb [-h] [--clean] {kernel,assets,bundle} ...

A custom builder for the zero_kernel.

positional arguments:
{kernel,assets,bundle}
kernel build the kernel
assets collect assets
bundle build the kernel + collect assets

optional arguments:
-h, --help show this help message and exit
--clean clean the root directory
```

### Prerequisites
## Prerequisites

**It is highly recommended to use `docker` option to run this tool.** For that you need Docker Engine or Docker Desktop, depending on your OS.

Expand All @@ -124,126 +104,37 @@ To run this tool in a `local` environment, you will need:
```sh
# install uv version from project file
python3 -m pip install uv==$(cat ./uv-version.txt | tr -d ' \n')

# make zkb/ internal imports visible to itself
export PYTHONPATH=$(pwd)
# prepare and activate dev environment
uv sync --frozen --no-install-project

# prepare and activate environment
uv sync --frozen
source .venv/bin/activate
```

Once you are finished working with the project, don't forget to disable the virtual environment (venv) via simple `deactivate`.

### Kernel

Kernel build process can be launched using the `kernel` subcommand.

```help
$ python3 zkb kernel --help
usage: zkb kernel [-h] --build-env {local,docker,podman} --base {los,pa,x,aosp}
--codename CODENAME --lkv LKV [-c] [--clean-image] [--ksu]

options:
-h, --help show this help message and exit
--build-env {local,docker,podman}
select build environment
--base {los,pa,x,aosp}
select a kernel base for the build
--codename CODENAME select device codename
--lkv LKV select Linux Kernel Version
-c, --clean don't build anything, only clean kernel directories
--clean-image remove Docker/Podman image from the host machine after
build
--ksu add KernelSU support
```

### Assets

As mentioned, there is also an asset downloader, which can collect latest versions of ROM, TWRP, Magisk and it's modules, Kali Chroot etc.

```help
$ python3 zkb assets --help
usage: zkb assets [-h] --build-env {local,docker,podman} --base {los,pa,x,aosp}
--codename CODENAME --chroot {full,minimal} [--rom-only]
[--clean-image] [--clean] [--ksu]

options:
-h, --help show this help message and exit
--build-env {local,docker,podman}
select build environment
--base {los,pa,x,aosp}
select a kernel base for the build
--codename CODENAME select device codename
--chroot {full,minimal}
select Kali chroot type
--rom-only download only the ROM as an asset
--clean-image remove Docker/Podman image from the host machine after
build
--clean autoclean 'assets' folder if it exists
--ksu add KernelSU support
--defconfig DEFCONFIG
specify path to custom defconfig
```

### Bundle

The `bundle` command is a combined usage of kernel builder and assets collector core modules.

This is especially useful for linking the kernel build with the appropriate ROM build.

There are cases when an old kernel build is used with the newer ROM build. Such cases can ultimately lead to your system working improperly or breaking down completely, which is why it is important to use a *specific* kernel build with a corresponding ROM build.

Currently, there are three types of packaging available:

- `conan`;
- `slim`;
- `full`.

Options `full` and `conan` collect all of the assets required to successfuly flash the kernel onto your device. The difference between the two is that `full` option places everything into a local directory, while `conan` organizes everything as a Conan package.

Option named `slim` is a much lighter version of `full` packaging, as only the ROM is collected from the asset list. This is done to reduce package sizes while ensuring the kernel+ROM compatibility.

```help
$ python3 zkb bundle --help
usage: zkb bundle [-h] --build-env {local,docker,podman} --base {los,pa,x,aosp}
--codename CODENAME --lkv LKV --package-type
{conan,slim,full} [--conan-upload] [--clean-image] [--ksu]

options:
-h, --help show this help message and exit
--build-env {local,docker,podman}
select build environment
--base {los,pa,x,aosp}
select a kernel base for the build
--codename CODENAME select device codename
--lkv LKV select Linux Kernel Version
--package-type {conan,slim,full}
select package type of the bundle
--conan-upload upload Conan packages to remote
--clean-image remove Docker/Podman image from the host machine after
build
--ksu add KernelSU support
```

## Examples

Here are some examples of commands:

**(Recommended)** Build kernel and collect ROM via Docker:

```sh
python3 zkb bundle --build-env=docker --base=los --codename=dumpling --lkv=4.4 --package-type=slim
uv run zkb bundle --build-env=docker --base=los --codename=dumpling --lkv=4.4 --package-type=slim
```

Build kernel locally:

```sh
python3 zkb kernel --build-env=local --base=los --codename=dumpling --lkv=4.4
uv run zkb kernel --build-env=local --base=los --codename=dumpling --lkv=4.4
```

Collect all of the assets locally:

```sh
python3 zkb assets --build-env=local --base=los --codename=dumpling --package-type=full
uv run zkb assets --build-env=local --base=los --codename=dumpling --package-type=full
```

## See also
Expand All @@ -254,4 +145,4 @@ python3 zkb assets --build-env=local --base=los --codename=dumpling --package-ty

## Credits

- [kali-nethunter-kernel](https://gitlab.com/kalilinux/nethunter/build-scripts/kali-nethunter-kernel): official kernel patches from Kali NetHunter project.
- [kali-nethunter-kernel](https://gitlab.com/kalilinux/nethunter/build-scripts/kali-nethunter-kernel) : Official kernel patches from Kali NetHunter project.
2 changes: 1 addition & 1 deletion uv-version.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1 @@
0.10.7
0.11.12
Loading