TP-Link Firmware Directory

A Python utility to fetch and list all firmware and application files from the TP-Link cloud S3 bucket, exporting the results to a text file for research or archival purposes.
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Contributing
5. License
6. Contact
7. Acknowledgments

About The Project

This project provides a Python script to enumerate and export all file keys from the TP-Link firmware and application S3 bucket (download.tplinkcloud.com). The output is a comprehensive list of available files, including firmware, apps, and configuration files, useful for research, analysis, or archival.

(back to top)

Built With

• Python 3.13+
• boto3
• botocore

(back to top)

Getting Started

To get a local copy up and running, follow these steps.

Prerequisites

• Python 3.13 or higher
• pip (Python package manager)

Installation

1. Clone the repository

   git clone https://github.com/LoveDoLove/TpLinkFirmwareDirectory.git

2. Change into the project directory

   cd TpLinkFirmwareDirectory

3. (Optional but recommended) Create and activate a virtual environment

   python -m venv .venv
   .venv\Scripts\activate

4. Install dependencies

   pip install -r requirements.txt
   # or, if using pyproject.toml/PEP 621:
   pip install .

(back to top)

Usage

Run the main script to fetch and export all S3 object keys from the TP-Link cloud bucket:

python .github/scripts/fetch_s3_firmware_list.py

The output will be saved to lists/download.tplinkcloud.com_all_keys.txt.

You can then analyze or process this file as needed.

(back to top)

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

Top contributors:

License

Distributed under the MIT License. See LICENSE for more information.

(back to top)

Contact

LoveDoLove

Project Link: https://github.com/LoveDoLove/TpLinkFirmwareDirectory

(back to top)

Acknowledgments

• boto3
• botocore

(back to top)