git-ripper 1.5.0 → 1.5.1

package/README.md

@@ -120,9 +120,9 @@ You can use either a **Fine-grained token** (Recommended) or a **Classic token**
 4.  **Resource owner**: Select your user.
 5.  **Repository access**: Select **Only select repositories** and choose the private repository you want to download from.
 6.  **Permissions**:
-    *   Click on **Repository permissions**.
-    *   Find **Contents** and change Access to **Read-only**.
-    *   *Note: Metadata permission is selected automatically.*
+    - Click on **Repository permissions**.
+    - Find **Contents** and change Access to **Read-only**.
+    - _Note: Metadata permission is selected automatically._
 7.  Click **Generate token**.
 
 #### Option B: Classic Token
@@ -131,7 +131,7 @@ You can use either a **Fine-grained token** (Recommended) or a **Classic token**
 2.  Click **Generate new token** > **Generate new token (classic)**.
 3.  Give your token a descriptive name.
 4.  **Select Scopes:**
-    *   **For Private Repositories:** Select the **`repo`** scope (Full control of private repositories).
+    - **For Private Repositories:** Select the **`repo`** scope (Full control of private repositories).
 5.  Click **Generate token**.
 
 ### Using the Token
@@ -174,6 +174,13 @@ git-ripper https://github.com/nodejs/node/tree/main/doc -o ./node-docs
 git-ripper https://github.com/tailwindlabs/tailwindcss/tree/master/src/components -o ./tailwind-components
 ```
 
+### Download from Private Repository
+
+```bash
+# Download from a private repository using a token
+git-ripper https://github.com/my-org/private-project/tree/main/src --gh-token ghp_abc123...
+```
+
 ### Download and Create Archive
 
 ```bash
@@ -260,7 +267,10 @@ Git-ripper works out of the box without configuration. For rate-limited GitHub A
 Error: Request failed with status code 403
 ```
 
-**Solution**: GitHub limits unauthenticated API requests. Wait a few minutes and try again.
+**Solution**: GitHub limits unauthenticated API requests. You can either:
+
+1. Wait a few minutes and try again
+2. Use the `--gh-token` option with a Personal Access Token to significantly increase your rate limit
 
 #### Invalid URL Format
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "git-ripper",
-  "version": "1.5.0",
+  "version": "1.5.1",
   "description": "CLI tool that lets you download specific folders from GitHub repositories without cloning the entire repo.",
   "main": "src/index.js",
   "type": "module",

package/src/downloader.js

@@ -131,7 +131,7 @@ const fetchFolderContents = async (owner, repo, branch, folderPath, token) => {
             isRateLimit = true;
             errorMessage = `GitHub API rate limit exceeded. Please wait until ${new Date(
               parseInt(error.response.headers["x-ratelimit-reset"]) * 1000
-            ).toLocaleTimeString()} or add a GitHub token (feature coming soon).`;
+            ).toLocaleTimeString()} or use the --gh-token option to increase your rate limit.`;
           } else {
             errorMessage = `Access forbidden: ${
               error.response.data.message ||
@@ -171,7 +171,14 @@ const fetchFolderContents = async (owner, repo, branch, folderPath, token) => {
  * @param {string} [token] - GitHub Personal Access Token
  * @returns {Promise<Object>} - Object containing download status
  */
-const downloadFile = async (owner, repo, branch, filePath, outputPath, token) => {
+const downloadFile = async (
+  owner,
+  repo,
+  branch,
+  filePath,
+  outputPath,
+  token
+) => {
   const headers = {
     ...(token ? { Authorization: `Bearer ${token}` } : {}),
   };
@@ -223,7 +230,10 @@ const downloadFile = async (owner, repo, branch, filePath, outputPath, token) =>
   const url = `${baseUrl}${fileUrlPath}`;
 
   try {
-    const response = await axios.get(url, { responseType: "arraybuffer", headers });
+    const response = await axios.get(url, {
+      responseType: "arraybuffer",
+      headers,
+    });
 
     // Ensure the directory exists
     try {
@@ -363,7 +373,13 @@ const downloadFolder = async (
   );
 
   try {
-    const contents = await fetchFolderContents(owner, repo, branch, folderPath, token);
+    const contents = await fetchFolderContents(
+      owner,
+      repo,
+      branch,
+      folderPath,
+      token
+    );
 
     if (!contents || contents.length === 0) {
       const message = `No files found in ${folderPath || "repository root"}`;
@@ -565,7 +581,11 @@ const downloadFolderWithResume = async (
   const { resume = true, forceRestart = false, token } = options;
 
   if (!resume) {
-    return downloadFolder({ owner, repo, branch, folderPath }, outputDir, options);
+    return downloadFolder(
+      { owner, repo, branch, folderPath },
+      outputDir,
+      options
+    );
   }
 
   const resumeManager = new ResumeManager();
@@ -637,7 +657,13 @@ const downloadFolderWithResume = async (
   );
 
   try {
-    const contents = await fetchFolderContents(owner, repo, branch, folderPath, token);
+    const contents = await fetchFolderContents(
+      owner,
+      repo,
+      branch,
+      folderPath,
+      token
+    );
     if (!contents || contents.length === 0) {
       const message = `No files found in ${folderPath || "repository root"}`;
       console.log(chalk.yellow(message));