packup-cli 1.2.0 → 1.2.1

package/README.md

@@ -0,0 +1,145 @@
+# packup-cli
+
+Pack folders into portable, integrity-verified strings. Supports encryption for secure sharing.
+
+## How it works
+
+### Pack Flow
+
+```text
+┌─────────────┐     ┌─────────────┐     ┌─────────────┐     ┌─────────────┐
+│   Folder    │────▶│  ZIP Buffer │────▶│   Base64    │────▶│  PACKUP:1:  │
+│  ./src/*    │     │  (in memory)│     │   encode    │     │  hash:data  │
+└─────────────┘     └─────────────┘     └─────────────┘     └─────────────┘
+```
+
+### Encrypted Pack Flow
+
+```text
+┌─────────────┐     ┌─────────────┐     ┌─────────────┐     ┌─────────────┐     ┌─────────────┐
+│   Folder    │────▶│  ZIP Buffer │────▶│  AES-256   │────▶│   Base64    │────▶│  PACKUP:2:  │
+│  ./src/*    │     │  (in memory)│     │  encrypt    │     │   encode    │     │  hash:data  │
+└─────────────┘     └─────────────┘     └─────────────┘     └─────────────┘     └─────────────┘
+                                               │
+                                        ┌──────┴──────┐
+                                        │  Password   │
+                                        │  + PBKDF2   │
+                                        └─────────────┘
+```
+
+### Unpack Flow
+
+```text
+┌─────────────┐     ┌─────────────┐     ┌─────────────┐     ┌─────────────┐
+│  PACKUP:1:  │────▶│   Verify    │────▶│   Base64    │────▶│   Extract   │
+│  hash:data  │     │  SHA-256    │     │   decode    │     │   to disk   │
+└─────────────┘     └─────────────┘     └─────────────┘     └─────────────┘
+```
+
+## Installation
+
+```bash
+npm install -g packup-cli
+```
+
+## CLI Usage
+
+### Pack a folder
+
+```bash
+# Pack to clipboard
+packup pack ./my-folder
+
+# Pack to file
+packup pack ./my-folder -o packed.txt
+
+# Pack with encryption
+packup pack ./my-folder -e
+```
+
+### Unpack
+
+```bash
+# Unpack from clipboard
+packup unpack ./destination
+
+# Unpack from file
+packup unpack ./destination -i packed.txt
+```
+
+If the packed string is encrypted, you'll be prompted for the password.
+
+### Info
+
+```bash
+# Show info from clipboard
+packup info
+
+# Show info from file
+packup info -i packed.txt
+```
+
+## Encryption
+
+Use the `-e` flag to encrypt with AES-256-CBC:
+
+```bash
+packup pack ./secret-folder -e
+```
+
+Features:
+
+- AES-256-CBC encryption
+- PBKDF2 key derivation (100,000 iterations)
+- SHA-256 integrity verification
+- Cross-compatible with the bash version
+
+## AI Agent / Automation
+
+For non-interactive use, set the `PACKUP_PASSWORD` environment variable:
+
+```bash
+export PACKUP_PASSWORD="mysecretpassword"
+packup pack ./folder -e -o packed.txt
+packup unpack ./dest -i packed.txt
+```
+
+## API Usage
+
+```javascript
+import { pack, unpack, info, isEncrypted } from 'packup-cli';
+
+// Pack a folder
+const packedString = await pack('./my-folder');
+
+// Pack with encryption
+const encrypted = await pack('./my-folder', { password: 'secret' });
+
+// Check if encrypted
+if (isEncrypted(packedString)) {
+  console.log('This package is encrypted');
+}
+
+// Unpack
+await unpack(packedString, './destination');
+await unpack(encrypted, './destination', { password: 'secret' });
+
+// Get info
+const metadata = await info(packedString);
+console.log(metadata.files);
+```
+
+## Format
+
+Packup strings follow this format:
+
+```text
+PACKUP:<version>:<sha256-hash>:<base64-data>
+```
+
+- Version 1: Unencrypted
+- Version 2: Encrypted (AES-256-CBC)
+
+## License
+
+MIT

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "packup-cli",
-  "version": "1.2.0",
+  "version": "1.2.1",
   "description": "Pack folders into portable, integrity-verified strings",
   "type": "module",
   "bin": {
@@ -23,5 +23,8 @@
     "archiver": "^7.0.0",
     "adm-zip": "^0.5.0",
     "clipboardy": "^4.0.0"
+  },
+  "overrides": {
+    "glob": "^13.0.0"
   }
 }