{"id":20711092,"url":"https://github.com/kdrag0n/adevtool","last_synced_at":"2025-04-07T12:01:39.011Z","repository":{"id":39646256,"uuid":"453682044","full_name":"kdrag0n/adevtool","owner":"kdrag0n","description":"Android ROM device support and bringup tool, designed for maximum automation and speed.","archived":false,"fork":false,"pushed_at":"2022-10-06T18:10:27.000Z","size":420,"stargazers_count":222,"open_issues_count":13,"forks_count":54,"subscribers_count":7,"default_branch":"main","last_synced_at":"2025-03-31T11:03:25.521Z","etag":null,"topics":["android","aosp","hacktoberfest"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/kdrag0n.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null},"funding":{"patreon":"kdrag0n","liberapay":"kdrag0n","custom":"https://paypal.me/kdrag0ndonate"}},"created_at":"2022-01-30T13:04:24.000Z","updated_at":"2025-03-06T14:55:50.000Z","dependencies_parsed_at":"2022-08-28T07:33:49.462Z","dependency_job_id":null,"html_url":"https://github.com/kdrag0n/adevtool","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kdrag0n%2Fadevtool","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kdrag0n%2Fadevtool/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kdrag0n%2Fadevtool/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kdrag0n%2Fadevtool/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/kdrag0n","download_url":"https://codeload.github.com/kdrag0n/adevtool/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247648874,"owners_count":20972944,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["android","aosp","hacktoberfest"],"created_at":"2024-11-17T02:14:00.351Z","updated_at":"2025-04-07T12:01:38.986Z","avatar_url":"https://github.com/kdrag0n.png","language":"TypeScript","funding_links":["https://patreon.com/kdrag0n","https://liberapay.com/kdrag0n","https://paypal.me/kdrag0ndonate"],"categories":["TypeScript"],"sub_categories":[],"readme":"# adevtool\n\nAndroid ROM device support and bringup tool, designed for maximum automation and speed.\n\n[![Demo video on asciinema](https://asciinema.org/a/kCWUN6XcyaDEU6bcoE65rVQrv.svg)](https://asciinema.org/a/kCWUN6XcyaDEU6bcoE65rVQrv)\n\n## Features\n\nThis tool automates the following tasks for devices that mostly run AOSP out-of-the-box (e.g. Google Pixel):\n\n- Downloading factory images and full OTA packages\n- Generating a list of **proprietary files**\n- Resolving overridden build rules and **building modules from source** (when possible)\n- Extracting, converting, and mounting **factory images** [(supported source formats)](docs/system-source.md)\n- Extracting proprietary files\n- Extracting bootloader and radio **firmware**\n- Finding and adding missing system **properties**\n- Overriding build **fingerprint** to help pass SafetyNet\n- Adding missing **SELinux policies**\n- Adding missing HALs to **vendor interface** manifests\n- Generating resource **overlays** for device configs\n- Fixing privileged app signing **certificates** referenced in SELinux policies\n\nThis typically results in better device support with fewer bugs and issues, and makes it possible to quickly add support for new devices.\n\n[Example generated vendor modules for Pixel devices](https://github.com/NeutronBlobs/android_vendor_google_devices)\n\n### Non-AOSP devices\n\nPixel devices will benefit from the most automation, but several features can still be used to ease manual bringup on other devices:\n\n- **Extract** files from proprietary-files.txt **[up to 2000% faster than LineageOS extract-utils (speed comparison)](https://asciinema.org/a/eUMNIrKtBrln1CwE1zCUnJO8w)**\n  - LineageOS extract-utils: 1 min 27 sec\n  - **adevtool: 4 sec**\n  - Tested with Pixel 5 (redfin), cache cleared before testing\n- **Compare** a built system against stock images to find missing files, properties, and vendor interface declarations\n- **List** system files relevant to bringup (in all partitions)\n- **Resolve overridden** build rules from build warnings\n- Check SELinux policies to identify apps that should be **presigned**\n\n## Installation\n\nPre-requisites:\n\n- [Node.js](https://nodejs.org/) v18 or newer (**older versions will not work**)\n- Optional:\n  - For converting sparse factory images: [simg2img](https://github.com/anestisb/android-simg2img)\n  - For extracting OTA packages: [payload-dumper-go](https://github.com/ssut/payload-dumper-go)\n  - For extracting OTAs or factory images: `unzip`\n  - For generating overlays: [AAPT2](https://developer.android.com/studio/command-line/aapt2) (included in AOSP and Android SDK)\n\nTo run adevtool without installation:\n\n```bash\nnpx adevtool\n```\n\nTo install adevtool globally using npm:\n\n```bash\nnpm install -g adevtool\n```\n\nUsing Yarn:\n\n```bash\nyarn global add adevtool\n```\n\n## Usage\n\n- [Bringing up a new Pixel device](docs/pixel-bringup.md)\n- [Generating or updating an existing device](docs/pixel-generate.md)\n- [Using individual helper commands](docs/commands.md)\n- [Supported system source formats](docs/system-source.md)\n\n## Why TypeScript?\n\nTypeScript is not a common language for Android-related tools, but I picked it for several reasons:\n\n- Fast (enough) and easily parallelizable\n- Good static type system (for developer experience: fewer bugs and better editor code intelligence)\n- Good libraries for friendly CLI interfaces with pretty output\n- Relatively lightweight\n\n### Why not...\n\n- Python: May not meet speed/parallelization goals easily, types aren't as nice\n- Kotlin: Requires big+heavy JVM to run, CLI libraries aren't as good\n- Go: Good choice overall, but error checking can be overly verbose\n\nOverall, TypeScript is a decent compromise on all of these points.\n\n## License\n\nThis tool is licensed under the [MIT license](LICENSE), ensuring that anyone is free to use it for any purpose in compliance with the license. Contributions are welcome!\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkdrag0n%2Fadevtool","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fkdrag0n%2Fadevtool","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkdrag0n%2Fadevtool/lists"}