gitlo 1.0.0 → 1.0.2

package/README.md

@@ -1,13 +1,15 @@
-<div align="center">
+<div align="left">
 
-# 🗄️ gitlo
+[![gitlo](https://raw.githubusercontent.com/dropocol/gitlo/main/banner.png)](https://github.com/dropocol/gitlo)
 
 [![npm version](https://img.shields.io/npm/v/gitlo.svg)](https://www.npmjs.com/package/gitlo)
 [![npm downloads](https://img.shields.io/npm/dm/gitlo.svg)](https://www.npmjs.com/package/gitlo)
 [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
 [![Node.js Version](https://img.shields.io/node/v/gitlo)](https://nodejs.org)
 
-**Backup all your GitHub repositories locally with one command.**
+# gitlo
+
+**Backup your GitHub repos. Never lose your code.**
 
 Never lose your code to account deletions, suspensions, or unexpected issues.
 
@@ -32,7 +34,7 @@ GitHub accounts can be deleted, suspended, or compromised. This tool creates a l
 
 ## 📦 Installation
 
-### Quick Install (npm - Recommended)
+### Quick Install (npm)
 
 ```bash
 npm install -g gitlo
@@ -59,15 +61,19 @@ yarn global add gitlo
 # Clone and build
 git clone https://github.com/dropocol/gitlo.git
 cd gitlo
-pnpm install
-pnpm run build
+npm install
+npm run build
 
 # Link globally
-pnpm link --global
+npm link --global
 ```
 
 ## Getting a GitHub Token
 
+gitlo supports two types of GitHub personal access tokens:
+
+### Option 1: Classic Token (Recommended)
+
 1. Go to [https://github.com/settings/tokens](https://github.com/settings/tokens)
 2. Click "Generate new token (classic)"
 3. Select these scopes:
@@ -75,6 +81,19 @@ pnpm link --global
   - `read:user` - Read user profile data
 4. Generate and copy the token
 
+### Option 2: Fine-Grained Token
+
+1. Go to [https://github.com/settings/tokens](https://github.com/settings/tokens)
+2. Click "Generate new token" → "Fine-grained token"
+3. Configure permissions:
+  - **Repository permissions**: 
+    - Contents: **Read and write** (required for cloning)
+    - Metadata: **Read-only** (required for repository access)
+  - **Account permissions**:
+    - User profile: **Read-only** (optional, for user info)
+4. Select the repositories to access (or "All repositories")
+5. Generate and copy the token
+
 ## 🚀 Quick Start
 
 ### 1. Get a GitHub Token
@@ -227,7 +246,7 @@ gitlo config remove output-dir
 Schedule automatic backups with cron.
 
 ```bash
-# Weekly on Sunday at 2 AM (default)
+# Weekly on Sunday at 2 AM (default, updates existing repos)
 gitlo schedule setup
 
 # Daily at 3 AM
@@ -239,8 +258,8 @@ gitlo schedule setup --frequency weekly --day 1
 # Monthly on the 1st at 2 AM
 gitlo schedule setup --frequency monthly
 
-# Hourly (only updates existing repos)
-gitlo schedule setup --frequency hourly --update
+# Full backup (clone all repos, don't just update)
+gitlo schedule setup --full
 ```
 
 #### `gitlo schedule list`
@@ -330,19 +349,19 @@ If you want to contribute or modify the code:
 
 ```bash
 # Install all dependencies (including dev)
-pnpm install
+npm install
 
 # Build TypeScript to JavaScript
-pnpm run build
+npm run build
 
 # Run in development mode
-pnpm run dev
+npm run dev
 
 # Clean build artifacts
-pnpm run clean
+npm run clean
 
 # Test local changes globally
-pnpm link --global
+npm link --global
 ```
 
 ### Publishing
@@ -351,9 +370,6 @@ When you're ready to publish to npm:
 
 ```bash
 # The prepublishOnly script automatically builds before publishing
-pnpm publish
-
-# Or publish to npm
 npm publish
 ```
 
@@ -385,6 +401,7 @@ your-backup-directory/
 
 ```bash
 # Setup weekly backups (default: Sundays at 2 AM)
+# By default, updates existing repos (faster)
 gitlo schedule setup
 
 # Setup daily backups at 3 AM
@@ -393,8 +410,8 @@ gitlo schedule setup --frequency daily --time 03:00
 # Setup weekly on Mondays at 2 AM
 gitlo schedule setup --frequency weekly --day 1 --time 02:00
 
-# Only update existing repos (faster)
-gitlo schedule setup --update
+# Full backup (clone all repos including new ones)
+gitlo schedule setup --full
 
 # View scheduled jobs
 gitlo schedule list
@@ -408,9 +425,11 @@ gitlo schedule remove
 - `-f, --frequency <freq>` - hourly, daily, weekly, monthly (default: weekly)
 - `-t, --time <time>` - Time in HH:MM format (default: 02:00)
 - `-d, --day <day>` - Day of week 0-6 for weekly (0=Sunday, default: 0)
-- `-u, --update` - Only update existing repos, don't clone new ones
+- `--full` - Clone all repos instead of just updating existing (default: update)
 - `-l, --log <path>` - Log file path (default: ~/.gitlo/backup.log)
 
+**Note:** By default, scheduled backups update existing repositories for faster execution. Use `--full` to clone all repositories including new ones.
+
 ### Manual Cron Setup (Advanced)
 
 If you prefer manual setup:
@@ -432,7 +451,7 @@ npm install -g gitlo && gitlo config set token YOUR_TOKEN && gitlo
 ### One-liner for Development Setup
 
 ```bash
-cd ~ && git clone https://github.com/dropocol/gitlo.git && cd gitlo && pnpm install && pnpm run build && pnpm link --global && echo "Setup complete. Run: gitlo config set token YOUR_TOKEN"
+cd ~ && git clone https://github.com/dropocol/gitlo.git && cd gitlo && npm install && npm run build && npm link --global && echo "Setup complete. Run: gitlo config set token YOUR_TOKEN"
 ```
 
 ## Security Notes

package/dist/backup.js

@@ -52,10 +52,29 @@ async function cloneOrUpdateRepo(repo, repoPath, options, progress, index, total
             if (options.updateExisting) {
                 repoSpinner.text = `${progress} Updating ${repo.name}...`;
                 const git = (0, simple_git_1.default)(repoPath);
-                await git.pull('origin', 'main').catch(async () => {
-                    // Try master if main fails
-                    await git.pull('origin', 'master');
-                });
+                // For private repos with HTTPS, temporarily use authenticated URL
+                const originalUrlResult = await git.remote(['get-url', 'origin']);
+                const originalUrl = typeof originalUrlResult === 'string'
+                    ? originalUrlResult.trim().replace(/[\n\r\t]/g, '')
+                    : '';
+                let needsRestore = false;
+                if (options.token && options.method === 'https' && originalUrl) {
+                    const authenticatedUrl = repo.cloneUrl.replace('https://', `https://${options.token}@`);
+                    await git.remote(['set-url', 'origin', authenticatedUrl.trim()]);
+                    needsRestore = true;
+                }
+                try {
+                    await git.pull('origin', 'main').catch(async () => {
+                        // Try master if main fails
+                        await git.pull('origin', 'master');
+                    });
+                }
+                finally {
+                    // Restore original URL without token
+                    if (needsRestore && originalUrl) {
+                        await git.remote(['set-url', 'origin', originalUrl]);
+                    }
+                }
                 repoSpinner.succeed(`${progress} ${chalk_1.default.green('✓')} Updated ${chalk_1.default.white(repo.name)}`);
                 return { status: 'updated' };
             }
@@ -66,9 +85,19 @@ async function cloneOrUpdateRepo(repo, repoPath, options, progress, index, total
         }
         else {
             repoSpinner.text = `${progress} Cloning ${repo.name}...`;
-            const cloneUrl = options.method === 'ssh' ? repo.sshUrl : repo.cloneUrl;
+            let cloneUrl = options.method === 'ssh' ? repo.sshUrl : repo.cloneUrl;
+            // Inject token into HTTPS URL for private repos
+            if (options.token && options.method === 'https') {
+                cloneUrl = cloneUrl.replace('https://', `https://${options.token}@`);
+            }
             const parentDir = path.dirname(repoPath);
             await (0, simple_git_1.default)(parentDir).clone(cloneUrl, repoPath);
+            // Remove token from git config after clone for security
+            if (options.token && options.method === 'https') {
+                const git = (0, simple_git_1.default)(repoPath);
+                const cleanUrl = cloneUrl.replace(/https:\/\/[^@]+@/, 'https://').trim();
+                await git.remote(['set-url', 'origin', cleanUrl]);
+            }
             repoSpinner.succeed(`${progress} ${chalk_1.default.green('✓')} Cloned ${chalk_1.default.white(repo.name)}`);
             return { status: 'cloned' };
         }

package/dist/cli.js

@@ -285,7 +285,7 @@ function createScheduleCommands(program) {
         .option('-f, --frequency <freq>', 'Backup frequency: hourly, daily, weekly, monthly', 'weekly')
         .option('-t, --time <time>', 'Time for daily/weekly/monthly (HH:MM format)', '02:00')
         .option('-d, --day <day>', 'Day of week for weekly (0-6, 0=Sunday)', '0')
-        .option('-u, --update', 'Only update existing repos (faster)', false)
+        .option('--full', 'Clone all repos instead of updating existing (default: update existing)', false)
         .option('-l, --log <path>', 'Log file path', '~/.gitlo/backup.log')
         .action((cmdOptions) => {
         const { addCronJob, getCronExpression, formatSchedule } = require('./cron.js');
@@ -293,12 +293,12 @@ function createScheduleCommands(program) {
             frequency: cmdOptions.frequency,
             time: cmdOptions.time,
             dayOfWeek: parseInt(cmdOptions.day),
-            updateOnly: cmdOptions.update,
+            updateOnly: !cmdOptions.full,
         };
         const logFile = cmdOptions.log.replace(/^~/, require('os').homedir());
         console.log(chalk_1.default.bold.blue('\n📅 Schedule Automatic Backups\n'));
         console.log(chalk_1.default.gray(`Frequency: ${formatSchedule(schedule)}`));
-        console.log(chalk_1.default.gray(`Update only: ${cmdOptions.update ? 'Yes' : 'No (full backup)'}`));
+        console.log(chalk_1.default.gray(`Update only: ${!cmdOptions.full ? 'Yes (default)' : 'No (full backup)'}`));
         console.log(chalk_1.default.gray(`Log file: ${logFile}\n`));
         if (addCronJob(schedule, logFile)) {
             console.log(chalk_1.default.green('✓ Automatic backup scheduled successfully!'));

package/dist/cron.js

@@ -48,7 +48,6 @@ const fs = __importStar(require("fs"));
 const path = __importStar(require("path"));
 const os = __importStar(require("os"));
 const chalk_1 = __importDefault(require("chalk"));
-const config_manager_js_1 = require("./config-manager.js");
 const CRON_COMMENT = '# gitlo-auto-backup';
 function getCronExpression(schedule) {
     switch (schedule.frequency) {
@@ -71,9 +70,13 @@ function getCronExpression(schedule) {
     }
 }
 function getCronCommand(updateOnly = false) {
-    const config = (0, config_manager_js_1.readConfig)();
-    const gitloPath = (0, child_process_1.execSync)('which gitlo', { encoding: 'utf-8' }).trim() || 'gitlo';
-    let command = `${gitloPath}`;
+    // Use full path to node and the built JS file for cron compatibility
+    // Cron has limited PATH, so we can't rely on wrapper scripts
+    const nodePath = (0, child_process_1.execSync)('which node', { encoding: 'utf-8' }).trim();
+    // Get the path to dist/index.js from the current file location
+    // After compilation, this file is at dist/cron.js, so we need index.js in the same dir
+    const scriptPath = path.join(path.dirname(__filename), 'index.js');
+    let command = `${nodePath} ${scriptPath}`;
     // Add update flag if specified
     if (updateOnly) {
         command += ' --update';

package/dist/index.js

@@ -3,11 +3,13 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 const commander_1 = require("commander");
 const cli_js_1 = require("./cli.js");
+// eslint-disable-next-line @typescript-eslint/no-var-requires
+const packageJson = require('../package.json');
 const program = new commander_1.Command();
 program
     .name('gitlo')
     .description('CLI tool to backup all your GitHub repositories locally')
-    .version('1.0.0');
+    .version(packageJson.version);
 // Config subcommands
 (0, cli_js_1.createConfigCommands)(program);
 // Schedule subcommands

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "gitlo",
-  "version": "1.0.0",
+  "version": "1.0.2",
   "description": "CLI tool to backup all your GitHub repositories locally",
   "main": "dist/index.js",
   "bin": {
@@ -16,7 +16,9 @@
     "start": "node dist/index.js",
     "dev": "ts-node src/index.ts",
     "clean": "rm -rf dist node_modules",
-    "prepublishOnly": "pnpm run build"
+    "prepublishOnly": "pnpm run build",
+    "link": "pnpm run build && pnpm link --global",
+    "unlink": "pnpm unlink --global && rm -f $(which gitlo 2>/dev/null || echo /dev/null)"
   },
   "keywords": [
     "github",
@@ -34,7 +36,7 @@
   "bugs": {
     "url": "https://github.com/dropocol/gitlo/issues"
   },
-  "packageManager": "pnpm@9.10.0",
+  "packageManager": "pnpm@10.33.0",
   "engines": {
     "node": ">=18.0.0"
   },