gitshift 2.1.1 → 2.3.0

package/README.md

@@ -39,6 +39,48 @@ gitshift --help
 - `gitshift remove <profile>` - Delete a saved profile.
 - `gitshift scan` - Scan your `~/.ssh` folder and import existing SSH keys into new profiles.
 - `gitshift doctor` - Check whether Git, SSH, and GitHub CLI are installed.
+ - `gitshift backup [file]` - Export profiles, folder mappings, and current profile to a JSON backup file (default: `gitshift-backup.json`).
+ - `gitshift restore <file>` - Restore profiles and mappings from a previously created backup JSON file (prompts to confirm overwrite).
+ - `gitshift update` - Update GitShift to the latest version or manage automatic update checks.
+
+- `gitshift link <folder>` - Link a local folder to a profile (prompts to select or create a profile).
+- `gitshift unlink <folder>` - Remove an existing folder mapping.
+- `gitshift links` - List folder → profile mappings.
+- `gitshift auto` - Auto-switch profile based on the current working directory and configured folder mappings.
+
+### Add Command
+
+- **Interactive prompts**: `Profile Name`, `GitHub Username`, `Email` (all required).
+- **SSH key generation**: prompts `Generate SSH key automatically?` (default: **yes**). If accepted, an SSH key is generated and saved under `~/.ssh` with the pattern `gitshift-<profile-name>`.
+- **Validation**: profile names must be unique; empty values for name, username, or email are rejected.
+- **Cancelation**: pressing Ctrl+C during prompts exits gracefully and cancels creation.
+
+### Folder mappings
+
+- `gitshift link <folder>`: associates a local folder path with a profile. If no profiles exist, you'll be prompted to create one; otherwise you can pick an existing profile or create a new one. Linking stores an absolute path mapping so GitShift can detect and switch profiles when you `cd` into that folder.
+- `gitshift unlink <folder>`: removes the mapping for the given folder path.
+- `gitshift links`: prints all configured folder mappings in the form `profile → /absolute/path`.
+
+Example linking a folder
+
+```bash
+$ gitshift link ~/projects/my-repo
+Select Profile: personal
+Linked /Users/akashs/projects/my-repo
+Profile: personal
+```
+
+### Auto switching
+
+- `gitshift auto` checks the current working directory against your configured folder mappings. If a matching mapping is found, GitShift will set the Git user (`user.name` and `user.email`) and mark the matched profile as current.
+
+Run `gitshift auto` inside a linked folder (or any child path) to switch automatically:
+
+```bash
+$ cd ~/projects/my-repo
+$ gitshift auto
+Switched to personal
+```
 
 ## Example Workflow
 
@@ -46,6 +88,7 @@ gitshift --help
 gitshift add
 gitshift list
 gitshift scan
+gitshift backup
 gitshift use personal
 gitshift current
 gitshift doctor
@@ -55,6 +98,57 @@ When you create a profile and choose SSH generation, GitShift creates a key unde
 
 If you already have SSH keys on your machine, `gitshift scan` will list the available keys, let you pick one, and save it as a new imported profile.
 
+Interactive `add` example
+
+```bash
+$ gitshift add
+Profile Name: personal
+GitHub Username: akash
+Email: akash@example.com
+Generate SSH key automatically? (Y/n) [Y]
+```
+
+### Backup & Restore
+
+- `gitshift backup [file]` writes a JSON file containing your saved profiles, folder mappings, and the currently selected profile. If no file is provided it defaults to `gitshift-backup.json` in your current directory.
+
+Example backup:
+
+```bash
+$ gitshift backup
+Backup saved to /Users/akashs/gitshift-backup.json
+```
+
+- `gitshift restore <file>` reads the JSON backup and restores profiles and mappings. It prompts to confirm overwriting existing data.
+
+Example restore:
+
+```bash
+$ gitshift restore gitshift-backup.json
+This will overwrite current data. Continue? (y/N)
+Backup restored
+```
+
+### Update Command
+
+- `gitshift update` updates GitShift to the latest published version (runs `npm install -g gitshift@latest`).
+- Options:
+	- `--enable-auto` — enable automatic update checks.
+	- `--disable-auto` — disable automatic update checks.
+
+Examples:
+
+```bash
+# Update GitShift to latest
+$ gitshift update
+
+# Enable automatic update checks
+$ gitshift update --enable-auto
+
+# Disable automatic update checks
+$ gitshift update --disable-auto
+```
+
 ## How It Works
 
 Profiles are saved locally on your machine using the app's configuration store. Switching profiles updates your global Git identity with:

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "gitshift",
-  "version": "2.1.1",
+  "version": "2.3.0",
   "description": "GitHub Account Switcher CLI",
   "main": "server.js",
   "bin": {

package/src/commands/backup.js

@@ -0,0 +1,29 @@
+import fs from "fs-extra";
+import path from "path";
+import { getCurrentProfile, getFolderMappings, getProfiles } from "../services/profile.js";
+import { error, success } from "../utils/logger.js";
+
+export async function backupCommand(fileName = "gitshift-backup.json") {
+    try {
+        const backup = {
+            profiles: getProfiles(),
+            folderMappings: getFolderMappings(),
+            currentProfile: getCurrentProfile(),
+            createdAt: new Date().toISOString(),
+        };
+
+        const filePath = path.resolve(fileName);
+
+        await fs.writeJson(
+            filePath,
+            backup,
+            {
+                spaces: 2,
+            }
+        );
+
+        success(`Backup saved to ${filePath}`);
+    } catch (err) {
+        error(err.message);
+    }
+}

package/src/commands/restore.js

@@ -0,0 +1,33 @@
+import { confirm } from "@inquirer/prompts";
+import fs from "fs-extra";
+import path from "path";
+import { restoreData } from "../services/profile.js";
+import { error, success } from "../utils/logger.js";
+
+export async function restoreCommand(file) {
+    try {
+        const filePath = path.resolve(file);
+        const exists = await fs.pathExists(filePath);
+
+        if (!exists) {
+            error("Backup file not found");
+            return;
+        }
+
+        const overwrite = await confirm({
+            message: "This will overwrite current data. Continue?",
+            default: false,
+        });
+
+        if (!overwrite) {
+            return;
+        }
+
+        const backup = await fs.readJson(filePath);
+        restoreData(backup);
+
+        success("Backup restored");
+    } catch (err) {
+        error(err.message);
+    }
+}

package/src/commands/update.js

@@ -0,0 +1,40 @@
+import { execa } from "execa";
+import ora from "ora";
+import { updateSettings } from "../services/profile.js";
+import { error, success } from "../utils/logger.js";
+
+export async function updateCommand(options) {
+    if (options.enableAuto) {
+        updateSettings({ autoUpdate: true, });
+        success("Auto update enabled");
+        return;
+    }
+
+    if (options.disableAuto) {
+        updateSettings({ autoUpdate: false });
+        success("Auto update disabled");
+        return;
+    }
+
+    const spinner = ora("Updating GitShift...").start();
+
+    try {
+        await execa(
+            "npm",
+            [
+                "install",
+                "-g",
+                "gitshift@latest",
+            ],
+            {
+                stdio:
+                    "inherit",
+            }
+        );
+
+        spinner.succeed("GitShift updated");
+    } catch (err) {
+        spinner.fail("Update failed");
+        error(err.message);
+    }
+}

package/src/server.js

@@ -6,14 +6,17 @@ import { Command } from "commander";
 import { createRequire } from "node:module";
 import { addCommand } from "./commands/add.js";
 import { autoCommand } from "./commands/auto.js";
+import { backupCommand } from "./commands/backup.js";
 import { currentCommand } from "./commands/current.js";
 import { doctorCommand } from "./commands/doctor.js";
 import { linkCommand } from "./commands/link.js";
 import { linksCommand } from "./commands/links.js";
 import { listCommand } from "./commands/list.js";
 import { removeCommand } from "./commands/remove.js";
+import { restoreCommand } from "./commands/restore.js";
 import { scanCommand } from "./commands/scan.js";
 import { unlinkCommand } from "./commands/unlink.js";
+import { updateCommand } from "./commands/update.js";
 import { useCommand } from "./commands/use.js";
 
 const require = createRequire(import.meta.url);
@@ -163,6 +166,36 @@ async function main() {
         )
         .action(doctorCommand);
 
+    program
+        .command("backup")
+        .description(
+            "Backup profiles and mappings"
+        )
+        .argument("[file]")
+        .action(backupCommand);
+
+    program
+        .command("restore")
+        .description(
+            "Restore backup"
+        )
+        .argument("<file>")
+        .action(restoreCommand);
+    program
+        .command("update")
+        .description(
+            "Update GitShift"
+        )
+        .option(
+            "--enable-auto",
+            "Enable automatic update checks"
+        )
+        .option(
+            "--disable-auto",
+            "Disable automatic update checks"
+        )
+        .action(updateCommand);
+
     program.exitOverride();
 
     try {

package/src/services/profile.js

@@ -83,4 +83,30 @@ export function addFolderMapping(profile, folderPath) {
 export function removeFolderMapping(folderPath) {
     const mappings = getFolderMappings();
     config.set("folderMappings", mappings.filter((item) => item.path !== folderPath));
+}
+
+export function restoreData(data) {
+
+    config.set("profiles", data.profiles || []);
+    config.set("folderMappings", data.folderMappings || []);
+
+    if (data.currentProfile) {
+        config.set("current", data.currentProfile);
+    }
+}
+
+export function getSettings() {
+    return config.get("settings", {
+        autoUpdate: false,
+        lastUpdateCheck: null,
+    });
+}
+
+export function updateSettings(settings) {
+    const current = getSettings();
+
+    config.set("settings", {
+        ...current,
+        ...settings,
+    });
 }

package/src/services/update.js

@@ -0,0 +1,39 @@
+import { execa } from "execa";
+import { getSettings, updateSettings } from "./profile.js";
+
+const DAY =
+    24 *
+    60 *
+    60 *
+    1000;
+
+export async function checkForUpdates() {
+    const settings = getSettings();
+
+    if (!settings.autoUpdate) {
+        return;
+    }
+
+    const lastCheck = settings.lastUpdateCheck;
+
+    if (lastCheck && Date.now() - new Date(lastCheck).getTime() < DAY) {
+        return;
+    }
+
+    try {
+        const { stdout, } = await execa(
+            "npm",
+            [
+                "view",
+                "gitshift",
+                "version",
+            ]
+        );
+
+        updateSettings({ lastUpdateCheck: new Date().toISOString() });
+
+        return stdout.trim();
+    } catch {
+        return null;
+    }
+}