Support the project by buying me a coffee! Every contribution helps keep the project running.
8 |
9 |
10 | ## Setup
11 |
12 | To use the Telegram Channel Downloader, follow these steps:
13 |
14 | 1. **Create a Telegram App**: Go to [https://my.telegram.org/apps](https://my.telegram.org/apps) and create a new application.
15 | 2. **Get API Credentials**: After creating the app, copy the API ID and API Hash provided by Telegram.
16 |
17 | ### Configure `config.json`
18 |
19 | 3. In the root directory of the application, create a file named `config.json` and paste the following code:
20 |
21 | ```json
22 | {
23 | "apiId": "YOUR_API_ID",
24 | "apiHash": "YOUR_API_HASH",
25 | "sessionId": ""
26 | }
27 | ```
28 |
29 | Replace `YOUR_API_ID` and `YOUR_API_HASH` with the values obtained in step 2. Keep the `sessionId` blank for now; it will be updated automatically after logging in for the first time.
30 |
31 | ## Usage
32 |
33 | Once the setup is complete, you can start using the Telegram Channel Downloader:
34 |
35 | 1. Install all dependencies using:
36 |
37 | ```bash
38 | npm install
39 | ```
40 |
41 | 2. **Run the Script**: Open your terminal or command prompt and navigate to the directory where the Telegram Channel Downloader is located. Run the following command to start the script:
42 |
43 | ```bash
44 | npm start
45 | ```
46 |
47 | 3. **Login**: The script will prompt you to enter your phone number and the code sent to your phone or Telegram account. This authentication is required only the first time you run the script.
48 |
49 | 4. **Select Chat/Channel/Group**: After logging in, choose the target chat, channel, or group you want to scrape. Use the arrow keys to move and select the target chat.
50 |
51 | 5. **Wait for Download**: The script will start downloading all available media files and messages from the specified channel, group, or user. Depending on the size of the content, this process may take some time.
52 |
53 | 6. **Access Downloaded Files**: Once the download is complete, you can find the downloaded media files and messages in the `export/` directory within the Telegram Channel Downloader directory.
54 |
55 | ## CLI
56 |
57 | Available Commands
58 |
59 | | Script Name | Description |
60 | |---------------------------|---------------------------------------------------------------|
61 | | `listen-channel` | Listen to a channel and download media from incoming messages |
62 | | `download-selected-message`| Download media from selected messages |
63 | | `download-channel` | Download all media from a channel |
64 |
65 | ***Using CLI Commands***
66 |
67 | ```bash
68 | node cli [script-name] --options
69 | ```
70 |
71 | example `node cli listen-channel --channelId=12345`
72 |
73 | ## Additional Notes
74 |
75 | * **Session Handling**: The `sessionId` field in the `config.json` file will be automatically updated after logging in for the first time. This session ID is used for subsequent logins to avoid re-entering your credentials.
76 | * **Media Types**: The Telegram Channel Downloader supports downloading various types of media files, including images, videos, audio files, documents, and other attachments shared within the specified channel, group, or user.
77 |
78 | ## Contributing
79 |
80 | Contributions are welcome! If you have any suggestions, bug reports, or feature requests, please open an issue or submit a pull request.
81 |
82 | Happy coding
83 |
--------------------------------------------------------------------------------
/cli.js:
--------------------------------------------------------------------------------
1 | "use strict";
2 | // example command script
3 | // - node cli script-name --option1=value1 --option2=value2
4 |
5 | const fs = require("fs");
6 | const path = require("path");
7 | const { glob } = require("glob");
8 | const logger = require("./utils/logger");
9 | const commandFile = path.join(__dirname, "./scripts");
10 |
11 | const commandFiles = glob.sync([`${commandFile}/**/*.js`]);
12 |
13 | process.on("uncaughtException", (error) => {
14 | logger.error(`Uncaught Exception: ${error.message}`);
15 | logger.error(error.stack);
16 | process.exit(1);
17 | });
18 |
19 | process.on("unhandledRejection", (reason, promise) => {
20 | logger.error(
21 | `Unhandled Rejection: ${reason instanceof Error ? reason.message : reason}`
22 | );
23 | logger.error(`Promise: ${promise}`);
24 | if (reason instanceof Error) {
25 | logger.error(reason.stack);
26 | }
27 | process.exit(1);
28 | });
29 |
30 | /**
31 | * Loads command classes from the specified file paths and returns an object
32 | * mapping command signatures to their respective file paths.
33 | *
34 | * @param {string[]} commandFiles - An array of file paths to the command classes.
35 | * @returns {Object} An object where the keys are command signatures and the values are file paths.
36 | */
37 | function loadCommands(commandFiles) {
38 | const commands = {};
39 | commandFiles.forEach((filePath) => {
40 | const CommandClass = require(filePath);
41 | const signature = path.basename(filePath, ".js");
42 | commands[signature] = {
43 | signature,
44 | path: filePath,
45 | description: CommandClass.description(),
46 | };
47 | });
48 |
49 | return commands;
50 | }
51 |
52 | /**
53 | * Logs the available commands to the console.
54 | * It iterates over the keys of the `availableCommands` object and logs each command signature.
55 | */
56 | function logAvailableCommands() {
57 | logger.success("Available commands:");
58 | const allCommands = Object.values(loadCommands(commandFiles)).map(
59 | (command) => ({
60 | signature: command.signature,
61 | description: command.description,
62 | })
63 | );
64 |
65 | logger.table(allCommands);
66 | }
67 |
68 | /**
69 | * Parses command-line arguments into a script signature and options object.
70 | *
71 | * @param {string[]} argv - The array of command-line arguments.
72 | * @returns {Object} An object containing the script signature and options.
73 | * @returns {string} return.scriptSignature - The script signature (usually the command to run).
74 | * @returns {Object} return.options - An object containing key-value pairs of options.
75 | */
76 | function parseArguments(argv) {
77 | const scriptSignature = argv[2];
78 | const args = argv.slice(3);
79 | const options = {};
80 |
81 | args.forEach((arg) => {
82 | if (arg.startsWith("--")) {
83 | const [key, value] = arg.slice(2).split("=", 2);
84 | options[key] = value === undefined ? true : value;
85 | }
86 | });
87 |
88 | return { scriptSignature, options };
89 | }
90 |
91 | /**
92 | * Executes a command script located at the given path with the specified options.
93 | *
94 | * @param {string} commandPath - The path to the command script to execute.
95 | * @param {Object} options - The options to pass to the command script.
96 | * @returns {Promise