demo link; version info; better ingest

Author: velipso

README.md

@@ -8,13 +8,16 @@ delivery, and easily hosted on static blogs (Hugo, Jekyll, etc).
 You encrypt and manage your files locally, then deploy the encrypted vault. A lightweight
 browser-based app (included) allows in-browser decryption and previews of text and images.
 
+[Demo vault](https://sean.fun/staticvault-demo/) (password: `hello`).
+
 Features
 --------
 
-- 💾 Encrypt files locally
-- 🌐 Host anywhere: S3, Netlify, GitHub Pages, etc
-- 🖼️ In-browser decryption and preview for text/images
-- 🗂️ CLI for creating, ingesting, listing, and extracting files
+- Encrypt files locally
+- Host anywhere: S3, Netlify, GitHub Pages, etc
+- In-browser decryption and preview for text/images
+- Share a subset of your files/folders with friends (no server needed!)
+- CLI for creating, ingesting, listing, and extracting files
 
 Quick Start
 -----------
@@ -23,7 +26,7 @@ You don't need to install anything globally - just use `npx`:
 
 ```bash
 npx staticvault init path/to/vault
-npx staticvault ingest path/to/files path/to/vault
+npx staticvault ingest path/to/vault path/to/files
 ```
 
 Then upload the contents of `path/to/vault` to your static site host.
@@ -51,7 +54,7 @@ npx staticvault init <vault> [-p password] [-d difficulty]
 Encrypt and add files to an existing vault.
 
 ```bash
-npx staticvault ingest <source> <vault> [-p password]
+npx staticvault ingest <vault> <source> [-p password]
 ```
 
 ## `dump`
@@ -86,13 +89,21 @@ Run internal tests.
 npx staticvault test
 ```
 
+## `version`
+
+Output version
+
+```bash
+npx staticvault version
+```
+
 Example Workflow
 ----------------
 
 ```bash
-npx staticvault init myvault -p mypassword
-npx staticvault ingest ./blog-attachments myvault -p mypassword
-npx staticvault tree myvault -p mypassword
+npx staticvault init myvault
+npx staticvault ingest myvault ./blog-attachments
+npx staticvault tree myvault
 ```
 
 Then upload the contents of `myvault/` to your static host.

dist/cli.js

@@ -833,12 +833,12 @@ Current command:`);
   }
   if (!filter || filter === "ingest") {
     console.log(`
-- ingest <source> <vault> [-p password]
+- ingest <vault> <source> [-p password]
 
   Encrypt and copy source folders/files into vault
 
-  <source>         Source directory
   <vault>          Vault directory
+  <source>         Source directory
   [-p password]    Encryption password`);
   }
   if (!filter || filter === "init") {
@@ -876,6 +876,12 @@ Current command:`);
   <vault>          Vault directory
   [-p password]    Encryption password`);
   }
+  if (!filter || filter === "version") {
+    console.log(`
+- version
+
+  Output version of staticvault`);
+  }
 }
 function promptPassword(prompt) {
   const cmd = `read -s -p "${prompt}: " pwd && echo $pwd`;
@@ -968,8 +974,8 @@ Missing destination directory`);
   return 0;
 }
 async function cmdIngest(args) {
-  let source = null;
   let target = null;
+  let source = null;
   let password = null;
   for (; ; ) {
     const arg = args.shift();
@@ -990,27 +996,27 @@ Missing password`);
 Cannot specify password more than once`);
         return 1;
       }
-    } else if (source === null) {
-      source = arg;
     } else if (target === null) {
       target = arg;
+    } else if (source === null) {
+      source = arg;
     } else {
       printUsage("ingest");
       console.error(`
 Unknown argument: ${arg}`);
       return 1;
     }
   }
-  if (source === null) {
+  if (target === null) {
     printUsage("ingest");
     console.error(`
-Missing source directory`);
+Missing vault directory`);
     return 1;
   }
-  if (target === null) {
+  if (source === null) {
     printUsage("ingest");
     console.error(`
-Missing vault directory`);
+Missing source directory`);
     return 1;
   }
   if (password === null) {
@@ -1446,6 +1452,16 @@ Missing vault directory`);
   await walk(0);
   return 0;
 }
+async function cmdVersion(args) {
+  const data = await fs2.readFile(path.join(__dirname, "..", "package.json"), { encoding: "utf8" });
+  const pack = JSON.parse(data);
+  console.log(`StaticVault v${pack.version}
+Encrypt, host, and share files on a static website
+by Sean Connelly (@velipso), https://sean.fun
+Project Home: https://github.com/velipso/staticvault
+SPDX-License-Identifier: 0BSD`);
+  return 0;
+}
 async function main(args) {
   if (args.length <= 0) {
     printUsage();
@@ -1465,6 +1481,8 @@ async function main(args) {
       return cmdTest(args);
     case "tree":
       return cmdTree(args);
+    case "version":
+      return cmdVersion(args);
     default:
       printUsage();
       console.error(`

package.json

@@ -1,6 +1,6 @@
 {
   "name": "staticvault",
-  "version": "1.0.1",
+  "version": "1.0.2",
   "author": "velipso",
   "license": "0BSD",
   "type": "module",

src/cli.ts

@@ -37,12 +37,12 @@ function printUsage(filter?: string) {
   }
   if (!filter || filter === 'ingest') {
     console.log(`
-- ingest <source> <vault> [-p password]
+- ingest <vault> <source> [-p password]
 
   Encrypt and copy source folders/files into vault
 
-  <source>         Source directory
   <vault>          Vault directory
+  <source>         Source directory
   [-p password]    Encryption password`);
   }
   if (!filter || filter === 'init') {
@@ -80,6 +80,12 @@ function printUsage(filter?: string) {
   <vault>          Vault directory
   [-p password]    Encryption password`);
   }
+  if (!filter || filter === 'version') {
+    console.log(`
+- version
+
+  Output version of staticvault`);
+  }
 }
 
 function promptPassword(prompt: string): string {
@@ -173,8 +179,8 @@ async function cmdDump(args: string[]): Promise<number> {
 }
 
 async function cmdIngest(args: string[]): Promise<number> {
-  let source: string | null = null;
   let target: string | null = null;
+  let source: string | null = null;
   let password: string | null = null;
   for (;;) {
     const arg = args.shift();
@@ -193,24 +199,24 @@ async function cmdIngest(args: string[]): Promise<number> {
         console.error(`\nCannot specify password more than once`);
         return 1;
       }
-    } else if (source === null) {
-      source = arg;
     } else if (target === null) {
       target = arg;
+    } else if (source === null) {
+      source = arg;
     } else {
       printUsage('ingest');
       console.error(`\nUnknown argument: ${arg}`);
       return 1;
     }
   }
-  if (source === null) {
+  if (target === null) {
     printUsage('ingest');
-    console.error(`\nMissing source directory`);
+    console.error(`\nMissing vault directory`);
     return 1;
   }
-  if (target === null) {
+  if (source === null) {
     printUsage('ingest');
-    console.error(`\nMissing vault directory`);
+    console.error(`\nMissing source directory`);
     return 1;
   }
   if (password === null) {
@@ -656,6 +662,17 @@ async function cmdTree(args: string[]): Promise<number> {
   return 0;
 }
 
+async function cmdVersion(args: string[]): Promise<number> {
+  const data = await fs.readFile(path.join(__dirname, '..', 'package.json'), { encoding: 'utf8' });
+  const pack = JSON.parse(data);
+  console.log(`StaticVault v${pack.version}
+Encrypt, host, and share files on a static website
+by Sean Connelly (@velipso), https://sean.fun
+Project Home: https://github.com/velipso/staticvault
+SPDX-License-Identifier: 0BSD`);
+  return 0;
+}
+
 async function main(args: string[]): Promise<number> {
   if (args.length <= 0) {
     printUsage();
@@ -675,6 +692,8 @@ async function main(args: string[]): Promise<number> {
       return cmdTest(args);
     case 'tree':
       return cmdTree(args);
+    case 'version':
+      return cmdVersion(args);
     default:
       printUsage();
       console.error(`\nUnknown command: ${cmd}`);