tanishqmanuja / apkmirror-downloader

📥 Download apps from APKMirror with ease.
https://www.npmjs.com/package/apkmirror-downloader
MIT License
34 stars 8 forks source link
apk apkmirror cli

Logo

APKMD //APKMirror Downloader

Downloads NPM Version GitHub Workflow Status Language License

APKMD is a CLI tool that allows you to download APKs from Apkmirror. This repo also provides a npm package apkmirror-downloader that allows you to do the same programatically.

🚀 Install

Using npm

npm install apkmirror-downloader

Using bun

bun add apkmirror-downloader

Or use any other package manager like yarn or pnpm

📃 Usage

import { APKMirrorDownloader } from "apkmirror-downloader";

const apkmd = new APKMirrorDownloader(
  { outDir: "./downloads" }, // <-- 🟠 APKMDOptions (optional)
);

apkmd.download(
  { org: "google-inc", repo: "youtube" }, // <-- App (required)
  { type: "apk" }, // <-- 🟣 AppOptions (optional), will be merged with APKMDOptions
);

// OR

APKMirrorDownloader.download({ org: "google-inc", repo: "youtube" });

🟠 APKMDOptions Interface

🟣 AppOptions Interface

AppOptions will be merged automatically with APKMDOptions when download function is called.

[!WARNING] Sometimes, download can fail at random. This is most likely due to rate limit protection by APKMirror using Cloudflare.

⚡ CLI

CLI can be downloaded from releases section.

Usage can be found using the following command

apkmd --help

For downloading multiple apks use apps.json file

apkmd apps.json
{
  "options": {
    "arch": "arm64-v8a",
    "outDir": "downloads"
  },
  "apps": [
    {
      "org": "google-inc",
      "repo": "youtube-music",
      "outFile": "ytm"
    },
    {
      "org": "google-inc",
      "repo": "youtube",
      "outFile": "yt",
      "version": "18.40.34"
    }
  ]
}

🐱 Show your support

Give a ⭐️ if this project helped you!

👨‍💻 Projects to checkout

  1. 📦 gh-apkmirror-dl by Yakov \ A GitHub Action to download APKs from Apkmirror

  2. 📦 revanced-auto-patcher by Sp3EdeR \ A Python script to patch apps using Revanced or Revanced Extended

💀 Disclaimer

THIS PROJECT IS NOT ASSOCIATED OR ENDORSED BY APKMIRROR. The project is provided "as is" without warranty of any kind, either express or implied. Use at your own risk.