agentshield 0.0.3 → 0.0.4

package/README.md

@@ -22,9 +22,13 @@ A workspace history version management tool that protects your workspace from un
 npm install -g agentshield
 ```
 
-### Download Binary
+### Via Binary 
 
-Download the binary for your platform from the [Releases](https://github.com/tomsun28/agentshield/releases) page (supports Windows, macOS, Linux).
+```bash
+curl -fsSL https://github.com/tomsun28/agentshield/raw/main/install.sh | bash
+```
+
+Or download the executable binary for your platform from the [Releases](https://github.com/tomsun28/agentshield/releases) page (supports Windows, macOS, Linux).
 
 ## 📖 Usage
 
@@ -54,63 +58,16 @@ shield stop ./my-project
 shield status
 ```
 
-### Exec Mode (Recommended for Agent Tasks)
-
-```bash
-# Snapshot workspace, run command, then allow easy restore
-shield exec -- npm run agent-task
-shield exec -- python ai_script.py
-shield exec --path=./my-project -- cargo run
-```
-
-This mode:
-1. Takes a full snapshot before the command runs
-2. Executes your agent command
-3. Allows you to easily restore any modified files
-
-### One-time Snapshot
-
-```bash
-# Take a snapshot of current directory
-shield snapshot
-
-# Take a snapshot of specific directory  
-shield snapshot ./my-project
-```
-
 ### Restore Files
 
 ```bash
-# List all backups with timestamps (use for --time option)
+# List all backups with snapshot ID
 shield list
-# Restore all files to most recent backup
-shield restore
-
-# Restore only a specific file to its latest backup
-shield restore --file=src/index.ts
-
-# Restore all files to a specific timestamp
-shield restore --time=1737216000000
-
-# Restore a specific file to a specific timestamp
-shield restore --file=src/index.ts --time=1737216000000
 
+# Restore a specific snapshot by ID
+shield restore --id=<snapshot_id>
 ```
 
-### List Backups
-
-```bash
-# List all backups with details including timestamps
-shield list
-```
-
-The `list` command shows:
-- File path with event type icon (📄 changed, 🗑️ deleted, 📝 renamed)
-- Time ago and file size
-- Exact timestamp (for use with `--time` option)
-- ISO date string
-- Rename history (if applicable)
-
 ### Status and Cleanup
 
 ```bash

package/dist/backup.d.ts

@@ -1,78 +1,101 @@
 import { ShieldConfig } from "./config.js";
-export type FileEventType = "change" | "delete" | "rename";
-export interface BackupEntry {
-    originalPath: string;
+export type FileEventType = "change" | "delete" | "rename" | "create";
+export interface SnapshotFile {
+    path: string;
     backupPath: string;
-    timestamp: number;
     size: number;
-    sessionId: string;
-    eventType?: FileEventType;
-    renamedFrom?: string;
+    eventType: FileEventType;
     renamedTo?: string;
 }
+export interface Snapshot {
+    id: string;
+    timestamp: number;
+    files: SnapshotFile[];
+    message?: string;
+}
 export interface BackupIndex {
-    entries: BackupEntry[];
-    sessions: {
-        [sessionId: string]: {
-            startTime: number;
-            endTime?: number;
-        };
-    };
+    version: number;
+    snapshots: Snapshot[];
 }
 export declare class BackupManager {
     private config;
     private snapshotsDir;
     private indexPath;
     private index;
-    private currentSessionId;
-    private protectedInSession;
     constructor(config: ShieldConfig);
     private ensureVaultExists;
     private loadIndex;
     private saveIndex;
     shouldExclude(filePath: string): boolean;
-    backupFile(relativePath: string, forceFullCopy?: boolean, eventType?: FileEventType, renamedFrom?: string): BackupEntry | null;
-    backupDeletedFile(relativePath: string, content: Buffer): BackupEntry | null;
-    backupRenamedFile(oldPath: string, newPath: string, content: Buffer): BackupEntry | null;
+    /**
+     * Create snapshot - Package multiple file changes into one snapshot
+     */
+    createSnapshot(files: Array<{
+        relativePath: string;
+        eventType: FileEventType;
+        content?: Buffer;
+        renamedTo?: string;
+    }>, message?: string): Snapshot | null;
+    /**
+     * Get all snapshots, sorted by time in descending order
+     */
+    getAllSnapshots(): Snapshot[];
+    /**
+     * Get snapshot by ID
+     */
+    getSnapshotById(snapshotId: string): Snapshot | null;
+    /**
+     * Get snapshot by timestamp
+     */
+    getSnapshotByTimestamp(timestamp: number): Snapshot | null;
+    /**
+     * Get all backup versions of a file
+     */
+    getFileHistory(relativePath: string): Array<{
+        snapshot: Snapshot;
+        file: SnapshotFile;
+    }>;
+    /**
+     * Get latest backup content of a file
+     */
     getLatestBackupContent(relativePath: string): {
         content: Buffer;
         timestamp: number;
     } | null;
-    snapshotWorkspace(): {
-        total: number;
-        backed: number;
-        skipped: number;
-    };
-    resetSession(): void;
-    getBackupsForFile(relativePath: string): BackupEntry[];
-    getAllBackups(): BackupEntry[];
-    restoreFile(entry: BackupEntry): boolean;
-    restoreLatest(relativePath: string): boolean;
-    restoreAllLatest(): {
+    /**
+     * Restore snapshot - Batch restore all files in snapshot
+     */
+    restoreSnapshot(snapshotId: string): {
         restored: number;
         failed: number;
         deleted: number;
     };
-    restoreToTime(targetTimestamp: number): {
+    /**
+     * Restore to snapshot at specified timestamp
+     */
+    restoreToSnapshot(timestamp: number): {
         restored: number;
         failed: number;
         deleted: number;
     };
-    restoreFileToTime(relativePath: string, targetTimestamp: number): boolean;
-    getBackupByTimestamp(timestamp: number): BackupEntry | null;
-    getUniqueTimestamps(): number[];
-    restoreSession(sessionId: string): {
-        restored: number;
-        failed: number;
-    };
-    cleanOldBackups(maxAgeDays: number): {
+    /**
+     * Restore single file to latest backup
+     */
+    restoreFile(relativePath: string): boolean;
+    /**
+     * Clean old snapshots
+     */
+    cleanOldSnapshots(maxAgeDays: number): {
         removed: number;
         freedBytes: number;
     };
+    /**
+     * Get statistics
+     */
     getStats(): {
-        totalBackups: number;
+        snapshots: number;
+        totalFiles: number;
         totalSize: number;
         uniqueFiles: number;
-        sessions: number;
     };
 }