backdot 1.6.1 → 1.7.0

package/README.md

@@ -10,7 +10,7 @@
 
 ```bash
 npm install -g backdot
-backdot --init
+backdot init
 ```
 
 This creates `~/.backdot.json` with sensible defaults and walks you through setup. Open the config file and set your repository URL and the files you want backed up:
@@ -26,13 +26,13 @@ This creates `~/.backdot.json` with sensible defaults and walks you through setu
 Run your first backup:
 
 ```bash
-backdot --backup
+backdot backup
 ```
 
 or configure the backport process to run automatically (daily at 2am)
 
 ```bash
-backdot --schedule
+backdot schedule
 ```
 
 ## Configuration
@@ -51,17 +51,17 @@ Prefix a pattern with `!` to exclude matching files:
 
 ## Commands
 
-| Command                          | Description                                    |
-| -------------------------------- | ---------------------------------------------- |
-| `--init`                         | Set up backdot for the first time              |
-| `--backup`                       | Run a backup now                               |
-| `--restore`                      | Restore latest backup from the configured repo |
-| `--restore <url>`                | Restore from a specific repo URL               |
-| `--restore [url] --commit <sha>` | Restore from a specific backup commit          |
-| `--history [url]`                | Browse and restore a previous backup           |
-| `--schedule`                     | Schedule automatic daily backup (Mac-only)     |
-| `--unschedule`                   | Unschedule the daily backup                    |
-| `--status`                       | Show schedule and resolved file list           |
+| Command                        | Description                                    |
+| ------------------------------ | ---------------------------------------------- |
+| `init`                         | Set up backdot for the first time              |
+| `backup`                       | Run a backup now                               |
+| `restore`                      | Restore latest backup from the configured repo |
+| `restore <url>`                | Restore from a specific repo URL               |
+| `restore [url] --commit <sha>` | Restore from a specific backup commit          |
+| `history [url]`                | Browse and restore a previous backup           |
+| `schedule`                     | Schedule automatic daily backup (Mac-only)     |
+| `unschedule`                   | Unschedule the daily backup                    |
+| `status`                       | Show schedule and resolved file list           |
 
 ## Development
 

package/dist/cli.js

@@ -1,7 +1,7 @@
 #!/usr/bin/env node
 import fs from "node:fs";
 import path from "node:path";
-import { parseArgs } from "node:util";
+import cac from "cac";
 import chalk from "chalk";
 import { CONFIG_PATH } from "./config.js";
 import { backup } from "./commands/backup.js";
@@ -23,86 +23,40 @@ function getVersion() {
         return "unknown";
     }
 }
-function printHelp() {
-    console.log();
-    console.log("  Usage: backdot <command>");
-    console.log();
-    console.log("  Commands:");
-    console.log();
-    console.log("    --init                       Set up backdot for the first time");
-    console.log("    --backup                     Run a backup now");
-    console.log("    --restore [url]              Restore files from the backup repo");
-    console.log("    --restore [url] --commit <sha>  Restore from a specific backup commit");
-    console.log("    --restore [url] --yes (-y)      Accept defaults without prompting");
-    console.log("    --history [url]              Browse and restore a previous backup");
-    console.log("    --schedule                   Install daily backup schedule (macOS launchd)");
-    console.log("    --unschedule                 Remove the daily backup schedule");
-    console.log("    --status                     Show schedule and resolved files");
-    console.log("    --version                    Show version");
-    console.log();
-}
-async function main() {
-    let values;
-    let positionals;
-    try {
-        ({ values, positionals } = parseArgs({
-            args: process.argv.slice(2),
-            options: {
-                init: { type: "boolean" },
-                backup: { type: "boolean" },
-                restore: { type: "boolean" },
-                history: { type: "boolean" },
-                schedule: { type: "boolean" },
-                unschedule: { type: "boolean" },
-                status: { type: "boolean" },
-                version: { type: "boolean" },
-                help: { type: "boolean" },
-                commit: { type: "string" },
-                yes: { type: "boolean", short: "y" },
-            },
-            allowPositionals: true,
-            strict: true,
-        }));
-    }
-    catch (err) {
-        console.error(`\n  Error: ${errorMessage(err)}\n`);
-        printHelp();
-        process.exit(1);
+const cli = cac("backdot");
+cli.command("init", "Set up backdot for the first time").action(() => init());
+cli.command("backup", "Run a backup now").action(async () => {
+    await backup();
+});
+cli
+    .command("restore [url]", "Restore files")
+    .option("--commit <sha>", "Restore from a specific backup commit")
+    .option("-y, --yes", "Accept defaults without prompting")
+    .action(async (url, options) => {
+    await restore({ repoUrl: url, commit: options.commit, yes: !!options.yes });
+});
+cli
+    .command("history [url]", "List and restore a previous backup")
+    .action(async (url) => {
+    await history(url);
+});
+cli.command("schedule", "Schedule daily backup").action(() => schedule());
+cli.command("unschedule", "Unschedule the daily backup").action(() => unschedule());
+cli.command("status", "Show the status of the backup").action(async () => {
+    await status();
+});
+cli.command("", "").action(() => {
+    cli.outputHelp();
+    if (!fs.existsSync(CONFIG_PATH)) {
+        console.log(`  No config found. Run ${chalk.bold("backdot init")} to get started.\n`);
     }
+});
+cli.help();
+cli.version(getVersion());
+async function main() {
     try {
-        if (values.init) {
-            init();
-        }
-        else if (values.backup) {
-            await backup();
-        }
-        else if (values.schedule) {
-            schedule();
-        }
-        else if (values.unschedule) {
-            unschedule();
-        }
-        else if (values.status) {
-            await status();
-        }
-        else if (values.restore) {
-            await restore(positionals[0], values.commit, {
-                yes: !!values.yes,
-            });
-        }
-        else if (values.history) {
-            await history(positionals[0]);
-        }
-        else if (values.version) {
-            console.log(getVersion());
-        }
-        else {
-            printHelp();
-            if (!fs.existsSync(CONFIG_PATH)) {
-                console.log(`  No config found. Run ${chalk.bold("backdot --init")} to get started.`);
-                console.log();
-            }
-        }
+        cli.parse(process.argv, { run: false });
+        await cli.runMatchedCommand();
     }
     catch (err) {
         const msg = errorMessage(err);

package/dist/commands/history.js

@@ -22,7 +22,7 @@ export async function history(repoUrl) {
         console.log("\n  No backup history found.\n");
         return;
     }
-    const selected = await select({
+    const selectedCommit = await select({
         message: "Select a backup to restore from:",
         loop: false,
         choices: commits.map((c) => ({
@@ -31,5 +31,5 @@ export async function history(repoUrl) {
         })),
     });
     console.log();
-    await restore(repoUrl, selected);
+    await restore({ repoUrl, commit: selectedCommit });
 }

package/dist/commands/init.js

@@ -50,8 +50,8 @@ export function init() {
     // Step 3
     console.log(chalk.bold("  Step 3 — Run your first backup"));
     console.log();
-    console.log(`    ${chalk.bold("backdot --backup")}          Run a one-time backup`);
-    console.log(`    ${chalk.bold("backdot --schedule")}        Schedule daily backups (macOS)`);
-    console.log(`    ${chalk.bold("backdot --status")}          Check which files will be backed up`);
+    console.log(`    ${chalk.bold("backdot backup")}            Run a one-time backup`);
+    console.log(`    ${chalk.bold("backdot schedule")}          Schedule daily backups (macOS)`);
+    console.log(`    ${chalk.bold("backdot status")}            Check which files will be backed up`);
     console.log();
 }

package/dist/commands/restore.d.ts

@@ -1,5 +1,5 @@
-interface RestoreOptions {
+export declare function restore({ repoUrl, commit, yes, }?: {
+    repoUrl?: string;
+    commit?: string;
     yes?: boolean;
-}
-export declare function restore(repoUrl?: string, commit?: string, options?: RestoreOptions): Promise<void>;
-export {};
+}): Promise<void>;

package/dist/commands/restore.js

@@ -58,7 +58,7 @@ async function resolveRepoAndMachine(repoUrl, commit) {
     }
     return { repository: repoUrl, machine };
 }
-export async function restore(repoUrl, commit, options = {}) {
+export async function restore({ repoUrl, commit, yes, } = {}) {
     logger.info("Starting restore");
     const { repository, machine } = await resolveRepoAndMachine(repoUrl, commit);
     const spinner = ora("Fetching latest backup").start();
@@ -102,7 +102,7 @@ export async function restore(repoUrl, commit, options = {}) {
     spinner.stop();
     console.log();
     let toRestore;
-    if (options.yes) {
+    if (yes) {
         toRestore = fresh;
         if (existing.length > 0) {
             console.log(`  Skipped ${pluralize(existing.length, "existing file")}. Run without --yes to select them.`);

package/dist/commands/status.js

@@ -13,7 +13,7 @@ function tildePath(filePath) {
 export async function status() {
     const scheduled = isScheduled();
     console.log();
-    console.log(`  Schedule:  ${scheduled ? "active (daily at 02:00)" : `not active  (run ${chalk.bold("backdot --schedule")} to enable)`}`);
+    console.log(`  Schedule:  ${scheduled ? "active (daily at 02:00)" : `not active  (run ${chalk.bold("backdot schedule")} to enable)`}`);
     const config = loadConfig();
     console.log(`  Repo:      ${config.repository}`);
     console.log(`  Machine:   ${config.machine}`);
@@ -59,7 +59,7 @@ export async function status() {
                 }
                 console.log();
             }
-            console.log(`  Run ${chalk.bold("backdot --backup")} to back up all changes.`);
+            console.log(`  Run ${chalk.bold("backdot backup")} to back up all changes.`);
         }
     }
     catch (err) {

package/dist/config.js

@@ -21,7 +21,7 @@ const ConfigSchema = z.object({
 });
 export function loadConfig() {
     if (!fs.existsSync(CONFIG_PATH)) {
-        throw new Error(`Config file not found: ${CONFIG_PATH}\n  Run "backdot --init" to create it.`);
+        throw new Error(`Config file not found: ${CONFIG_PATH}\n  Run "backdot init" to create it.`);
     }
     let raw;
     try {

package/dist/launchd.js

@@ -33,7 +33,7 @@ function buildPlist() {
   <array>
     <string>${escapeXml(nodePath)}</string>
     <string>${escapeXml(scriptPath)}</string>
-    <string>--backup</string>
+    <string>backup</string>
   </array>
   <key>WorkingDirectory</key>
   <string>${escapeXml(workingDir)}</string>

package/dist/staging.js

@@ -47,7 +47,7 @@ export async function compareFiles(files, machine, repository) {
         return { backedUp: [], modified: [], notBackedUp: [] };
     }
     if (!fs.existsSync(STAGING_GIT_DIR)) {
-        return failedComparisonResult(new Error("Backup repository not found. Run backdot --backup first."));
+        return failedComparisonResult(new Error('Backup repository not found. Run "backdot backup" first.'));
     }
     const git = simpleGit(STAGING_DIR);
     try {
@@ -113,7 +113,7 @@ This repository contains files backed up automatically using [backdot](https://g
 ## Restore
 
 \`\`\`bash
-npx backdot --restore ${repository}
+npx backdot restore ${repository}
 \`\`\`
 
 For full documentation, configuration options, and scheduling, see the [official README](https://github.com/sorenlouv/backdot).

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "backdot",
-  "version": "1.6.1",
+  "version": "1.7.0",
   "description": "Lightweight CLI to backup dotfiles and gitignored files to a Git repo on a daily schedule",
   "type": "module",
   "license": "MIT",
@@ -41,6 +41,7 @@
   },
   "dependencies": {
     "@inquirer/prompts": "^8.3.0",
+    "cac": "^7.0.0",
     "chalk": "^5.6.2",
     "fast-glob": "^3.3.3",
     "ora": "^9.3.0",